org.apache.ws.jaxme.xs
Interface XSElement

All Superinterfaces:

XSObject, XSOpenAttrs

All Known Subinterfaces:

JAXBElement

All Known Implementing Classes:

JAXBElementImpl, XSElementImpl

public interface XSElement
extends XSOpenAttrs

Interface of a schema element

Author:

Jochen Wiedmann

Method Summary

XSAnnotation[]	getAnnotations() Returns the array of annotations.
java.lang.String	getDefault() Returns the elements "default" value or null, if no such attribute is set.
java.lang.String	getFixed() 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.
XsQName	getName() Returns the elements name.
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.
XsQName	getSubstitutionGroupName() Returns the name of an element, which may be substituted by this element.
XSType	getType() Returns the elements type.
boolean	isAbstract() Returns whether the element is abstract or not.
boolean	isBlockedForSubstitution() Returns whether this element is blocked for substitution.
boolean	isGlobal() Returns whether the element is global or not.
boolean	isNillable() Returns whether the element is nillable or not.
boolean	isReference() Returns, whether the element is created by referencing another element.
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.

Methods inherited from interface org.apache.ws.jaxme.xs.XSOpenAttrs

getOpenAttributes

Methods inherited from interface org.apache.ws.jaxme.xs.XSObject

getLocator, getParentObject, getXSSchema, isTopLevelObject, validate

Method Detail

getAnnotations

XSAnnotation[] getAnnotations()

Returns the array of annotations.

isGlobal

boolean isGlobal()

Returns whether the element is global or not.

isNillable

boolean isNillable()

Returns whether the element is nillable or not.

getName

XsQName getName()

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

getType

XSType getType()

Returns the elements type.

getDefault

java.lang.String getDefault()

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

getFixed

java.lang.String getFixed()

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

getSubstitutionGroupName

XsQName getSubstitutionGroupName()

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

isBlockedForSubstitution

boolean isBlockedForSubstitution()

Returns whether this element is blocked for substitution.

isAbstract

boolean isAbstract()

Returns whether the element is abstract or not.

setSubstitutionGroup

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.

getSubstitutionGroup

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.

getIdentityConstraints

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

XSKeyRef[] getKeyRefs()

Fetch all of the keyref's declared by this element.

isReference

boolean isReference()

Returns, whether the element is created by referencing another element.