public class

XSElementDecl

extends Object
implements XSElementDeclaration
java.lang.Object
   ↳ org.apache.xerces.impl.xs.XSElementDecl

Class Overview

The XML representation for an element declaration schema component is an <element> element information item

Summary

Constants
short SCOPE_ABSENT
short SCOPE_GLOBAL
short SCOPE_LOCAL
Fields
public XSObjectList fAnnotations
public short fBlock
public ValidatedInfo fDefault
public short fFinal
public String fName
public short fScope
public XSElementDecl fSubGroup
public String fTargetNamespace
public XSTypeDefinition fType
Public Constructors
XSElementDecl()
Public Methods
void addIDConstraint(IdentityConstraint idc)
boolean equals(Object o)
whether two decls are the same
boolean getAbstract()
{abstract} A boolean.
Object getActualVC()
Value Constraint: Binding specific actual constraint value or null if the value is in error or there is no value constraint.
short getActualVCType()
The actual constraint value built-in datatype, e.g.
XSAnnotation getAnnotation()
Optional.
XSObjectList getAnnotations()
Optional.
short getConstraintType()
A value constraint: one of default, fixed.
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.
IdentityConstraint[] getIDConstraints()
XSNamedMap getIdentityConstraints()
{identity-constraint definitions} A set of constraint definitions.
ShortList getItemValueTypes()
In the case the actual constraint value represents a list, i.e.
String getName()
The name of this XSObject depending on the XSObject type.
String getNamespace()
The namespace URI of this node, or null if it is unspecified.
XSNamespaceItem getNamespaceItem()
A namespace schema information item corresponding to the target namespace of the component, if it is globally declared; or null otherwise.
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 (see xsi:nil (2.6.2)) even if it has no text or element content despite a {content type} which would otherwise require content.
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.
short getType()
Get the type of the object, i.e ELEMENT_DECLARATION.
XSTypeDefinition getTypeDefinition()
Either a simple type definition or a complex type definition.
int hashCode()
get the hash code
boolean isDisallowedSubstitution(short disallowed)
Convenience method.
boolean isSubstitutionGroupExclusion(short exclusion)
Convenience method.
void reset()
Reset current element declaration
void setConstraintType(short constraintType)
void setIsAbstract()
void setIsGlobal()
void setIsLocal(XSComplexTypeDecl enclosingCT)
void setIsNillable()
String toString()
[Expand]
Inherited Methods
From class java.lang.Object
From interface org.apache.xerces.xs.XSElementDeclaration
From interface org.apache.xerces.xs.XSObject

Constants

public static final short SCOPE_ABSENT

Constant Value: 0 (0x00000000)

public static final short SCOPE_GLOBAL

Constant Value: 1 (0x00000001)

public static final short SCOPE_LOCAL

Constant Value: 2 (0x00000002)

Fields

public XSObjectList fAnnotations

public short fBlock

public ValidatedInfo fDefault

public short fFinal

public String fName

public short fScope

public XSElementDecl fSubGroup

public String fTargetNamespace

public XSTypeDefinition fType

Public Constructors

public XSElementDecl ()

Public Methods

public void addIDConstraint (IdentityConstraint idc)

public boolean equals (Object o)

whether two decls are the same

public boolean getAbstract ()

{abstract} A boolean.

public Object getActualVC ()

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

public 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 .

public XSAnnotation getAnnotation ()

Optional. Annotation.

public XSObjectList getAnnotations ()

Optional. Annotations.

public short getConstraintType ()

A value constraint: one of default, fixed.

public String getConstraintValue ()

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

public short getDisallowedSubstitutions ()

The supplied values for {disallowed substitutions}

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

public XSComplexTypeDefinition getEnclosingCTDefinition ()

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

public IdentityConstraint[] getIDConstraints ()

public XSNamedMap getIdentityConstraints ()

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

public 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.

public String getName ()

The name of this XSObject depending on the XSObject type.

public String getNamespace ()

The namespace URI of this node, or null if it is unspecified. defines how a namespace URI is attached to schema components.

public XSNamespaceItem getNamespaceItem ()

A namespace schema information item corresponding to the target namespace of the component, if it is globally declared; or null otherwise.

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

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.

public XSElementDeclaration getSubstitutionGroupAffiliation ()

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

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.

public short getType ()

Get the type of the object, i.e ELEMENT_DECLARATION.

public XSTypeDefinition getTypeDefinition ()

Either a simple type definition or a complex type definition.

public int hashCode ()

get the hash code

public boolean isDisallowedSubstitution (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.

public boolean isSubstitutionGroupExclusion (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.

public void reset ()

Reset current element declaration

public void setConstraintType (short constraintType)

public void setIsAbstract ()

public void setIsGlobal ()

public void setIsLocal (XSComplexTypeDecl enclosingCT)

public void setIsNillable ()

public String toString ()