public interface

XSElementDeclaration

implements XSTerm
org.apache.xerces.xs.XSElementDeclaration
Known Indirect Subclasses

Class Overview

The interface represents the Element Declaration schema component.

Summary

Public Methods
abstract boolean getAbstract()
{abstract} A boolean.
abstract Object getActualVC()
Value Constraint: Binding specific actual constraint value or null if the value is in error or there is no value constraint.
abstract short getActualVCType()
The actual constraint value built-in datatype, e.g.
abstract XSAnnotation getAnnotation()
An annotation if it exists, otherwise null.
abstract XSObjectList getAnnotations()
A sequence of [annotations] or an empty XSObjectList.
abstract short getConstraintType()
[Value constraint]: one of VC_NONE, VC_DEFAULT, VC_FIXED.
abstract String getConstraintValue()
[Value constraint]: the constraint value with respect to the [type definition], otherwise null.
abstract short getDisallowedSubstitutions()
[disallowed substitutions]: the returned value is a bit combination of the subset of { DERIVATION_SUBSTITUTION, DERIVATION_EXTENSION, DERIVATION_RESTRICTION } corresponding to substitutions disallowed by this XSElementDeclaration or DERIVATION_NONE.
abstract XSComplexTypeDefinition getEnclosingCTDefinition()
The complex type definition for locally scoped declarations (see scope), otherwise null if no such definition exists.
abstract XSNamedMap getIdentityConstraints()
identity-constraint definitions: a set of constraint definitions if it exists, otherwise an empty XSNamedMap.
abstract ShortList getItemValueTypes()
In the case the actual constraint value represents a list, i.e.
abstract boolean getNillable()
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 (xsi:nil) even if it has no text or element content despite a content type which would otherwise require content.
abstract short getScope()
[scope].
abstract XSElementDeclaration getSubstitutionGroupAffiliation()
[substitution group affiliation]: a top-level element definition if it exists, otherwise null.
abstract short getSubstitutionGroupExclusions()
[substitution group exclusions]: the returned value is a bit combination of the subset of { DERIVATION_EXTENSION, DERIVATION_RESTRICTION} or DERIVATION_NONE.
abstract XSTypeDefinition getTypeDefinition()
[type definition]: either a simple type definition or a complex type definition.
abstract boolean isDisallowedSubstitution(short disallowed)
Convenience method that checks if disallowed is a disallowed substitution for this element declaration.
abstract boolean isSubstitutionGroupExclusion(short exclusion)
Convenience method that checks if exclusion is a substitution group exclusion for this element declaration.
[Expand]
Inherited Methods
From interface org.apache.xerces.xs.XSObject

Public Methods

public abstract boolean getAbstract ()

{abstract} A boolean.

public abstract Object getActualVC ()

Value Constraint: Binding specific actual constraint value or null if the value is in error or there is no value constraint.

Throws
XSException NOT_SUPPORTED_ERR: Raised if the implementation does not support this method.

public abstract short getActualVCType ()

The actual constraint value built-in datatype, e.g. STRING_DT, SHORT_DT. If the type definition of this value is a list type definition, this method returns LIST_DT. If the type definition of this value is a list type definition whose item type is a union type definition, this method returns LISTOFUNION_DT. To query the actual constraint value of the list or list of union type definitions use itemValueTypes. If the actualNormalizedValue is null, this method returns UNAVAILABLE_DT .

Throws
XSException NOT_SUPPORTED_ERR: Raised if the implementation does not support this method.

public abstract XSAnnotation getAnnotation ()

An annotation if it exists, otherwise null. If not null then the first [annotation] from the sequence of annotations.

public abstract XSObjectList getAnnotations ()

A sequence of [annotations] or an empty XSObjectList.

public abstract short getConstraintType ()

[Value constraint]: one of VC_NONE, VC_DEFAULT, VC_FIXED.

public abstract String getConstraintValue ()

[Value constraint]: the constraint value with respect to the [type definition], otherwise null.

public abstract short getDisallowedSubstitutions ()

[disallowed substitutions]: the returned value is a bit combination of the subset of { DERIVATION_SUBSTITUTION, DERIVATION_EXTENSION, DERIVATION_RESTRICTION } corresponding to substitutions disallowed by this XSElementDeclaration or DERIVATION_NONE.

public abstract XSComplexTypeDefinition getEnclosingCTDefinition ()

The complex type definition for locally scoped declarations (see scope), otherwise null if no such definition exists.

public abstract XSNamedMap getIdentityConstraints ()

identity-constraint definitions: a set of constraint definitions if it exists, otherwise an empty XSNamedMap.

public abstract ShortList getItemValueTypes ()

In the case the actual constraint value represents a list, i.e. the actualValueType is LIST_DT, the returned array consists of one type kind which represents the itemType. If the actual constraint value represents a list type definition whose item type is a union type definition, i.e. LISTOFUNION_DT, for each actual constraint value in the list the array contains the corresponding memberType kind. For examples, see ItemPSVI.itemValueTypes.

Throws
XSException NOT_SUPPORTED_ERR: Raised if the implementation does not support this method.

public abstract boolean getNillable ()

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 (xsi:nil) even if it has no text or element content despite a content type which would otherwise require content.

public abstract short getScope ()

[scope]. One of SCOPE_GLOBAL, SCOPE_LOCAL, or SCOPE_ABSENT. If the scope is local, then the enclosingCTDefinition is present.

public abstract XSElementDeclaration getSubstitutionGroupAffiliation ()

[substitution group affiliation]: a top-level element definition if it exists, otherwise null.

public abstract short getSubstitutionGroupExclusions ()

[substitution group exclusions]: the returned value is a bit combination of the subset of { DERIVATION_EXTENSION, DERIVATION_RESTRICTION} or DERIVATION_NONE.

public abstract XSTypeDefinition getTypeDefinition ()

[type definition]: either a simple type definition or a complex type definition.

public abstract boolean isDisallowedSubstitution (short disallowed)

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

Parameters
disallowed { DERIVATION_SUBSTITUTION, DERIVATION_EXTENSION, DERIVATION_RESTRICTION } or DERIVATION_NONE. Represents a block set for the element.
Returns
  • True if disallowed is a part of the substitution group exclusion subset.

public abstract boolean isSubstitutionGroupExclusion (short exclusion)

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

Parameters
exclusion DERIVATION_EXTENSION, DERIVATION_RESTRICTION or DERIVATION_NONE. Represents final set for the element.
Returns
  • True if exclusion is a part of the substitution group exclusion subset.