com.ibm.etools.xsd
Interface XSDXPathDefinition

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
All Known Implementing Classes:
XSDXPathDefinitionImpl

public interface XSDXPathDefinition
extends XSDComponent

A representation of the model object 'XPath Definition'. It represents a field or selector of an Identity-constraint Definition. It defines a restricted XPath. It is used to represent the types of object returned by the 'Fields' reference list and the 'Selector' reference.

The following features are supported:

See Also:
XSDPackage.getXSDXPathDefinition()

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 eClassXSDXPathDefinition()
          Returns the meta class of XSDXPathDefinition.
 XSDAnnotation getAnnotation()
          Returns the value of the 'Annotation' reference.
 com.ibm.etools.emf.ecore.EEnumLiteral getLiteralVariety()
          Returns the value of the 'Variety' attribute.
 java.lang.String getStringVariety()
          Returns the String value of the 'Variety' attribute.
 java.lang.String getValue()
          Returns the value of the 'Value' attribute.
 int getValueVariety()
          Returns the primitive value of the 'Variety' attribute.
 java.lang.Integer getVariety()
          Returns the Integer value of the 'Variety' attribute.
 boolean isSetAnnotation()
          Returns whether the value of the 'Annotation' reference is set.
 boolean isSetValue()
          Returns whether the value of the 'Value' attribute is set.
 boolean isSetVariety()
          Returns whether the value of the 'Variety' attribute is set.
 void setAnnotation(XSDAnnotation value)
          Sets the value of the 'Annotation' reference.
 void setValue(java.lang.String value)
          Sets the value of the 'Value' attribute.
 void setVariety(com.ibm.etools.emf.ecore.EEnumLiteral value)
          Sets the value of the 'Variety' attribute.
 void setVariety(int value)
          Sets the value of the 'Variety' attribute.
 void setVariety(java.lang.Integer value)
          Sets the value of the 'Variety' attribute.
 void setVariety(java.lang.String value)
          Sets the value of the 'Variety' attribute.
 void unsetAnnotation()
          Unsets the value of the 'Annotation' reference.
 void unsetValue()
          Unsets the value of the 'Value' attribute.
 void unsetVariety()
          Unsets the value of the 'Variety' attribute.
 
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

eClassXSDXPathDefinition

public com.ibm.etools.emf.ecore.EClass eClassXSDXPathDefinition()
Returns the meta class of XSDXPathDefinition.
Returns:
the meta class.
See Also:
XSDPackage.getXSDXPathDefinition(), XSDConcreteComponent.ePackageXSD()

getLiteralVariety

public com.ibm.etools.emf.ecore.EEnumLiteral getLiteralVariety()
Returns the value of the 'Variety' attribute. The literals are from the enumeration XSDXPathVariety.

This attribute represents whether this is a field or a selector.

Returns:
the value of the 'Variety' attribute.
See Also:
getValueVariety(), getVariety(), getStringVariety(), XSDXPathVariety, isSetVariety(), unsetVariety(), setVariety(EEnumLiteral), XSDPackage.getXSDXPathDefinition_Variety()

getValueVariety

public int getValueVariety()
Returns the primitive value of the 'Variety' attribute.
Returns:
the primitive value of the 'Variety' attribute.
See Also:
getLiteralVariety(), getValueVariety(), getStringVariety(), XSDXPathVariety, isSetVariety(), unsetVariety(), setVariety(int)

getStringVariety

public java.lang.String getStringVariety()
Returns the String value of the 'Variety' attribute.
Returns:
the String value of the 'Variety' attribute.
See Also:
getLiteralVariety(), getVariety(), getValueVariety(), XSDXPathVariety, isSetVariety(), unsetVariety(), setVariety(String)

getVariety

public java.lang.Integer getVariety()
Returns the Integer value of the 'Variety' attribute.
Returns:
the Integer value of the 'Variety' attribute.
See Also:
getLiteralVariety(), getValueVariety(), getStringVariety(), XSDXPathVariety, isSetVariety(), unsetVariety(), setVariety(Integer)

setVariety

public void setVariety(com.ibm.etools.emf.ecore.EEnumLiteral value)
                throws com.ibm.etools.emf.ref.EnumerationException
Sets the value of the 'Variety' attribute.
Parameters:
value - the new value of the 'Variety' attribute.
See Also:
setVariety(int), setVariety(Integer), setVariety(String), XSDXPathVariety, isSetVariety(), unsetVariety(), getLiteralVariety()

setVariety

public void setVariety(int value)
                throws com.ibm.etools.emf.ref.EnumerationException
Sets the value of the 'Variety' attribute.
Parameters:
value - the int value of the new enumeration literal value of the 'Variety' attribute.
See Also:
setVariety(EEnumLiteral), setVariety(Integer), setVariety(String), XSDXPathVariety, isSetVariety(), unsetVariety(), getValueVariety()

setVariety

public void setVariety(java.lang.String value)
                throws com.ibm.etools.emf.ref.EnumerationException
Sets the value of the 'Variety' attribute.
Parameters:
value - the String value of the new enumeration literal value of the 'Variety' attribute.
See Also:
setVariety(EEnumLiteral), setVariety(int), setVariety(Integer), XSDXPathVariety, isSetVariety(), unsetVariety(), getStringVariety()

setVariety

public void setVariety(java.lang.Integer value)
                throws com.ibm.etools.emf.ref.EnumerationException
Sets the value of the 'Variety' attribute.
Parameters:
value - the Integer value of the new enumeration literal value of the 'Variety' attribute.
See Also:
setVariety(EEnumLiteral), setVariety(int), setVariety(String), XSDXPathVariety, isSetVariety(), unsetVariety(), getValueVariety()

unsetVariety

public void unsetVariety()
Unsets the value of the 'Variety' attribute.
See Also:
isSetVariety(), getLiteralVariety(), setVariety(EEnumLiteral)

isSetVariety

public boolean isSetVariety()
Returns whether the value of the 'Variety' attribute is set.
Returns:
whether the value of the 'Variety' attribute is set.
See Also:
unsetVariety(), getLiteralVariety(), setVariety(EEnumLiteral)

getValue

public java.lang.String getValue()
Returns the value of the 'Value' attribute.

This concrete attribute represents the value of the selector xpath or field xpath attribute.

Returns:
the value of the 'Value' attribute.
See Also:
isSetValue(), unsetValue(), setValue(String), XSDPackage.getXSDXPathDefinition_Value()

setValue

public void setValue(java.lang.String value)
Sets the value of the 'Value' attribute.
Parameters:
value - the new value of the 'Value' attribute.
See Also:
isSetValue(), unsetValue(), getValue()

unsetValue

public void unsetValue()
Unsets the value of the 'Value' attribute.
See Also:
isSetValue(), getValue(), setValue(String)

isSetValue

public boolean isSetValue()
Returns whether the value of the 'Value' attribute is set.
Returns:
whether the value of the 'Value' attribute is set.
See Also:
unsetValue(), getValue(), setValue(String)

getAnnotation

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

This concrete reference represents the annotation contents defined within the body of a field or selector element.

Returns:
the value of the 'Annotation' reference.
See Also:
isSetAnnotation(), unsetAnnotation(), setAnnotation(XSDAnnotation), XSDPackage.getXSDXPathDefinition_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)