com.ibm.etools.xsd
Interface XSDTypeDefinition

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, XSDComponent, XSDConcreteComponent, XSDNamedComponent, XSDRedefinableComponent, XSDRedefineContent, XSDSchemaContent
All Known Subinterfaces:
XSDComplexTypeDefinition, XSDSimpleTypeDefinition
All Known Implementing Classes:
XSDTypeDefinitionImpl, XSDComplexTypeDefinitionImpl, XSDSimpleTypeDefinitionImpl

public interface XSDTypeDefinition
extends XSDRedefinableComponent, XSDRedefineContent

A representation of the model object 'Type Definition'. It is used to represent aspects common to 'Simple Type Definitions' and 'Complex Type Definitions'.

The following features are supported:

See Also:
XSDPackage.getXSDTypeDefinition()

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 eClassXSDTypeDefinition()
          Returns the meta class of XSDTypeDefinition.
 XSDAnnotation getAnnotation()
          Returns the value of the 'Annotation' reference.
 com.ibm.etools.emf.ref.EList getAnnotations()
          Returns the value of the 'Annotations' reference list.
 XSDTypeDefinition getBaseType()
          Returns the value of the 'Base Type' reference.
 XSDParticle getComplexType()
          Returns the value of the 'Complex Type' reference.
 XSDAnnotation getDerivationAnnotation()
          Returns the value of the 'Derivation Annotation' reference.
 XSDTypeDefinition getRootType()
          Returns the value of the 'Root Type' reference.
 XSDSimpleTypeDefinition getSimpleType()
          Returns the value of the 'Simple Type' reference.
 boolean isSetAnnotation()
          Returns whether the value of the 'Annotation' reference is set.
 boolean isSetDerivationAnnotation()
          Returns whether the value of the 'Derivation Annotation' reference is set.
 void setAnnotation(XSDAnnotation value)
          Sets the value of the 'Annotation' reference.
 void setDerivationAnnotation(XSDAnnotation value)
          Sets the value of the 'Derivation Annotation' reference.
 void unsetAnnotation()
          Unsets the value of the 'Annotation' reference.
 void unsetDerivationAnnotation()
          Unsets the value of the 'Derivation Annotation' reference.
 
Methods inherited from interface com.ibm.etools.xsd.XSDRedefinableComponent
eClassXSDRedefinableComponent, getCircular, isCircular
 
Methods inherited from interface com.ibm.etools.xsd.XSDNamedComponent
eClassXSDNamedComponent, getAliasName, getAliasURI, getName, getQName, getQName, getTargetNamespace, getURI, hasNameAndTargetNamespace, hasSameNameAndTargetNamespace, isSetName, isSetTargetNamespace, setName, setTargetNamespace, unsetName, unsetTargetNamespace
 
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
 
Methods inherited from interface com.ibm.etools.xsd.XSDRedefineContent
eClassXSDRedefineContent
 
Methods inherited from interface com.ibm.etools.xsd.XSDSchemaContent
eClassXSDSchemaContent
 

Field Detail

copyright

public static final java.lang.String copyright
Method Detail

eClassXSDTypeDefinition

public com.ibm.etools.emf.ecore.EClass eClassXSDTypeDefinition()
Returns the meta class of XSDTypeDefinition.
Returns:
the meta class.
See Also:
XSDPackage.getXSDTypeDefinition(), XSDConcreteComponent.ePackageXSD()

getAnnotation

public XSDAnnotation getAnnotation()
Returns the value of the 'Annotation' reference.

This concrete reference represents the direct annotation content of a complexType element or a simpleType element.

Returns:
the value of the 'Annotation' reference.
See Also:
isSetAnnotation(), unsetAnnotation(), setAnnotation(XSDAnnotation), XSDPackage.getXSDTypeDefinition_Annotation()

setAnnotation

public void setAnnotation(XSDAnnotation value)
Sets the value of the 'Annotation' reference.
Parameters:
value - the new value of the 'Annotation' reference.
See Also:
isSetAnnotation(), unsetAnnotation(), getAnnotation()

unsetAnnotation

public void unsetAnnotation()
Unsets the value of the 'Annotation' reference.
See Also:
isSetAnnotation(), getAnnotation(), setAnnotation(XSDAnnotation)

isSetAnnotation

public boolean isSetAnnotation()
Returns whether the value of the 'Annotation' reference is set.
Returns:
whether the value of the 'Annotation' reference is set.
See Also:
unsetAnnotation(), getAnnotation(), setAnnotation(XSDAnnotation)

getDerivationAnnotation

public XSDAnnotation getDerivationAnnotation()
Returns the value of the 'Derivation Annotation' reference.

This concrete reference represents the direct annotation content of a complex content extension, complex content restriction, simple content extension, simple content restriction, simple type restriction, simple type list, or simple type union element.

Returns:
the value of the 'Derivation Annotation' reference.
See Also:
isSetDerivationAnnotation(), unsetDerivationAnnotation(), setDerivationAnnotation(XSDAnnotation), XSDPackage.getXSDTypeDefinition_DerivationAnnotation()

setDerivationAnnotation

public void setDerivationAnnotation(XSDAnnotation value)
Sets the value of the 'Derivation Annotation' reference.
Parameters:
value - the new value of the 'Derivation Annotation' reference.
See Also:
isSetDerivationAnnotation(), unsetDerivationAnnotation(), getDerivationAnnotation()

unsetDerivationAnnotation

public void unsetDerivationAnnotation()
Unsets the value of the 'Derivation Annotation' reference.
See Also:
isSetDerivationAnnotation(), getDerivationAnnotation(), setDerivationAnnotation(XSDAnnotation)

isSetDerivationAnnotation

public boolean isSetDerivationAnnotation()
Returns whether the value of the 'Derivation Annotation' reference is set.
Returns:
whether the value of the 'Derivation Annotation' reference is set.
See Also:
unsetDerivationAnnotation(), getDerivationAnnotation(), setDerivationAnnotation(XSDAnnotation)

getAnnotations

public com.ibm.etools.emf.ref.EList getAnnotations()
Returns the value of the 'Annotations' reference list. The list contents are of type XSDAnnotation.

This represents the complex type definition annotation or simple type definition annotation infoset property. It is computed from the annotation, content annotation, derivationAnnotation and should typically not be modified directly.

Returns:
the value of the 'Annotations' reference list.
See Also:
XSDPackage.getXSDTypeDefinition_Annotations()

getRootType

public XSDTypeDefinition getRootType()
Returns the value of the 'Root Type' reference.

This walks the base types until it hits that one that has the ur-type definition as it's base type.

Returns:
the value of the 'Root Type' reference.
See Also:
XSDPackage.getXSDTypeDefinition_RootType()

getBaseType

public XSDTypeDefinition getBaseType()
Returns the value of the 'Base Type' reference.

This represents the same result as either the simple 'Base Type Definition' reference or the complex 'Base Type Definition' reference.

Returns:
the value of the 'Base Type' reference.
See Also:
XSDPackage.getXSDTypeDefinition_BaseType()

getSimpleType

public XSDSimpleTypeDefinition getSimpleType()
Returns the value of the 'Simple Type' reference.

This represents either the 'Simple Type Definition' itself or the complex 'Content Type' reference, if it is simple.

Returns:
the value of the 'Simple Type' reference.
See Also:
XSDPackage.getXSDTypeDefinition_SimpleType()

getComplexType

public XSDParticle getComplexType()
Returns the value of the 'Complex Type' reference.

This represents the complex 'Content Type' reference, if it is complex, i.e., if it is a 'Particle'.

Returns:
the value of the 'Complex Type' reference.
See Also:
XSDPackage.getXSDTypeDefinition_ComplexType()