com.ibm.etools.xsd
Interface XSDAnnotation

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, XSDRedefineContent, XSDSchemaContent
All Known Implementing Classes:
XSDAnnotationImpl

public interface XSDAnnotation
extends XSDRedefineContent, XSDComponent

A representation of the model object 'Annotation'. Access to the contents of an annotation is provided via their DOM representation.

The following features are supported:

See Also:
XSDPackage.getXSDAnnotation()

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
 Element createApplicationInformation(java.lang.String sourceURI)
          Creates a new appinfo element using the containing schema's document as the factory.
 Element createUserInformation(java.lang.String sourceURI)
          This creates a new documentation element using the containing schema's document as the factory.
 com.ibm.etools.emf.ecore.EClass eClassXSDAnnotation()
          Returns the meta class of XSDAnnotation.
 com.ibm.etools.emf.ref.EList getApplicationInformation()
          Returns the value of the 'Application Information' attribute list.
 com.ibm.etools.emf.ref.EList getApplicationInformation(java.lang.String sourceURI)
          Returns only those elements returned by getApplicationInformation() with the given sourceURI; a null sourceURI matches elements without a source attribute.
 java.util.Set getApplicationInformationSources()
          Returns the set of source attribute values of all the appinfo elements.
 com.ibm.etools.emf.ref.EList getAttributes()
          Returns the value of the 'Attributes' attribute list.
 com.ibm.etools.emf.ref.EList getUserInformation()
          Returns the value of the 'User Information' attribute list.
 com.ibm.etools.emf.ref.EList getUserInformation(java.lang.String sourceURI)
          Returns only those elements returned by getUserInformation() with the given sourceURI; a null sourceURI matches elements without a source attribute.
 java.util.Set getUserInformationSources()
          Returns the set of source attribute values of all the documentation elements.
 
Methods inherited from interface com.ibm.etools.xsd.XSDRedefineContent
eClassXSDRedefineContent
 
Methods inherited from interface com.ibm.etools.xsd.XSDSchemaContent
eClassXSDSchemaContent
 
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.XSDComponent
eClassXSDComponent
 

Field Detail

copyright

public static final java.lang.String copyright
Method Detail

eClassXSDAnnotation

public com.ibm.etools.emf.ecore.EClass eClassXSDAnnotation()
Returns the meta class of XSDAnnotation.
Returns:
the meta class.
See Also:
XSDPackage.getXSDAnnotation(), XSDConcreteComponent.ePackageXSD()

getApplicationInformation

public com.ibm.etools.emf.ref.EList getApplicationInformation()
Returns the value of the 'Application Information' attribute list. The list contents are of type Element.

This represents the application information infoset property, i.e., a list of appinfo elements.

Returns:
the value of the 'Application Information' attribute list.
See Also:
XSDPackage.getXSDAnnotation_ApplicationInformation()

getUserInformation

public com.ibm.etools.emf.ref.EList getUserInformation()
Returns the value of the 'User Information' attribute list. The list contents are of type Element.

This represents the user information infoset property, i.e., a list of documentation elements.

Returns:
the value of the 'User Information' attribute list.
See Also:
XSDPackage.getXSDAnnotation_UserInformation()

getAttributes

public com.ibm.etools.emf.ref.EList getAttributes()
Returns the value of the 'Attributes' attribute list. The list contents are of type Attr.

This represents the attributes infoset property.

Returns:
the value of the 'Attributes' attribute list.
See Also:
XSDPackage.getXSDAnnotation_Attributes()

createApplicationInformation

public Element createApplicationInformation(java.lang.String sourceURI)
Creates a new appinfo element using the containing schema's document as the factory. The caller is responsible for adding the appinfo element to annotation element.
Parameters:
sourceURI - the initial value of the source attribute.
Returns:
a new appinfo element.

createUserInformation

public Element createUserInformation(java.lang.String sourceURI)
This creates a new documentation element using the containing schema's document as the factory. The caller is responsible for adding the documentation element to annotation element.
Parameters:
sourceURI - the initial value of the source attribute.
Returns:
a new documentation element.

getApplicationInformation

public com.ibm.etools.emf.ref.EList getApplicationInformation(java.lang.String sourceURI)
Returns only those elements returned by getApplicationInformation() with the given sourceURI; a null sourceURI matches elements without a source attribute.
Parameters:
sourceURI - the source URI to match.
Returns:
the elements with the given sourceURI.

getUserInformation

public com.ibm.etools.emf.ref.EList getUserInformation(java.lang.String sourceURI)
Returns only those elements returned by getUserInformation() with the given sourceURI; a null sourceURI matches elements without a source attribute.
Parameters:
sourceURI - the source URI to match.
Returns:
the elements with the given sourceURI.

getApplicationInformationSources

public java.util.Set getApplicationInformationSources()
Returns the set of source attribute values of all the appinfo elements.
Returns:
the set of source attribute values of all the appinfo elements.

getUserInformationSources

public java.util.Set getUserInformationSources()
Returns the set of source attribute values of all the documentation elements.
Returns:
the set of source attribute values of all the documentation elements.