| org.apache.xerces.xs.XSElementDeclaration
All known Subclasses: org.apache.xerces.impl.xs.XSElementDecl,
| XSElementDeclaration | | public interface XSElementDeclaration extends XSTerm(Code) | | The interface represents the Element Declaration schema component.
|
| Method Summary | |
| 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. | | public XSAnnotation | getAnnotation()
An annotation if it exists, otherwise null. | | public XSObjectList | getAnnotations()
A sequence of [annotations] or an empty XSObjectList. | | public short | getConstraintType()
[Value constraint]: one of VC_NONE, VC_DEFAULT, VC_FIXED. | | public String | getConstraintValue()
[Value constraint]: the constraint value with respect to the [type
definition], otherwise null. | | 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 this
XSElementDeclaration or DERIVATION_NONE. | | public XSComplexTypeDefinition | getEnclosingCTDefinition()
The complex type definition for locally scoped declarations (see
scope), otherwise null if no such
definition exists. | | public XSNamedMap | getIdentityConstraints()
identity-constraint definitions: a set of constraint definitions if it
exists, otherwise an empty XSNamedMap. | | public ShortList | getItemValueTypes()
In the case the actual constraint value represents a list, i.e. | | 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 (xsi:nil) even if it has no text or
element content despite a content type which would
otherwise require content. | | public short | getScope()
[scope]. | | public XSElementDeclaration | getSubstitutionGroupAffiliation()
[substitution group affiliation]: a top-level element definition if it
exists, otherwise null. | | public short | getSubstitutionGroupExclusions()
[substitution group exclusions]: the returned value is a bit
combination of the subset of {
DERIVATION_EXTENSION, DERIVATION_RESTRICTION} or
DERIVATION_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 if disallowed is a
disallowed substitution for this element declaration. | | public boolean | isSubstitutionGroupExclusion(short exclusion)
Convenience method that checks if exclusion is a
substitution group exclusion for this element declaration. |
| getAbstract | | public boolean getAbstract()(Code) | | {abstract} A boolean.
|
| getActualVC | | public Object getActualVC() throws XSException(Code) | | Value Constraint: Binding specific actual constraint value or
null if the value is in error or there is no value
constraint.
exception:
XSException - NOT_SUPPORTED_ERR: Raised if the implementation does not support this method. |
| getActualVCType | | public short getActualVCType() throws XSException(Code) | | 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
.
exception:
XSException - NOT_SUPPORTED_ERR: Raised if the implementation does not support this method. |
| getAnnotation | | public XSAnnotation getAnnotation()(Code) | | An annotation if it exists, otherwise null. If not null
then the first [annotation] from the sequence of annotations.
|
| getAnnotations | | public XSObjectList getAnnotations()(Code) | | A sequence of [annotations] or an empty XSObjectList.
|
| getConstraintType | | public short getConstraintType()(Code) | | [Value constraint]: one of VC_NONE, VC_DEFAULT, VC_FIXED.
|
| getConstraintValue | | public String getConstraintValue()(Code) | | [Value constraint]: the constraint value with respect to the [type
definition], otherwise null.
|
| getDisallowedSubstitutions | | public short getDisallowedSubstitutions()(Code) | | [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.
|
| getEnclosingCTDefinition | | public XSComplexTypeDefinition getEnclosingCTDefinition()(Code) | | The complex type definition for locally scoped declarations (see
scope), otherwise null if no such
definition exists.
|
| getIdentityConstraints | | public XSNamedMap getIdentityConstraints()(Code) | | identity-constraint definitions: a set of constraint definitions if it
exists, otherwise an empty XSNamedMap.
|
| getItemValueTypes | | public ShortList getItemValueTypes() throws XSException(Code) | | 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.
exception:
XSException - NOT_SUPPORTED_ERR: Raised if the implementation does not support this method. |
| getNillable | | public boolean getNillable()(Code) | | 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.
|
| getScope | | public short getScope()(Code) | | [scope]. One of SCOPE_GLOBAL, SCOPE_LOCAL, or
SCOPE_ABSENT. If the scope is local, then the
enclosingCTDefinition is present.
|
| getSubstitutionGroupAffiliation | | public XSElementDeclaration getSubstitutionGroupAffiliation()(Code) | | [substitution group affiliation]: a top-level element definition if it
exists, otherwise null.
|
| getSubstitutionGroupExclusions | | public short getSubstitutionGroupExclusions()(Code) | | [substitution group exclusions]: the returned value is a bit
combination of the subset of {
DERIVATION_EXTENSION, DERIVATION_RESTRICTION} or
DERIVATION_NONE.
|
| getTypeDefinition | | public XSTypeDefinition getTypeDefinition()(Code) | | [type definition]: either a simple type definition or a complex type
definition.
|
| isDisallowedSubstitution | | public boolean isDisallowedSubstitution(short disallowed)(Code) | | 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. True if disallowed is a part of the substitution group exclusion subset. |
| isSubstitutionGroupExclusion | | public boolean isSubstitutionGroupExclusion(short exclusion)(Code) | | 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. True if exclusion is a part of the substitution group exclusion subset. |
|
|