org.apache.xerces.impl.xs.psvi
Interface XSElementDeclaration

All Superinterfaces:

XSObject, XSTerm

All Known Implementing Classes:

XSElementDecl

public interface XSElementDeclaration

extends XSTerm

3.3.1 The Element Declaration Schema Component.

Version:

$Id: XSElementDeclaration.java,v 1.1 2002/05/13 21:31:34 sandygao Exp $

Author:

Elena Litani, IBM

Method Summary

XSAnnotation	getAnnotation() Optional.
short	getConstraintType() A value constraint: one of default, fixed.
java.lang.String	getConstraintValue() A value constraint: The actual value (with respect to the {type definition})
short	getDisallowedSubstitutions() The supplied values for {disallowed substitutions}
XSComplexTypeDefinition	getEnclosingCTDefinition() Locally scoped declarations are available for use only within the complex type definition identified by the scope property.
XSNamedMap	getIdentityConstraints() {identity-constraint definitions} A set of constraint definitions.
boolean	getIsAbstract() {abstract} A boolean.
boolean	getIsDisallowedSubstition(short disallowed) Convenience method.
boolean	getIsNillable() If {nillable} is true, then an element may also be valid if it carries the namespace qualified attribute with [local name] nil from namespace http://www.w3.org/2001/XMLSchema-instance and value true (see xsi:nil (2.6.2)) even if it has no text or element content despite a {content type} which would otherwise require content.
boolean	getIsSubstitutionGroupExclusion(short exclusion) Convenience method.
short	getScope() Optional.
XSElementDeclaration	getSubstitutionGroupAffiliation() {substitution group affiliation} Optional.
short	getSubstitutionGroupExclusions() Specifies if this declaration can be nominated as the {substitution group affiliation} of other element declarations having the same {type definition} or types derived therefrom.
XSTypeDefinition	getTypeDefinition() Either a simple type definition or a complex type definition.

Methods inherited from interface org.apache.xerces.impl.xs.psvi.XSObject

getName, getNamespace, getType

Method Detail

getTypeDefinition

public XSTypeDefinition getTypeDefinition()

Either a simple type definition or a complex type definition.

getScope

public short getScope()

Optional. Either global or a complex type definition ( ctDefinition). This property is absent in the case of declarations within named model groups: their scope will be determined when they are used in the construction of complex type definitions.

getEnclosingCTDefinition

public XSComplexTypeDefinition getEnclosingCTDefinition()

Locally scoped declarations are available for use only within the complex type definition identified by the scope property.

getConstraintType

public short getConstraintType()

A value constraint: one of default, fixed.

getConstraintValue

public java.lang.String getConstraintValue()

A value constraint: The actual value (with respect to the {type definition})

getIsNillable

public boolean getIsNillable()

If {nillable} is true, then an element may also be valid if it carries the namespace qualified attribute with [local name] nil from namespace http://www.w3.org/2001/XMLSchema-instance and value true (see xsi:nil (2.6.2)) even if it has no text or element content despite a {content type} which would otherwise require content.

getIdentityConstraints

public XSNamedMap getIdentityConstraints()

{identity-constraint definitions} A set of constraint definitions.

getSubstitutionGroupAffiliation

public XSElementDeclaration getSubstitutionGroupAffiliation()

{substitution group affiliation} Optional. A top-level element definition.

getIsSubstitutionGroupExclusion

public boolean getIsSubstitutionGroupExclusion(short exclusion)

Convenience method. Check if exclusion is a substitution group exclusion for this element declaration.

Parameters:

exclusion - Extension, restriction or none. Represents final set for the element.

Returns:

True if exclusion is a part of the substitution group exclusion subset.

getSubstitutionGroupExclusions

public short getSubstitutionGroupExclusions()

Specifies if this declaration can be nominated as the {substitution group affiliation} of other element declarations having the same {type definition} or types derived therefrom.

Returns:

A bit flag representing {extension, restriction} or NONE.

getIsDisallowedSubstition

public boolean getIsDisallowedSubstition(short disallowed)

Convenience method. Check if disallowed is a disallowed substitution for this element declaration.

Parameters:

disallowed - Substitution, extension, restriction or none. Represents a block set for the element.

Returns:

True if disallowed is a part of the substitution group exclusion subset.

getDisallowedSubstitutions

public short getDisallowedSubstitutions()

The supplied values for {disallowed substitutions}

Returns:

A bit flag representing {substitution, extension, restriction} or NONE.

getIsAbstract

public boolean getIsAbstract()

{abstract} A boolean.

getAnnotation

public XSAnnotation getAnnotation()

Optional. Annotation.