com.ibm.etools.xsd
Interface XSDParticle

All Superinterfaces:
com.ibm.etools.emf.notify.Notifier, com.ibm.etools.emf.ref.RefBaseObject, com.ibm.etools.emf.ref.RefObject, com.ibm.etools.emf.resource.ResourceSetReference, XSDComplexTypeContent, XSDComponent, XSDConcreteComponent
All Known Implementing Classes:
XSDParticleImpl

public interface XSDParticle
extends XSDComplexTypeContent

A representation of the model object 'Particle'.

The following features are supported:

See Also:
XSDPackage.getXSDParticle()

Inner Class Summary
static interface XSDParticle.DFA
          A deterministic finite state automaton as described for 'Unique Particle Attribution'.
 
Field Summary
static java.lang.String copyright
           
 
Fields inherited from interface com.ibm.etools.emf.notify.Notifier
ADD, ADD_MANY, CREATE, MOVE, NO_INDEX, REMOVE, REMOVE_MANY, REMOVING_ADAPTER, SET, TOUCH, UNSET
 
Method Summary
 com.ibm.etools.emf.ecore.EClass eClassXSDParticle()
          Returns the meta class of XSDParticle.
 XSDParticleContent getContent()
          Returns the value of the 'Content' reference.
 XSDParticle.DFA getDFA()
          Returns the deterministic finite state automaton that implements this particle's content model.
 java.lang.Integer getMaxOccurs()
          Returns the value of the 'Max Occurs' attribute.
 java.lang.Integer getMinOccurs()
          Returns the value of the 'Min Occurs' attribute.
 XSDTerm getTerm()
          Returns the value of the 'Term' reference.
 int getValueMaxOccurs()
          Returns the primitive value of the 'Max Occurs' attribute.
 int getValueMinOccurs()
          Returns the primitive value of the 'Min Occurs' attribute.
 boolean isSetContent()
          Returns whether the value of the 'Content' reference is set.
 boolean isSetMaxOccurs()
          Returns whether the value of the 'Max Occurs' attribute is set.
 boolean isSetMinOccurs()
          Returns whether the value of the 'Min Occurs' attribute is set.
 boolean isSetTerm()
          Returns whether the value of the 'Term' reference is set.
 void setContent(XSDParticleContent value)
          Sets the value of the 'Content' reference.
 void setMaxOccurs(int value)
          Sets the value of the 'Max Occurs' attribute.
 void setMaxOccurs(java.lang.Integer value)
          Sets the value of the 'Max Occurs' attribute.
 void setMinOccurs(int value)
          Sets the value of the 'Min Occurs' attribute.
 void setMinOccurs(java.lang.Integer value)
          Sets the value of the 'Min Occurs' attribute.
 void setTerm(XSDTerm value)
          Sets the value of the 'Term' reference.
 void unsetContent()
          Unsets the value of the 'Content' reference.
 void unsetMaxOccurs()
          Unsets the value of the 'Max Occurs' attribute.
 void unsetMinOccurs()
          Unsets the value of the 'Min Occurs' attribute.
 void unsetTerm()
          Unsets the value of the 'Term' reference.
 
Methods inherited from interface com.ibm.etools.xsd.XSDComplexTypeContent
eClassXSDComplexTypeContent
 
Methods inherited from interface com.ibm.etools.xsd.XSDComponent
eClassXSDComponent
 
Methods inherited from interface com.ibm.etools.xsd.XSDConcreteComponent
clearDiagnostics, cloneConcreteComponent, contains, eClassXSDConcreteComponent, elementAttributesChanged, elementChanged, elementContentsChanged, ePackageXSD, getComponentsWithApplicationInformation, getComponentsWithUserInformation, getContainer, getDiagnostics, getElement, getOwner, getRootContainer, getRootOwner, getSchema, getURIReferencePath, isSetElement, isSetOwner, isSetRootOwner, isSetSchema, resolveAttributeDeclaration, resolveAttributeDeclaration, resolveAttributeDeclarationURI, resolveAttributeGroupDefinition, resolveAttributeGroupDefinition, resolveAttributeGroupDefinitionURI, resolveComplexTypeDefinition, resolveComplexTypeDefinition, resolveComplexTypeDefinitionURI, resolveElementDeclaration, resolveElementDeclaration, resolveElementDeclarationURI, resolveIdentityConstraintDefinition, resolveIdentityConstraintDefinition, resolveIdentityConstraintDefinitionURI, resolveModelGroupDefinition, resolveModelGroupDefinition, resolveModelGroupDefinitionURI, resolveNotationDeclaration, resolveNotationDeclaration, resolveNotationDeclarationURI, resolveSimpleTypeDefinition, resolveSimpleTypeDefinition, resolveSimpleTypeDefinitionURI, resolveTypeDefinition, resolveTypeDefinition, resolveTypeDefinitionURI, setElement, setOwner, setRootOwner, setSchema, unsetElement, unsetOwner, unsetRootOwner, unsetSchema, updateElement, updateElement, validate
 
Methods inherited from interface com.ibm.etools.emf.ref.RefObject
initInstance, refAddValue, refAddValueAt, refAddValueBefore, refCurrentValues, refDelegateOwner, refGetDefaultValues, refIsSet, refModifyValue, refModifyValueAt, refRemoveValue, refRemoveValueAt, refSetDelegateOwner, refSetValue, refUnsetValue, refValue
 
Methods inherited from interface com.ibm.etools.emf.ref.RefBaseObject
metaObject, refAttributes, refContainer, refContainerExtent, refContainerSF, refContainments, refContainments, refContains, refContains, refContainsExtent, refContainsNested, refDelete, refExtent, refID, refImmediatePackage, refIsContainer, refItself, refMetaObject, refMofId, refName, refOutermostPackage, refPackage, refReferences, refRemoveContent, refResource, refSetExtent, refSetID, refSetID, refSetIDContains, refSetMetaObject, refSetUUID, refSetUUID, refSetUUID
 
Methods inherited from interface com.ibm.etools.emf.notify.Notifier
addAdapter, getAdapter, getAdapters, getExistingAdapter, isDelivery, isDeliveryAll, notify, notify, removeAdapter, removeAllAdapters, setDelivery, setDeliveryAll
 
Methods inherited from interface com.ibm.etools.emf.resource.ResourceSetReference
getResourceSet
 

Field Detail

copyright

public static final java.lang.String copyright
Method Detail

eClassXSDParticle

public com.ibm.etools.emf.ecore.EClass eClassXSDParticle()
Returns the meta class of XSDParticle.
Returns:
the meta class.
See Also:
XSDPackage.getXSDParticle(), XSDConcreteComponent.ePackageXSD()

getMinOccurs

public java.lang.Integer getMinOccurs()
Returns the value of the 'Min Occurs' attribute.

This represents the min occurs infoset property.

Returns:
the value of the 'Min Occurs' attribute.
See Also:
getValueMinOccurs(), isSetMinOccurs(), unsetMinOccurs(), setMinOccurs(Integer), XSDPackage.getXSDParticle_MinOccurs()

getValueMinOccurs

public int getValueMinOccurs()
Returns the primitive value of the 'Min Occurs' attribute.
Returns:
the primitive value of the 'Min Occurs' attribute.
See Also:
getMinOccurs(), isSetMinOccurs(), unsetMinOccurs(), setMinOccurs(int)

setMinOccurs

public void setMinOccurs(java.lang.Integer value)
Sets the value of the 'Min Occurs' attribute.
Parameters:
value - the new value of the 'Min Occurs' attribute.
See Also:
setMinOccurs(int), isSetMinOccurs(), unsetMinOccurs(), getMinOccurs()

setMinOccurs

public void setMinOccurs(int value)
Sets the value of the 'Min Occurs' attribute.
Parameters:
value - the new value of the 'Min Occurs' attribute.
See Also:
setMinOccurs(Integer), isSetMinOccurs(), unsetMinOccurs(), getValueMinOccurs()

unsetMinOccurs

public void unsetMinOccurs()
Unsets the value of the 'Min Occurs' attribute.
See Also:
isSetMinOccurs(), getMinOccurs(), setMinOccurs(Integer)

isSetMinOccurs

public boolean isSetMinOccurs()
Returns whether the value of the 'Min Occurs' attribute is set.
Returns:
whether the value of the 'Min Occurs' attribute is set.
See Also:
unsetMinOccurs(), getMinOccurs(), setMinOccurs(Integer)

getMaxOccurs

public java.lang.Integer getMaxOccurs()
Returns the value of the 'Max Occurs' attribute.

This represents the max occurs infoset property.

Returns:
the value of the 'Max Occurs' attribute.
See Also:
getValueMaxOccurs(), isSetMaxOccurs(), unsetMaxOccurs(), setMaxOccurs(Integer), XSDPackage.getXSDParticle_MaxOccurs()

getValueMaxOccurs

public int getValueMaxOccurs()
Returns the primitive value of the 'Max Occurs' attribute.
Returns:
the primitive value of the 'Max Occurs' attribute.
See Also:
getMaxOccurs(), isSetMaxOccurs(), unsetMaxOccurs(), setMaxOccurs(int)

setMaxOccurs

public void setMaxOccurs(java.lang.Integer value)
Sets the value of the 'Max Occurs' attribute.
Parameters:
value - the new value of the 'Max Occurs' attribute.
See Also:
setMaxOccurs(int), isSetMaxOccurs(), unsetMaxOccurs(), getMaxOccurs()

setMaxOccurs

public void setMaxOccurs(int value)
Sets the value of the 'Max Occurs' attribute.
Parameters:
value - the new value of the 'Max Occurs' attribute.
See Also:
setMaxOccurs(Integer), isSetMaxOccurs(), unsetMaxOccurs(), getValueMaxOccurs()

unsetMaxOccurs

public void unsetMaxOccurs()
Unsets the value of the 'Max Occurs' attribute.
See Also:
isSetMaxOccurs(), getMaxOccurs(), setMaxOccurs(Integer)

isSetMaxOccurs

public boolean isSetMaxOccurs()
Returns whether the value of the 'Max Occurs' attribute is set.
Returns:
whether the value of the 'Max Occurs' attribute is set.
See Also:
unsetMaxOccurs(), getMaxOccurs(), setMaxOccurs(Integer)

getContent

public XSDParticleContent getContent()
Returns the value of the 'Content' reference.

This concrete reference represents the particle content of the particle. It is used to compute the term.

Returns:
the value of the 'Content' reference.
See Also:
getTerm(), isSetContent(), unsetContent(), setContent(XSDParticleContent), XSDPackage.getXSDParticle_Content()

setContent

public void setContent(XSDParticleContent value)
Sets the value of the 'Content' reference.
Parameters:
value - the new value of the 'Content' reference.
See Also:
isSetContent(), unsetContent(), getContent()

unsetContent

public void unsetContent()
Unsets the value of the 'Content' reference.
See Also:
isSetContent(), getContent(), setContent(XSDParticleContent)

isSetContent

public boolean isSetContent()
Returns whether the value of the 'Content' reference is set.
Returns:
whether the value of the 'Content' reference is set.
See Also:
unsetContent(), getContent(), setContent(XSDParticleContent)

getTerm

public XSDTerm getTerm()
Returns the value of the 'Term' reference.

This represents the term infoset property. It is computed from the content and should typically not be modified directly.

Returns:
the value of the 'Term' reference.
See Also:
getContent(), isSetTerm(), unsetTerm(), setTerm(XSDTerm), XSDPackage.getXSDParticle_Term()

setTerm

public void setTerm(XSDTerm value)
Sets the value of the 'Term' reference. Since the term is computed from the content, this reference should typically not be modified directly.
Parameters:
value - the new value of the 'Term' reference.
See Also:
isSetTerm(), unsetTerm(), getTerm()

unsetTerm

public void unsetTerm()
Unsets the value of the 'Term' reference.
See Also:
isSetTerm(), getTerm(), setTerm(XSDTerm)

isSetTerm

public boolean isSetTerm()
Returns whether the value of the 'Term' reference is set.
Returns:
whether the value of the 'Term' reference is set.
See Also:
unsetTerm(), getTerm(), setTerm(XSDTerm)

getDFA

public XSDParticle.DFA getDFA()
Returns the deterministic finite state automaton that implements this particle's content model.
Returns:
the deterministic finite state automaton that implements this particle's content model.