Package org.apache.jena.ext.xerces.xs
Interface XSElementDeclaration
The interface represents the Element Declaration schema component.
-
Method Summary
Modifier and TypeMethodDescriptionboolean
{abstract} A boolean.Deprecated.Use getValueConstraintValue().getActualValue() insteadshort
Deprecated.Use getValueConstraintValue().getActualValueType() insteadAn annotation if it exists, otherwisenull
.A sequence of [annotations] or an emptyXSObjectList
.short
[Value constraint]: one ofVC_NONE, VC_DEFAULT, VC_FIXED
.Deprecated.Use getValueConstraintValue().getNormalizedValue() insteadshort
[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
.The complex type definition for locally scoped declarations (seescope
), otherwisenull
if no such definition exists.identity-constraint definitions: a set of constraint definitions if it exists, otherwise an emptyXSNamedMap
.Deprecated.Use getValueConstraintValue().getListValueTypes() insteadboolean
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.short
getScope()
[scope].[substitution group affiliation]: a top-level element definition if it exists, otherwisenull
.short
[substitution group exclusions]: the returned value is a bit combination of the subset of {DERIVATION_EXTENSION, DERIVATION_RESTRICTION
} orDERIVATION_NONE
.[type definition]: either a simple type definition or a complex type definition.The actual value of the default or fixed value constraint.boolean
isDisallowedSubstitution
(short disallowed) Convenience method that checks ifdisallowed
is a disallowed substitution for this element declaration.boolean
isSubstitutionGroupExclusion
(short exclusion) Convenience method that checks ifexclusion
is a substitution group exclusion for this element declaration.Methods inherited from interface org.apache.jena.ext.xerces.xs.XSObject
getName, getNamespace, getNamespaceItem, getType
-
Method Details
-
getTypeDefinition
XSTypeDefinition getTypeDefinition()[type definition]: either a simple type definition or a complex type definition. -
getScope
short getScope()[scope]. One ofSCOPE_GLOBAL
,SCOPE_LOCAL
, orSCOPE_ABSENT
. If the scope is local, then theenclosingCTDefinition
is present. -
getEnclosingCTDefinition
XSComplexTypeDefinition getEnclosingCTDefinition()The complex type definition for locally scoped declarations (seescope
), otherwisenull
if no such definition exists. -
getConstraintType
short getConstraintType()[Value constraint]: one ofVC_NONE, VC_DEFAULT, VC_FIXED
. -
getConstraintValue
Deprecated.Use getValueConstraintValue().getNormalizedValue() instead[Value constraint]: the constraint value with respect to the [type definition], otherwisenull
. -
getActualVC
Deprecated.Use getValueConstraintValue().getActualValue() insteadValue 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.
-
getActualVCType
Deprecated.Use getValueConstraintValue().getActualValueType() insteadThe 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.
-
getItemValueTypes
Deprecated.Use getValueConstraintValue().getListValueTypes() insteadIn 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.
-
getValueConstraintValue
XSValue getValueConstraintValue()The actual value of the default or fixed value constraint. -
getNillable
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. -
getIdentityConstraints
XSNamedMap getIdentityConstraints()identity-constraint definitions: a set of constraint definitions if it exists, otherwise an emptyXSNamedMap
. -
getSubstitutionGroupAffiliation
XSElementDeclaration getSubstitutionGroupAffiliation()[substitution group affiliation]: a top-level element definition if it exists, otherwisenull
. -
isSubstitutionGroupExclusion
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.
-
getSubstitutionGroupExclusions
short getSubstitutionGroupExclusions()[substitution group exclusions]: the returned value is a bit combination of the subset of {DERIVATION_EXTENSION, DERIVATION_RESTRICTION
} orDERIVATION_NONE
. -
isDisallowedSubstitution
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.
-
getDisallowedSubstitutions
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
. -
getAbstract
boolean getAbstract(){abstract} A boolean. -
getAnnotation
XSAnnotation getAnnotation()An annotation if it exists, otherwisenull
. If not null then the first [annotation] from the sequence of annotations. -
getAnnotations
XSObjectList getAnnotations()A sequence of [annotations] or an emptyXSObjectList
.
-