Top Description Fields Constructors Methods
com.sun.org.apache.xerces.internal.impl.xs

public Class XSElementDecl

extends Object
implements XSElementDeclaration
Class Inheritance
All Implemented Interfaces
com.sun.org.apache.xerces.internal.xs.XSElementDeclaration, com.sun.org.apache.xerces.internal.xs.XSTerm, com.sun.org.apache.xerces.internal.xs.XSObject
Imports
com.sun.org.apache.xerces.internal.impl.dv.ValidatedInfo, com.sun.org.apache.xerces.internal.impl.xs.identity.IdentityConstraint, com.sun.org.apache.xerces.internal.impl.xs.util.XSNamedMapImpl, .XSObjectListImpl, com.sun.org.apache.xerces.internal.xni.QName, com.sun.org.apache.xerces.internal.xs.ShortList, .XSAnnotation, .XSComplexTypeDefinition, .XSConstants, .XSElementDeclaration, .XSNamedMap, .XSNamespaceItem, .XSObjectList, .XSTypeDefinition, .XSValue

The XML representation for an element declaration schema component is an <element> element information item
Authors
Elena Litani, IBM, Sandy Gao, IBM

Field Summary

Modifier and TypeField and Description
private static final short
private static final short
public XSObjectList
public short
public ValidatedInfo
private String
fDescription

get the string description of this element

pack-priv XSComplexTypeDecl
public short
pack-priv IdentityConstraint[]
pack-priv int
pack-priv short
public String
private XSNamespaceItem
public short
public XSElementDecl
public String
public XSTypeDefinition
public QName
pack-priv static final int
private static final short
public static final short
public static final short
public static final short

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public void
public boolean
equals(Object
the reference object with which to compare.
o
)

Overrides java.lang.Object.equals.

whether two decls are the same

public boolean
public Object
getActualVC()

Implements com.sun.org.apache.xerces.internal.xs.XSElementDeclaration.getActualVC.

Deprecated

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

public short
getActualVCType()

Implements com.sun.org.apache.xerces.internal.xs.XSElementDeclaration.getActualVCType.

Deprecated

The actual constraint value built-in datatype, e.g. STRING_DT, SHORT_DT.

public XSAnnotation
public XSObjectList
public short
public String
getConstraintValue()

Implements com.sun.org.apache.xerces.internal.xs.XSElementDeclaration.getConstraintValue.

Deprecated

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

public short

Returns:

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

Implements com.sun.org.apache.xerces.internal.xs.XSElementDeclaration.getDisallowedSubstitutions.

The supplied values for {disallowed substitutions}

public XSComplexTypeDefinition
getEnclosingCTDefinition()

Implements com.sun.org.apache.xerces.internal.xs.XSElementDeclaration.getEnclosingCTDefinition.

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

public IdentityConstraint[]
public XSNamedMap
getIdentityConstraints()

Implements com.sun.org.apache.xerces.internal.xs.XSElementDeclaration.getIdentityConstraints.

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

public ShortList
getItemValueTypes()

Implements com.sun.org.apache.xerces.internal.xs.XSElementDeclaration.getItemValueTypes.

Deprecated

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.

public String
getName()

Implements com.sun.org.apache.xerces.internal.xs.XSObject.getName.

The name of this XSObject depending on the XSObject type.

public String
getNamespace()

Implements com.sun.org.apache.xerces.internal.xs.XSObject.getNamespace.

The namespace URI of this node, or null if it is unspecified.

public XSNamespaceItem
getNamespaceItem()

Implements com.sun.org.apache.xerces.internal.xs.XSObject.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()

Implements com.sun.org.apache.xerces.internal.xs.XSElementDeclaration.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
public XSElementDeclaration
public short

Returns:

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

Implements com.sun.org.apache.xerces.internal.xs.XSElementDeclaration.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.

public short
getType()

Implements com.sun.org.apache.xerces.internal.xs.XSObject.getType.

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

public XSTypeDefinition
getTypeDefinition()

Implements com.sun.org.apache.xerces.internal.xs.XSElementDeclaration.getTypeDefinition.

Either a simple type definition or a complex type definition.

public XSValue
getValueConstraintValue()

Implements com.sun.org.apache.xerces.internal.xs.XSElementDeclaration.getValueConstraintValue.

The actual value of the default or fixed value constraint.

public int
hashCode()

Overrides java.lang.Object.hashCode.

get the hash code

public boolean

Returns:

True if disallowed is a part of the substitution group exclusion subset.
isDisallowedSubstitution
(short
Substitution, extension, restriction or none. Represents a block set for the element.
disallowed
)

Implements com.sun.org.apache.xerces.internal.xs.XSElementDeclaration.isDisallowedSubstitution.

Convenience method.

public boolean

Returns:

True if exclusion is a part of the substitution group exclusion subset.
isSubstitutionGroupExclusion
(short
Extension, restriction or none. Represents final set for the element.
exclusion
)

Implements com.sun.org.apache.xerces.internal.xs.XSElementDeclaration.isSubstitutionGroupExclusion.

Convenience method.

public void
reset()

Reset current element declaration

pack-priv static final IdentityConstraint[]
resize(IdentityConstraint[] oldArray, int newSize)

public void
setConstraintType(short constraintType)

public void
public void
public void
public void
pack-priv void
public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

ABSTRACTback to summary
private static final short ABSTRACT
CONSTRAINT_MASKback to summary
private static final short CONSTRAINT_MASK
fAnnotationsback to summary
public XSObjectList fAnnotations
fBlockback to summary
public short fBlock
fDefaultback to summary
public ValidatedInfo fDefault
fDescriptionback to summary
private String fDescription

get the string description of this element

fEnclosingCTback to summary
pack-priv XSComplexTypeDecl fEnclosingCT
fFinalback to summary
public short fFinal
fIDConstraintsback to summary
pack-priv IdentityConstraint[] fIDConstraints
fIDCPosback to summary
pack-priv int fIDCPos
fMiscFlagsback to summary
pack-priv short fMiscFlags
fNameback to summary
public String fName
fNamespaceItemback to summary
private XSNamespaceItem fNamespaceItem
fScopeback to summary
public short fScope
fSubGroupback to summary
public XSElementDecl fSubGroup
fTargetNamespaceback to summary
public String fTargetNamespace
fTypeback to summary
public XSTypeDefinition fType
fUnresolvedTypeNameback to summary
public QName fUnresolvedTypeName
INITIAL_SIZEback to summary
pack-priv static final int INITIAL_SIZE
NILLABLEback to summary
private static final short NILLABLE
SCOPE_ABSENTback to summary
public static final short SCOPE_ABSENT
SCOPE_GLOBALback to summary
public static final short SCOPE_GLOBAL
SCOPE_LOCALback to summary
public static final short SCOPE_LOCAL

Constructor Detail

XSElementDeclback to summary
public XSElementDecl()

Method Detail

addIDConstraintback to summary
public void addIDConstraint(IdentityConstraint idc)
equalsback to summary
public boolean equals(Object o)

Overrides java.lang.Object.equals.

whether two decls are the same

Parameters
o:Object

Doc from java.lang.Object.equals.

the reference object with which to compare.

Returns:boolean

Doc from java.lang.Object.equals.

true if this object is the same as the obj argument; false otherwise.

getAbstractback to summary
public boolean getAbstract()

Implements com.sun.org.apache.xerces.internal.xs.XSElementDeclaration.getAbstract.

{abstract} A boolean.

getActualVCback to summary
public Object getActualVC()

Implements com.sun.org.apache.xerces.internal.xs.XSElementDeclaration.getActualVC.

Doc from com.sun.org.apache.xerces.internal.xs.XSElementDeclaration.getActualVC.

Deprecated

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

Annotations
@Deprecated
getActualVCTypeback to summary
public short getActualVCType()

Implements com.sun.org.apache.xerces.internal.xs.XSElementDeclaration.getActualVCType.

Doc from com.sun.org.apache.xerces.internal.xs.XSElementDeclaration.getActualVCType.

Deprecated

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.

Annotations
@Deprecated
getAnnotationback to summary
public XSAnnotation getAnnotation()

Implements com.sun.org.apache.xerces.internal.xs.XSElementDeclaration.getAnnotation.

Optional. Annotation.

getAnnotationsback to summary
public XSObjectList getAnnotations()

Implements com.sun.org.apache.xerces.internal.xs.XSElementDeclaration.getAnnotations.

Optional. Annotations.

getConstraintTypeback to summary
public short getConstraintType()

Implements com.sun.org.apache.xerces.internal.xs.XSElementDeclaration.getConstraintType.

A value constraint: one of default, fixed.

getConstraintValueback to summary
public String getConstraintValue()

Implements com.sun.org.apache.xerces.internal.xs.XSElementDeclaration.getConstraintValue.

Deprecated

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

Annotations
@Deprecated
getDisallowedSubstitutionsback to summary
public short getDisallowedSubstitutions()

Implements com.sun.org.apache.xerces.internal.xs.XSElementDeclaration.getDisallowedSubstitutions.

The supplied values for {disallowed substitutions}

Returns:short

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

getEnclosingCTDefinitionback to summary
public XSComplexTypeDefinition getEnclosingCTDefinition()

Implements com.sun.org.apache.xerces.internal.xs.XSElementDeclaration.getEnclosingCTDefinition.

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

getIDConstraintsback to summary
public IdentityConstraint[] getIDConstraints()
getIdentityConstraintsback to summary
public XSNamedMap getIdentityConstraints()

Implements com.sun.org.apache.xerces.internal.xs.XSElementDeclaration.getIdentityConstraints.

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

getItemValueTypesback to summary
public ShortList getItemValueTypes()

Implements com.sun.org.apache.xerces.internal.xs.XSElementDeclaration.getItemValueTypes.

Doc from com.sun.org.apache.xerces.internal.xs.XSElementDeclaration.getItemValueTypes.

Deprecated

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.

Annotations
@Deprecated
getNameback to summary
public String getName()

Implements com.sun.org.apache.xerces.internal.xs.XSObject.getName.

The name of this XSObject depending on the XSObject type.

getNamespaceback to summary
public String getNamespace()

Implements com.sun.org.apache.xerces.internal.xs.XSObject.getNamespace.

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

getNamespaceItemback to summary
public XSNamespaceItem getNamespaceItem()

Implements com.sun.org.apache.xerces.internal.xs.XSObject.getNamespaceItem.

Doc from com.sun.org.apache.xerces.internal.xs.XSObject.getNamespaceItem.

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

See Also
org.apache.xerces.xs.XSObject#getNamespaceItem()
getNillableback to summary
public boolean getNillable()

Implements com.sun.org.apache.xerces.internal.xs.XSElementDeclaration.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.

getScopeback to summary
public short getScope()

Implements com.sun.org.apache.xerces.internal.xs.XSElementDeclaration.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.

getSubstitutionGroupAffiliationback to summary
public XSElementDeclaration getSubstitutionGroupAffiliation()

Implements com.sun.org.apache.xerces.internal.xs.XSElementDeclaration.getSubstitutionGroupAffiliation.

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

getSubstitutionGroupExclusionsback to summary
public short getSubstitutionGroupExclusions()

Implements com.sun.org.apache.xerces.internal.xs.XSElementDeclaration.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:short

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

getTypeback to summary
public short getType()

Implements com.sun.org.apache.xerces.internal.xs.XSObject.getType.

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

getTypeDefinitionback to summary
public XSTypeDefinition getTypeDefinition()

Implements com.sun.org.apache.xerces.internal.xs.XSElementDeclaration.getTypeDefinition.

Either a simple type definition or a complex type definition.

getValueConstraintValueback to summary
public XSValue getValueConstraintValue()

Implements com.sun.org.apache.xerces.internal.xs.XSElementDeclaration.getValueConstraintValue.

Doc from com.sun.org.apache.xerces.internal.xs.XSElementDeclaration.getValueConstraintValue.

The actual value of the default or fixed value constraint.

hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

get the hash code

Returns:int

Doc from java.lang.Object.hashCode.

a hash code value for this object

isDisallowedSubstitutionback to summary
public boolean isDisallowedSubstitution(short disallowed)

Implements com.sun.org.apache.xerces.internal.xs.XSElementDeclaration.isDisallowedSubstitution.

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

Parameters
disallowed:short

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

Returns:boolean

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

isSubstitutionGroupExclusionback to summary
public boolean isSubstitutionGroupExclusion(short exclusion)

Implements com.sun.org.apache.xerces.internal.xs.XSElementDeclaration.isSubstitutionGroupExclusion.

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

Parameters
exclusion:short

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

Returns:boolean

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

resetback to summary
public void reset()

Reset current element declaration

resizeback to summary
pack-priv static final IdentityConstraint[] resize(IdentityConstraint[] oldArray, int newSize)
setConstraintTypeback to summary
public void setConstraintType(short constraintType)
setIsAbstractback to summary
public void setIsAbstract()
setIsGlobalback to summary
public void setIsGlobal()
setIsLocalback to summary
public void setIsLocal(XSComplexTypeDecl enclosingCT)
setIsNillableback to summary
public void setIsNillable()
setNamespaceItemback to summary
pack-priv void setNamespaceItem(XSNamespaceItem namespaceItem)
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object