Package net.sf.saxon.type
Interface ComplexType
- All Superinterfaces:
SchemaComponent
,SchemaType
,Serializable
A complex type as defined in XML Schema: either a user-defined complex type, or xs:anyType, or xs:untyped.
In the non-schema-aware version of the Saxon product, the only complex type encountered is xs:untyped.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
Fields inherited from interface net.sf.saxon.type.SchemaComponent
FIXED_UP, INCOMPLETE, INVALID, UNVALIDATED, VALIDATED, VALIDATING
Fields inherited from interface net.sf.saxon.type.SchemaType
DERIVATION_EXTENSION, DERIVATION_LIST, DERIVATION_RESTRICTION, DERIVATION_UNION, DERIVE_BY_SUBSTITUTION
-
Method Summary
Modifier and TypeMethodDescriptionboolean
Return true if this type (or any known type derived from it by extension) allows the element to have one or more attributes.boolean
Ask whether this type (or any known type derived from it by extension) allows the element to have children that match a wildcardvoid
gatherAllPermittedChildren
(IntHashSet children, boolean ignoreWildcards) Get a list of all the names of elements that can appear as children of an element having this complex type, as integer fingerprints.void
gatherAllPermittedDescendants
(IntHashSet descendants) Get a list of all the names of elements that can appear as descendants of an element having this complex type, as integer fingerprints.int
getAttributeUseCardinality
(int fingerprint) Find an attribute use within this complex type definition having a given attribute name (identified by fingerprint), and return the cardinality associated with that attribute, which will always be 0, 1, or 0-or-1.getAttributeUseType
(int fingerprint) Find an attribute use within this complex type definition having a given attribute name (identified by fingerprint), and return the schema type associated with that attribute.int
getDescendantElementCardinality
(int fingerprint) Assuming an element is a permitted descendant in the content model of this type, determine the cardinality of the element when it appears as a descendant.getDescendantElementType
(int fingerprint) Assuming an element is a permitted descendant in the content model of this type, determine the type of the element when it appears as a descendant.int
getElementParticleCardinality
(int fingerprint, boolean considerExtensions) Find an element particle within this complex type definition having a given element name (identified by fingerprint), and return the cardinality associated with that element particle, that is, the number of times the element can occur within this complex type.getElementParticleType
(int fingerprint, boolean considerExtensions) Find an element particle within this complex type definition having a given element name (identified by fingerprint), and return the schema type associated with that element particle.Get the simple content type.int
Get the variety of this complex type.boolean
Test whether this complex type has been marked as abstract.boolean
Test whether this complex type has "all" content, that is, a content model using an xs:all compositorboolean
Test whether this complex type has complex content.boolean
Test whether the content model of this complex type allows empty content.boolean
Test whether the content model of this complex type is empty.boolean
Test whether this complex type allows mixed content.boolean
Test whether this complex type is derived by restriction.boolean
Test whether this complexType has simple content.Methods inherited from interface net.sf.saxon.type.SchemaComponent
getRedefinitionLevel, getValidationStatus
Methods inherited from interface net.sf.saxon.type.SchemaType
allowsDerivation, analyzeContentExpression, atomize, checkTypeDerivationIsOK, getBaseType, getBlock, getDerivationMethod, getDescription, getDisplayName, getFingerprint, getName, getNameCode, getSystemId, getTargetNamespace, getTypedValue, isAnonymousType, isAtomicType, isComplexType, isIdRefType, isIdType, isSameType, isSimpleType
-
Field Details
-
VARIETY_EMPTY
static final int VARIETY_EMPTY- See Also:
-
VARIETY_SIMPLE
static final int VARIETY_SIMPLE- See Also:
-
VARIETY_ELEMENT_ONLY
static final int VARIETY_ELEMENT_ONLY- See Also:
-
VARIETY_MIXED
static final int VARIETY_MIXED- See Also:
-
OPEN_CONTENT_ABSENT
static final int OPEN_CONTENT_ABSENT- See Also:
-
OPEN_CONTENT_NONE
static final int OPEN_CONTENT_NONE- See Also:
-
OPEN_CONTENT_INTERLEAVE
static final int OPEN_CONTENT_INTERLEAVE- See Also:
-
OPEN_CONTENT_SUFFIX
static final int OPEN_CONTENT_SUFFIX- See Also:
-
-
Method Details
-
getVariety
int getVariety()Get the variety of this complex type. This will be one of the valuesVARIETY_EMPTY
,VARIETY_MIXED
,VARIETY_SIMPLE
, orVARIETY_ELEMENT_ONLY
-
isAbstract
boolean isAbstract()Test whether this complex type has been marked as abstract. This corresponds to the {abstract} property in the schema component model.- Returns:
- true if this complex type is abstract.
-
isComplexContent
boolean isComplexContent()Test whether this complex type has complex content. This represents one aspect of the {content type} property in the schema component model.- Returns:
- true if and only if this complex type has a complex content model, that is, if its variety is one of empty, mixed, or element-only.
-
isSimpleContent
boolean isSimpleContent()Test whether this complexType has simple content. This represents one aspect of the {content type} property in the schema component model.- Returns:
- true if and only if this complex type has a simple content model, that is, if its variety is simple.
-
isAllContent
boolean isAllContent()Test whether this complex type has "all" content, that is, a content model using an xs:all compositor- Returns:
- true if the type has an "all" content model
-
getSimpleContentType
SimpleType getSimpleContentType()Get the simple content type. This represents one aspect of the {content type} property in the schema component model.- Returns:
- For a complex type with simple content, returns the simple type of the content. Otherwise, returns null.
-
isRestricted
boolean isRestricted()Test whether this complex type is derived by restriction. This corresponds to one aspect of the {derivation method} property in the schema component model.- Returns:
- true if this complex type is derived by restriction
-
isEmptyContent
boolean isEmptyContent()Test whether the content model of this complex type is empty. This represents one aspect of the {content type} property in the schema component model.- Returns:
- true if the content model is defined as empty
-
isEmptiable
Test whether the content model of this complex type allows empty content. This property applies only if this is a complex type with complex content.- Returns:
- true if empty content is valid
- Throws:
SchemaException
-
isMixedContent
boolean isMixedContent()Test whether this complex type allows mixed content. This represents one aspect of the {content type} property in the schema component model. This property applies only if this is a complex type with complex content.- Returns:
- true if mixed content is allowed
-
getElementParticleType
SchemaType getElementParticleType(int fingerprint, boolean considerExtensions) throws SchemaException, ValidationException Find an element particle within this complex type definition having a given element name (identified by fingerprint), and return the schema type associated with that element particle. If there is no such particle, return null. If the fingerprint matches an element wildcard, return the type of the global element declaration with the given name if one exists, or AnyType if none exists and lax validation is permitted by the wildcard.- Parameters:
fingerprint
- Identifies the name of the child element within this content modelconsiderExtensions
-- Returns:
- the schema type associated with the child element particle with the given name. If there is no such particle, return null.
- Throws:
SchemaException
ValidationException
-
getElementParticleCardinality
int getElementParticleCardinality(int fingerprint, boolean considerExtensions) throws SchemaException, ValidationException Find an element particle within this complex type definition having a given element name (identified by fingerprint), and return the cardinality associated with that element particle, that is, the number of times the element can occur within this complex type. The value is one ofStaticProperty.EXACTLY_ONE
,StaticProperty.ALLOWS_ZERO_OR_ONE
,StaticProperty.ALLOWS_ZERO_OR_MORE
,StaticProperty.ALLOWS_ONE_OR_MORE
, If there is no such particle, returnStaticProperty.EMPTY
.- Parameters:
fingerprint
- Identifies the name of the child element within this content modelconsiderExtensions
-- Returns:
- the cardinality associated with the child element particle with the given name.
If there is no such particle, return
StaticProperty.EMPTY
. - Throws:
SchemaException
ValidationException
-
getAttributeUseType
Find an attribute use within this complex type definition having a given attribute name (identified by fingerprint), and return the schema type associated with that attribute. If there is no such attribute use, return null. If the fingerprint matches an attribute wildcard, return the type of the global attribute declaration with the given name if one exists, or AnySimpleType if none exists and lax validation is permitted by the wildcard.If there are types derived from this type by extension, search those too.
- Parameters:
fingerprint
- Identifies the name of the child element within this content model- Returns:
- the schema type associated with the attribute use identified by the fingerprint. If there is no such attribute use, return null.
- Throws:
SchemaException
-
getAttributeUseCardinality
Find an attribute use within this complex type definition having a given attribute name (identified by fingerprint), and return the cardinality associated with that attribute, which will always be 0, 1, or 0-or-1. If there is no such attribute use, return 0. If the fingerprint matches an attribute wildcard, return 0-or-1.If there are types derived from this type by extension, search those too.
- Parameters:
fingerprint
- Identifies the name of the child element within this content model- Returns:
- the cardinality associated with the attribute use identified by the fingerprint.
- Throws:
SchemaException
-
allowsAttributes
boolean allowsAttributes()Return true if this type (or any known type derived from it by extension) allows the element to have one or more attributes.- Returns:
- true if attributes (other than the standard xsi: attributes) are allowed. The value false indicates that only the standard attributes in the xsi namespace are permitted.
-
gatherAllPermittedChildren
void gatherAllPermittedChildren(IntHashSet children, boolean ignoreWildcards) throws SchemaException Get a list of all the names of elements that can appear as children of an element having this complex type, as integer fingerprints. If the list is unbounded (because of wildcards or the use of xs:anyType), return null.- Parameters:
children
- an integer set, initially empty, which on return will hold the fingerprints of all permitted child elements; if the result contains the value -1, this indicates that it is not possible to enumerate all the children, typically because of wildcards. In this case the other contents of the set shouldignoreWildcards
-- Throws:
SchemaException
-
gatherAllPermittedDescendants
Get a list of all the names of elements that can appear as descendants of an element having this complex type, as integer fingerprints. If the list is unbounded (because of wildcards or the use of xs:anyType), include a -1 in the result.- Parameters:
descendants
- an integer set, initially empty, which on return will hold the fingerprints of all permitted descendant elements; if the result contains the value -1, this indicates that it is not possible to enumerate all the descendants, typically because of wildcards. In this case the other contents of the set should be ignored.- Throws:
SchemaException
-
getDescendantElementType
Assuming an element is a permitted descendant in the content model of this type, determine the type of the element when it appears as a descendant. If it appears with more than one type, return xs:anyType.- Parameters:
fingerprint
- the name of the required descendant element- Returns:
- the type of the descendant element; null if the element cannot appear as a descendant; anyType if it can appear with several different types
- Throws:
SchemaException
-
getDescendantElementCardinality
Assuming an element is a permitted descendant in the content model of this type, determine the cardinality of the element when it appears as a descendant.- Parameters:
fingerprint
- the name of the required descendant element- Returns:
- the cardinality of the descendant element within this complex type
- Throws:
SchemaException
-
containsElementWildcard
boolean containsElementWildcard()Ask whether this type (or any known type derived from it by extension) allows the element to have children that match a wildcard- Returns:
- true if the content model of this type, or its extensions, contains an element wildcard
-