com.pega.pegarules.pub.services.xsd
Interface XSDElementDeclaration

All Superinterfaces:

XSDComponent

public interface XSDElementDeclaration
extends XSDComponent

Metadata for a single element declaration from an XML Schema

Version:

$Revision: 31 $ $Date: 2009-06-24 09:38:04 -0400 (Wed, 24 Jun 2009) $

Author:

Peter Tandara-Kuhns

Field Summary

static java.lang.String	COPYRIGHT
static java.lang.String	VERSION

Method Summary

java.lang.String	getBlockValue() Get the value of the 'block' attribute.
java.lang.String	getDefaultValue() Get the value of the 'default' attribute.
java.lang.String	getFinalValue() Get the value of the 'final' attribute.
java.lang.String	getFixedValue() Get the value of the 'fixed' attribute.
java.lang.String	getFormValue() Get the value of the 'form' attribute.
XSDComponentList	getIdentityConstraints() Get the list of identity constraints for this element.
int	getMaxOccursValue() Get the value of the 'maxOccurs' attribute.
int	getMinOccursValue() Get the value of the 'minOccurs' attribute.
java.lang.String	getName() Get the name of this element.
java.lang.String	getNamespaceURI() Get the namespace URI that this element belongs to.
XSDComponentList	getSubstituteElementDeclarations() Get the list of element declaration components that are valid substitutes for this element.
javax.xml.namespace.QName	getSubstitutionGroupValue() Get the value of the 'substitutionGroup' attribute as a qualified name.
XSDTypeDefinition	getTypeDefinition() Get the type definition component associated with this element.
javax.xml.namespace.QName	getTypeReferenceValue() Get the value of the 'type' attribute as a qualified name.
boolean	isAbstract() Get the value of the 'abstract' attribute as a boolean.
boolean	isGlobal() Determine if the element declaration has global scope.
boolean	isNillable() Get the value of the 'nillable' attribute as a boolean.

Methods inherited from interface com.pega.pegarules.pub.services.xsd.XSDComponent

getAllMetadata, getAnnotations, getIDValue

Field Detail

COPYRIGHT

static final java.lang.String COPYRIGHT

See Also:

Constant Field Values

VERSION

static final java.lang.String VERSION

Method Detail

getNamespaceURI

java.lang.String getNamespaceURI()

Get the namespace URI that this element belongs to.

Returns:

the namespace URI value

getName

java.lang.String getName()

Get the name of this element.

Returns:

the name value

getFormValue

java.lang.String getFormValue()

Get the value of the 'form' attribute. Legal values for this attribute are 'unqualified' or 'qualified'. If declared, this value overrides an declared or undeclared form default value defined at schema scope.

Returns:

the value, or null if the attribute is not present

getBlockValue

java.lang.String getBlockValue()

Get the value of the 'block' attribute. Legal values are '#all' or a whitespace-separated list containing the values 'extension', 'restriction', or 'substitution'.

Returns:

the value, or the schema 'blockDefault' value if the attribute is not present

getFinalValue

java.lang.String getFinalValue()

Get the value of the 'final' attribute. Legal values are '#all' or a whitespace-delimited list containing the values 'extension' or 'restriction'.

Returns:

the value, or the schema 'finalDefault' value if the attribute is not present

getDefaultValue

java.lang.String getDefaultValue()

Get the value of the 'default' attribute. It is not legal to use both the 'default' and the 'fixed' attribute on the same element declaration.

Returns:

the value, or null if the attribute is not present

getFixedValue

java.lang.String getFixedValue()

Get the value of the 'fixed' attribute. It is not legal to use both the 'default' and the 'fixed' attribute on the same element declaration.

Returns:

the value, or null if the attribute is not present

getMinOccursValue

int getMinOccursValue()

Get the value of the 'minOccurs' attribute. This attribute is only legal when the element declaration has local scope. Legal values are all non-negative integers.

Returns:

the value, or 1 if the attribute is not present

getMaxOccursValue

int getMaxOccursValue()

Get the value of the 'maxOccurs' attribute. This attribute is only legal when the element declaration has local scope. Legal values are all non-negative integers, or the 'unbounded' constant value. If the 'unbounded' constant is used, this method will return Integer.MAX_INT.

Returns:

the value, or 1 if the attribute is not present

isGlobal

boolean isGlobal()

Determine if the element declaration has global scope.

Returns:

true if the element declaration is global, false otherwise

isAbstract

boolean isAbstract()

Get the value of the 'abstract' attribute as a boolean. Abstract elements must be substituted with valid elements from a declared element substitution group at runtime, or the XML instance will not be valid.

Returns:

the value, or false if the attribute is not present

isNillable

boolean isNillable()

Get the value of the 'nillable' attribute as a boolean. Nillable elements can use the xsi:nil attribute at runtime to specify that the element has no value.

Returns:

the value, or false if the attribute is not present

getSubstitutionGroupValue

javax.xml.namespace.QName getSubstitutionGroupValue()

Get the value of the 'substitutionGroup' attribute as a qualified name. This attribute can be declared on any global element declaration.

Returns:

the value, null if the attribute is not present

getTypeReferenceValue

javax.xml.namespace.QName getTypeReferenceValue()

Get the value of the 'type' attribute as a qualified name. If the type is not declared, the value will be the built-in xsd:anyType ur-type. The built-in XSD types are described in the W3C XML Schema specification, Part 2.

Returns:

the qualified type name, or null if the attribute is not present

getTypeDefinition

XSDTypeDefinition getTypeDefinition()

Get the type definition component associated with this element.

Returns:

the type definition component

getIdentityConstraints

XSDComponentList getIdentityConstraints()

Get the list of identity constraints for this element. List elements are of type XSDElementIdentityConstraint.

Returns:

the list of identity constraints

getSubstituteElementDeclarations

XSDComponentList getSubstituteElementDeclarations()

Get the list of element declaration components that are valid substitutes for this element. List elements are of type XSDElementDeclaration.

Returns:

the list of substitutable elements