net.sf.saxon.type
Interface ComplexType

All Superinterfaces:

SchemaComponent, SchemaType, java.io.Serializable

All Known Implementing Classes:

AnyType, Untyped, UserComplexType

public interface ComplexType

extends SchemaType

A complex type as defined in XML Schema: either a user-defined complex type, or xs:anyType. In the non-schema-aware version of the Saxon product, the only complex type encountered is xs:anyType.

Field Summary

Fields inherited from interface net.sf.saxon.type.SchemaType

DERIVATION_EXTENSION, DERIVATION_LIST, DERIVATION_RESTRICTION, DERIVATION_UNION, DERIVE_BY_SUBSTITUTION

Fields inherited from interface net.sf.saxon.type.SchemaComponent

FIXED_UP, INCOMPLETE, INVALID, UNVALIDATED, VALIDATED, VALIDATING

Method Summary

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) 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) 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 compositor
boolean	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
java.lang.String	subsumes(ComplexType sub) Test whether this complex type subsumes another complex type.

Methods inherited from interface net.sf.saxon.type.SchemaType

allowsDerivation, analyzeContentExpression, atomize, getBaseType, getBlock, getDerivationMethod, getDescription, getDisplayName, getFingerprint, getNameCode, getTypedValue, isComplexType, isSameType, isSimpleType, isTypeDerivationOK

Methods inherited from interface net.sf.saxon.type.SchemaComponent

getValidationStatus

Method Detail

isAbstract

public boolean isAbstract()

Test whether this complex type has been marked as abstract.

Returns:

true if this complex type is abstract.

isComplexContent

public boolean isComplexContent()

Test whether this complex type has complex content

Returns:

true if this complex type has a complex content model, false if it has a simple content model

isSimpleContent

public boolean isSimpleContent()

Test whether this complexType has simple content

Returns:

true if this complex type has a simple content model, false if it has a complex content model

isAllContent

public boolean isAllContent()

Test whether this complex type has "all" content, that is, a content model using an xs:all compositor

getSimpleContentType

public SimpleType getSimpleContentType()

Get the simple content type

Returns:

For a complex type with simple content, returns the simple type of the content. Otherwise, returns null.

isRestricted

public boolean isRestricted()

Test whether this complex type is derived by restriction

Returns:

true if this complex type is derived by restriction

isEmptyContent

public boolean isEmptyContent()

Test whether the content model of this complex type is empty

Returns:

true if the content model is defined as empty

isEmptiable

public boolean isEmptiable()
                    throws SchemaException,
                           ValidationException

Test whether the content model of this complex type allows empty content

Returns:

true if empty content is valid

Throws:

SchemaException

ValidationException

isMixedContent

public boolean isMixedContent()

Test whether this complex type allows mixed content

Returns:

true if mixed content is allowed

subsumes

public java.lang.String subsumes(ComplexType sub)
                          throws ValidationException

Test whether this complex type subsumes another complex type. The algorithm used is as published by Thompson and Tobin, XML Europe 2003.

Parameters:

sub - the other type (the type that is derived by restriction, validly or otherwise)

Returns:

null indicating that this type does indeed subsume the other; or a string indicating why it doesn't.

Throws:

ValidationException

getElementParticleType

public SchemaType getElementParticleType(int fingerprint)
                                  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 model

Throws:

SchemaException

ValidationException

getElementParticleCardinality

public int getElementParticleCardinality(int fingerprint)
                                  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 of StaticProperty.EXACTLY_ONE, StaticProperty.ALLOWS_ZERO_OR_ONE, StaticProperty.ALLOWS_ZERO_OR_MORE, StaticProperty.ALLOWS_ONE_OR_MORE, If there is no such particle, return zero.

Parameters:

fingerprint - Identifies the name of the child element within this content model

Throws:

SchemaException

ValidationException

getAttributeUseType

public 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

Throws:

SchemaException

ValidationException