org.apache.ws.jaxme.xs

Interface XSElement

public interface XSElement extends XSOpenAttrs

Interface of a schema element

Author: Jochen Wiedmann

Method Summary
XSAnnotation[]getAnnotations()

Returns the array of annotations.

StringgetDefault()

Returns the elements "default" value or null, if no such attribute is set.

StringgetFixed()

Returns the elements "fixed" value or null, if no such attribute is set.

XSIdentityConstraint[]getIdentityConstraints()
Fetch all of the identity constraints that this element places upon its child tags.
XSKeyRef[]getKeyRefs()
Fetch all of the keyref's declared by this element.
XsQNamegetName()

Returns the elements name.

XSGroupgetSubstitutionGroup()

If the element may be substituted by other elements (in other words: if it is the head of a substitution group), returns the choice group of all the elements that may be used to replace the element.

XsQNamegetSubstitutionGroupName()

Returns the name of an element, which may be substituted by this element.

XSTypegetType()

Returns the elements type.

booleanisAbstract()

Returns whether the element is abstract or not.

booleanisBlockedForSubstitution()

Returns whether this element is blocked for substitution.

booleanisGlobal()

Returns whether the element is global or not.

booleanisNillable()

Returns whether the element is nillable or not.

booleanisReference()
Returns, whether the element is created by referencing another element.
voidsetSubstitutionGroup(XSGroup pGroup)

If the element may be substituted by other elements (in other words: if it is the head of a substitution group), sets the choice group of all the elements that may be used to replace the element.

Method Detail

getAnnotations

public XSAnnotation[] getAnnotations()

Returns the array of annotations.

getDefault

public String getDefault()

Returns the elements "default" value or null, if no such attribute is set.

getFixed

public String getFixed()

Returns the elements "fixed" value or null, if no such attribute is set.

getIdentityConstraints

public XSIdentityConstraint[] getIdentityConstraints()
Fetch all of the identity constraints that this element places upon its child tags. Note that a single xs:unique or xs:key tag may expand to several elements in this array depending on their xpath fields.

getKeyRefs

public XSKeyRef[] getKeyRefs()
Fetch all of the keyref's declared by this element.

getName

public XsQName getName()

Returns the elements name. Note that, unlike types, an element always has a name.

getSubstitutionGroup

public XSGroup getSubstitutionGroup()

If the element may be substituted by other elements (in other words: if it is the head of a substitution group), returns the choice group of all the elements that may be used to replace the element. The element itself is part of the substitution group if, and only if, the element is not abstract.

getSubstitutionGroupName

public XsQName getSubstitutionGroupName()

Returns the name of an element, which may be substituted by this element.

getType

public XSType getType()

Returns the elements type.

isAbstract

public boolean isAbstract()

Returns whether the element is abstract or not.

isBlockedForSubstitution

public boolean isBlockedForSubstitution()

Returns whether this element is blocked for substitution.

isGlobal

public boolean isGlobal()

Returns whether the element is global or not.

isNillable

public boolean isNillable()

Returns whether the element is nillable or not.

isReference

public boolean isReference()
Returns, whether the element is created by referencing another element.

setSubstitutionGroup

public void setSubstitutionGroup(XSGroup pGroup)

If the element may be substituted by other elements (in other words: if it is the head of a substitution group), sets the choice group of all the elements that may be used to replace the element. The element itself is part of the substitution group if, and only if, the element is not abstract.