com.ibm.etools.xsd
Interface XSDFeature

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
All Known Subinterfaces:
XSDAttributeDeclaration, XSDElementDeclaration
All Known Implementing Classes:
XSDFeatureImpl, XSDAttributeDeclarationImpl, XSDElementDeclarationImpl

public interface XSDFeature
extends XSDNamedComponent

A representation of the model object 'Feature'. It is used to represent aspects common to 'Element Declarations' and 'Attribute Declaration'.

The following features are supported:

See Also:
XSDPackage.getXSDFeature()

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 eClassXSDFeature()
          Returns the meta class of XSDFeature.
 java.lang.Integer getConstraint()
          Returns the Integer value of the 'Constraint' attribute.
 java.lang.Boolean getFeatureReference()
          Returns the value of the 'Feature Reference' attribute.
 java.lang.Integer getForm()
          Returns the Integer value of the 'Form' attribute.
 java.lang.Boolean getGlobal()
          Returns the value of the 'Global' attribute.
 java.lang.String getLexicalValue()
          Returns the value of the 'Lexical Value' attribute.
 com.ibm.etools.emf.ecore.EEnumLiteral getLiteralConstraint()
          Returns the value of the 'Constraint' attribute.
 com.ibm.etools.emf.ecore.EEnumLiteral getLiteralForm()
          Returns the value of the 'Form' attribute.
 XSDFeature getResolvedFeature()
          Returns the value of the 'Resolved Feature' reference.
 XSDScope getScope()
          Returns the value of the 'Scope' reference.
 java.lang.String getStringConstraint()
          Returns the String value of the 'Constraint' attribute.
 java.lang.String getStringForm()
          Returns the String value of the 'Form' attribute.
 XSDTypeDefinition getType()
          Returns the value of the 'Type' reference.
 java.lang.Object getValue()
          Returns the value of the 'Value' attribute.
 int getValueConstraint()
          Returns the primitive value of the 'Constraint' attribute.
 int getValueForm()
          Returns the primitive value of the 'Form' attribute.
 boolean isFeatureReference()
          Returns whether the object is 'Feature Reference'.
 boolean isGlobal()
          Returns whether the object is 'Global'.
 boolean isSetConstraint()
          Returns whether the value of the 'Constraint' attribute is set.
 boolean isSetForm()
          Returns whether the value of the 'Form' attribute is set.
 boolean isSetLexicalValue()
          Returns whether the value of the 'Lexical Value' attribute is set.
 boolean isSetValue()
          Returns whether the value of the 'Value' attribute is set.
 void setConstraint(com.ibm.etools.emf.ecore.EEnumLiteral value)
          Sets the value of the 'Constraint' attribute.
 void setConstraint(int value)
          Sets the value of the 'Constraint' attribute.
 void setConstraint(java.lang.Integer value)
          Sets the value of the 'Constraint' attribute.
 void setConstraint(java.lang.String value)
          Sets the value of the 'Constraint' attribute.
 void setForm(com.ibm.etools.emf.ecore.EEnumLiteral value)
          Sets the value of the 'Form' attribute.
 void setForm(int value)
          Sets the value of the 'Form' attribute.
 void setForm(java.lang.Integer value)
          Sets the value of the 'Form' attribute.
 void setForm(java.lang.String value)
          Sets the value of the 'Form' attribute.
 void setLexicalValue(java.lang.String value)
          Sets the value of the 'Lexical Value' attribute.
 void setValue(java.lang.Object value)
          Sets the value of the 'Value' attribute.
 void unsetConstraint()
          Unsets the value of the 'Constraint' attribute.
 void unsetForm()
          Unsets the value of the 'Form' attribute.
 void unsetLexicalValue()
          Unsets the value of the 'Lexical Value' attribute.
 void unsetValue()
          Unsets the value of the 'Value' attribute.
 
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
 

Field Detail

copyright

public static final java.lang.String copyright
Method Detail

eClassXSDFeature

public com.ibm.etools.emf.ecore.EClass eClassXSDFeature()
Returns the meta class of XSDFeature.
Returns:
the meta class.
See Also:
XSDPackage.getXSDFeature(), XSDConcreteComponent.ePackageXSD()

getValue

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

This represents the value of the attribute value constraint or element value constraint infoset property. It is computed from the lexical value and should typically not be set directly.

Returns:
the value of the 'Value' attribute.
See Also:
isSetValue(), unsetValue(), setValue(java.lang.Object), XSDPackage.getXSDFeature_Value()

setValue

public void setValue(java.lang.Object 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(java.lang.Object)

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(java.lang.Object)

getLiteralConstraint

public com.ibm.etools.emf.ecore.EEnumLiteral getLiteralConstraint()
Returns the value of the 'Constraint' attribute. The literals are from the enumeration XSDConstraint.

This represents the constraint of the attribute value constraint or element value constraint infoset property.

Returns:
the value of the 'Constraint' attribute.
See Also:
getValueConstraint(), getConstraint(), getStringConstraint(), XSDConstraint, isSetConstraint(), unsetConstraint(), setConstraint(EEnumLiteral), XSDPackage.getXSDFeature_Constraint()

getValueConstraint

public int getValueConstraint()
Returns the primitive value of the 'Constraint' attribute.
Returns:
the primitive value of the 'Constraint' attribute.
See Also:
getLiteralConstraint(), getValueConstraint(), getStringConstraint(), XSDConstraint, isSetConstraint(), unsetConstraint(), setConstraint(int)

getStringConstraint

public java.lang.String getStringConstraint()
Returns the String value of the 'Constraint' attribute.
Returns:
the String value of the 'Constraint' attribute.
See Also:
getLiteralConstraint(), getConstraint(), getValueConstraint(), XSDConstraint, isSetConstraint(), unsetConstraint(), setConstraint(String)

getConstraint

public java.lang.Integer getConstraint()
Returns the Integer value of the 'Constraint' attribute.
Returns:
the Integer value of the 'Constraint' attribute.
See Also:
getLiteralConstraint(), getValueConstraint(), getStringConstraint(), XSDConstraint, isSetConstraint(), unsetConstraint(), setConstraint(Integer)

setConstraint

public void setConstraint(com.ibm.etools.emf.ecore.EEnumLiteral value)
                   throws com.ibm.etools.emf.ref.EnumerationException
Sets the value of the 'Constraint' attribute.
Parameters:
value - the new value of the 'Constraint' attribute.
See Also:
setConstraint(int), setConstraint(Integer), setConstraint(String), XSDConstraint, isSetConstraint(), unsetConstraint(), getLiteralConstraint()

setConstraint

public void setConstraint(int value)
                   throws com.ibm.etools.emf.ref.EnumerationException
Sets the value of the 'Constraint' attribute.
Parameters:
value - the int value of the new enumeration literal value of the 'Constraint' attribute.
See Also:
setConstraint(EEnumLiteral), setConstraint(Integer), setConstraint(String), XSDConstraint, isSetConstraint(), unsetConstraint(), getValueConstraint()

setConstraint

public void setConstraint(java.lang.String value)
                   throws com.ibm.etools.emf.ref.EnumerationException
Sets the value of the 'Constraint' attribute.
Parameters:
value - the String value of the new enumeration literal value of the 'Constraint' attribute.
See Also:
setConstraint(EEnumLiteral), setConstraint(int), setConstraint(Integer), XSDConstraint, isSetConstraint(), unsetConstraint(), getStringConstraint()

setConstraint

public void setConstraint(java.lang.Integer value)
                   throws com.ibm.etools.emf.ref.EnumerationException
Sets the value of the 'Constraint' attribute.
Parameters:
value - the Integer value of the new enumeration literal value of the 'Constraint' attribute.
See Also:
setConstraint(EEnumLiteral), setConstraint(int), setConstraint(String), XSDConstraint, isSetConstraint(), unsetConstraint(), getValueConstraint()

unsetConstraint

public void unsetConstraint()
Unsets the value of the 'Constraint' attribute.
See Also:
isSetConstraint(), getLiteralConstraint(), setConstraint(EEnumLiteral)

isSetConstraint

public boolean isSetConstraint()
Returns whether the value of the 'Constraint' attribute is set.
Returns:
whether the value of the 'Constraint' attribute is set.
See Also:
unsetConstraint(), getLiteralConstraint(), setConstraint(EEnumLiteral)

getLiteralForm

public com.ibm.etools.emf.ecore.EEnumLiteral getLiteralForm()
Returns the value of the 'Form' attribute. The literals are from the enumeration XSDForm.

This concrete attribute represents the value of the attribute form attribute or the element form attribute. It, along with the attribute form default and element form default of the schema, affects the target namespace of locally scoped features.

Returns:
the value of the 'Form' attribute.
See Also:
XSDSchema.getAttributeFormDefault(), XSDSchema.getElementFormDefault(), getValueForm(), getForm(), getStringForm(), XSDForm, isSetForm(), unsetForm(), setForm(EEnumLiteral), XSDPackage.getXSDFeature_Form()

getValueForm

public int getValueForm()
Returns the primitive value of the 'Form' attribute.
Returns:
the primitive value of the 'Form' attribute.
See Also:
getLiteralForm(), getValueForm(), getStringForm(), XSDForm, isSetForm(), unsetForm(), setForm(int)

getStringForm

public java.lang.String getStringForm()
Returns the String value of the 'Form' attribute.
Returns:
the String value of the 'Form' attribute.
See Also:
getLiteralForm(), getForm(), getValueForm(), XSDForm, isSetForm(), unsetForm(), setForm(String)

getForm

public java.lang.Integer getForm()
Returns the Integer value of the 'Form' attribute.
Returns:
the Integer value of the 'Form' attribute.
See Also:
getLiteralForm(), getValueForm(), getStringForm(), XSDForm, isSetForm(), unsetForm(), setForm(Integer)

setForm

public void setForm(com.ibm.etools.emf.ecore.EEnumLiteral value)
             throws com.ibm.etools.emf.ref.EnumerationException
Sets the value of the 'Form' attribute.
Parameters:
value - the new value of the 'Form' attribute.
See Also:
setForm(int), setForm(Integer), setForm(String), XSDForm, isSetForm(), unsetForm(), getLiteralForm()

setForm

public void setForm(int value)
             throws com.ibm.etools.emf.ref.EnumerationException
Sets the value of the 'Form' attribute.
Parameters:
value - the int value of the new enumeration literal value of the 'Form' attribute.
See Also:
setForm(EEnumLiteral), setForm(Integer), setForm(String), XSDForm, isSetForm(), unsetForm(), getValueForm()

setForm

public void setForm(java.lang.String value)
             throws com.ibm.etools.emf.ref.EnumerationException
Sets the value of the 'Form' attribute.
Parameters:
value - the String value of the new enumeration literal value of the 'Form' attribute.
See Also:
setForm(EEnumLiteral), setForm(int), setForm(Integer), XSDForm, isSetForm(), unsetForm(), getStringForm()

setForm

public void setForm(java.lang.Integer value)
             throws com.ibm.etools.emf.ref.EnumerationException
Sets the value of the 'Form' attribute.
Parameters:
value - the Integer value of the new enumeration literal value of the 'Form' attribute.
See Also:
setForm(EEnumLiteral), setForm(int), setForm(String), XSDForm, isSetForm(), unsetForm(), getValueForm()

unsetForm

public void unsetForm()
Unsets the value of the 'Form' attribute.
See Also:
isSetForm(), getLiteralForm(), setForm(EEnumLiteral)

isSetForm

public boolean isSetForm()
Returns whether the value of the 'Form' attribute is set.
Returns:
whether the value of the 'Form' attribute is set.
See Also:
unsetForm(), getLiteralForm(), setForm(EEnumLiteral)

getLexicalValue

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

This concrete attribute represents the value of the attribute fixed or default attribute or the element fixed or default attribute.

Returns:
the value of the 'Lexical Value' attribute.
See Also:
isSetLexicalValue(), unsetLexicalValue(), setLexicalValue(String), XSDPackage.getXSDFeature_LexicalValue()

setLexicalValue

public void setLexicalValue(java.lang.String value)
Sets the value of the 'Lexical Value' attribute.
Parameters:
value - the new value of the 'Lexical Value' attribute.
See Also:
isSetLexicalValue(), unsetLexicalValue(), getLexicalValue()

unsetLexicalValue

public void unsetLexicalValue()
Unsets the value of the 'Lexical Value' attribute.
See Also:
isSetLexicalValue(), getLexicalValue(), setLexicalValue(String)

isSetLexicalValue

public boolean isSetLexicalValue()
Returns whether the value of the 'Lexical Value' attribute is set.
Returns:
whether the value of the 'Lexical Value' attribute is set.
See Also:
unsetLexicalValue(), getLexicalValue(), setLexicalValue(String)

getGlobal

public java.lang.Boolean getGlobal()
Returns the value of the 'Global' attribute.

This indicates whether the feature is globally scoped. Its value is false if the feature is declared within a complex type definition, an attribute group definition, or a model group definition.

Returns:
the value of the 'Global' attribute.
See Also:
isGlobal(), XSDPackage.getXSDFeature_Global()

isGlobal

public boolean isGlobal()
Returns whether the object is 'Global'.
Returns:
whether the object is 'Global'.
See Also:
getGlobal()

getFeatureReference

public java.lang.Boolean getFeatureReference()
Returns the value of the 'Feature Reference' attribute.

This is the same result as either the 'Element Reference' attribute or the 'Attribute Reference' attribute.

Returns:
the value of the 'Feature Reference' attribute.
See Also:
isFeatureReference(), XSDPackage.getXSDFeature_FeatureReference()

isFeatureReference

public boolean isFeatureReference()
Returns whether the object is 'Feature Reference'.
Returns:
whether the object is 'Feature Reference'.
See Also:
getFeatureReference()

getScope

public XSDScope getScope()
Returns the value of the 'Scope' reference.

This represents the attribute scope or element scope infoset property.

Returns:
the value of the 'Scope' reference.
See Also:
XSDPackage.getXSDFeature_Scope()

getType

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

This is the same result as either the element 'Type Definition' reference or the attribute 'Type Definition' reference.

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

getResolvedFeature

public XSDFeature getResolvedFeature()
Returns the value of the 'Resolved Feature' reference.

This is the same result as either the 'Resolved Element Declaration' reference or the 'Resolved Attribute Declaration' reference.

Returns:
the value of the 'Resolved Feature' reference.
See Also:
XSDPackage.getXSDFeature_ResolvedFeature()