Package net.sf.saxon.type
Interface ComplexType
-
- All Superinterfaces:
SchemaComponent
,SchemaType
,java.io.Serializable
public interface ComplexType extends SchemaType
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
-
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
All Methods Instance Methods Abstract Methods Modifier and Type Method Description 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.void
gatherAllPermittedChildren(IntHashSet children)
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.SchemaType
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
getElementParticleCardinality(int fingerprint, boolean searchExtensionTypes)
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.SchemaType
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.SimpleType
getSimpleContentType()
Get the simple content type.boolean
isAbstract()
Test whether this complex type has been marked as abstract.boolean
isAllContent()
Test whether this complex type has "all" content, that is, a content model using an xs:all compositorboolean
isComplexContent()
Test whether this complex type has complex content.boolean
isEmptiable()
Test whether the content model of this complex type allows empty content.boolean
isEmptyContent()
Test whether the content model of this complex type is empty.boolean
isMixedContent()
Test whether this complex type allows mixed content.boolean
isRestricted()
Test whether this complex type is derived by restriction.boolean
isSimpleContent()
Test whether this complexType has simple content.-
Methods inherited from interface net.sf.saxon.type.SchemaComponent
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, isSameType, isSimpleType
-
-
-
-
Method Detail
-
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 this complex type has a complex content model, false if it has a simple content model
-
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 this complex type has a simple content model, false if it has a complex content model
-
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
boolean isEmptiable() throws SchemaException
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 searchExtensionTypes) 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 modelsearchExtensionTypes
-- 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
SchemaType getAttributeUseType(int fingerprint) throws SchemaException, ValidationException
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
ValidationException
-
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 are allowed
-
gatherAllPermittedChildren
void gatherAllPermittedChildren(IntHashSet children) 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 should be ignored.- Throws:
SchemaException
-
gatherAllPermittedDescendants
void gatherAllPermittedDescendants(IntHashSet descendants) throws SchemaException
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
-
-