Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
public interface XSElementDeclaration
extends XSTerm
Method Summary | |
boolean |
|
Object |
|
short |
|
XSAnnotation |
|
XSObjectList |
|
short |
|
String |
|
short |
|
XSComplexTypeDefinition |
|
XSNamedMap |
|
ShortList |
|
boolean |
|
short |
|
XSElementDeclaration |
|
short |
|
XSTypeDefinition |
|
boolean |
|
boolean |
|
Methods inherited from interface org.apache.xerces.xs.XSObject | |
getName , getNamespace , getNamespaceItem , getType |
public boolean getAbstract()
{abstract} A boolean.
public Object getActualVC() throws XSException
Value Constraint: Binding specific actual constraint value ornull
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 short getActualVCType() throws XSException
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 returnsLIST_DT
. If the type definition of this value is a list type definition whose item type is a union type definition, this method returnsLISTOFUNION_DT
. To query the actual constraint value of the list or list of union type definitions useitemValueTypes
. If theactualNormalizedValue
isnull
, this method returnsUNAVAILABLE_DT
.
- Throws:
XSException
- NOT_SUPPORTED_ERR: Raised if the implementation does not support this method.
public XSAnnotation getAnnotation()
An annotation if it exists, otherwisenull
. If not null then the first [annotation] from the sequence of annotations.
public XSObjectList getAnnotations()
A sequence of [annotations] or an emptyXSObjectList
.
public short getConstraintType()
[Value constraint]: one ofVC_NONE, VC_DEFAULT, VC_FIXED
.
public String getConstraintValue()
[Value constraint]: the constraint value with respect to the [type definition], otherwisenull
.
public 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 thisXSElementDeclaration
orDERIVATION_NONE
.
public XSComplexTypeDefinition getEnclosingCTDefinition()
The complex type definition for locally scoped declarations (seescope
), otherwisenull
if no such definition exists.
public XSNamedMap getIdentityConstraints()
identity-constraint definitions: a set of constraint definitions if it exists, otherwise an emptyXSNamedMap
.
public ShortList getItemValueTypes() throws XSException
In the case the actual constraint value represents a list, i.e. theactualValueType
isLIST_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, seeItemPSVI.itemValueTypes
.
- Throws:
XSException
- NOT_SUPPORTED_ERR: Raised if the implementation does not support this method.
public boolean getNillable()
If nillable is true, then an element may also be valid if it carries the namespace qualified attribute with local namenil
from namespacehttp://www.w3.org/2001/XMLSchema-instance
and valuetrue
(xsi:nil) even if it has no text or element content despite acontent type
which would otherwise require content.
public short getScope()
[scope]. One ofSCOPE_GLOBAL
,SCOPE_LOCAL
, orSCOPE_ABSENT
. If the scope is local, then theenclosingCTDefinition
is present.
public XSElementDeclaration getSubstitutionGroupAffiliation()
[substitution group affiliation]: a top-level element definition if it exists, otherwisenull
.
public short getSubstitutionGroupExclusions()
[substitution group exclusions]: the returned value is a bit combination of the subset of {DERIVATION_EXTENSION, DERIVATION_RESTRICTION
} orDERIVATION_NONE
.
public XSTypeDefinition getTypeDefinition()
[type definition]: either a simple type definition or a complex type definition.
public boolean isDisallowedSubstitution(short disallowed)
Convenience method that checks ifdisallowed
is a disallowed substitution for this element declaration.
- Parameters:
disallowed
- {DERIVATION_SUBSTITUTION, DERIVATION_EXTENSION, DERIVATION_RESTRICTION
} orDERIVATION_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 that checks ifexclusion
is a substitution group exclusion for this element declaration.
- Parameters:
exclusion
-DERIVATION_EXTENSION, DERIVATION_RESTRICTION
orDERIVATION_NONE
. Represents final set for the element.
- Returns:
- True if
exclusion
is a part of the substitution group exclusion subset.