net.sf.saxon.type

Class AnyType

public final class AnyType extends Object implements ComplexType, Serializable

This class has a singleton instance which represents the XML Schema built-in type xs:anyType, also known as the urtype. See XML Schema 1.1 Part 1 section 3.4.7
Method Summary
booleanallowsAttributes()
Return true if this type (or any known type derived from it by extension) allows the element to have one or more attributes.
booleanallowsDerivation(int derivation)
Determines whether derivation (of a particular kind) from this type is allowed, based on the "final" property
voidanalyzeContentExpression(Expression expression, int kind, StaticContext env)
Analyze an expression to see whether the expression is capable of delivering a value of this type.
Valueatomize(NodeInfo node)
Get the typed value of a node that is annotated with this schema type.
voidcheckTypeDerivationIsOK(SchemaType type, int block)
Check that this type is validly derived from a given type
booleancontainsElementWildcard()
Ask whether this type (or any known type derived from it by extension) allows the element to have children that match a wildcard
voidgatherAllPermittedChildren(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.
voidgatherAllPermittedDescendants(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.
SimpleTypegetAttributeUseType(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.
SchemaTypegetBaseType()
Get the base type
intgetBlock()
Returns the value of the 'block' attribute for this type, as a bit-signnificant integer with fields such as DERIVATION_LIST and DERIVATION_EXTENSION
intgetDerivationMethod()
Gets the integer code of the derivation method used to derive this type from its parent.
StringgetDescription()
Get a description of this type for use in diagnostics
StringgetDisplayName()
Get the display name of the type: that is, a lexical QName with an arbitrary prefix
intgetElementParticleCardinality(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.
SchemaTypegetElementParticleType(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.
intgetFingerprint()
Get the fingerprint of the name of this type
static AnyTypegetInstance()
Get the singular instance of this class
SchemaTypegetKnownBaseType()
Returns the base type that this type inherits from.
StringgetName()
Get the local name of this type
intgetNameCode()
Get the namecode of the name of this type.
intgetRedefinitionLevel()
Get the redefinition level.
SimpleTypegetSimpleContentType()
For a complex type with simple content, return the simple type of the content.
StringgetSystemId()
Get the URI of the schema document containing the definition of this type
StringgetTargetNamespace()
Get the target namespace of this type
SequenceIteratorgetTypedValue(NodeInfo node)
Get the typed value of a node that is annotated with this schema type
intgetValidationStatus()
Get the validation status - always valid
intgetVariety()
Get the variety of this complex type.
booleanisAbstract()
Test whether this ComplexType has been marked as abstract.
booleanisAllContent()
Test whether this complex type has "all" content, that is, a content model using an xs:all compositor
booleanisAnonymousType()
Test whether this is an anonymous type
booleanisAtomicType()
Test whether this SchemaType is an atomic type
booleanisComplexContent()
Test whether this complex type has complex content
booleanisComplexType()
Test whether this SchemaType is a complex type
booleanisEmptiable()
Test whether the content model of this complexType allows empty content
booleanisEmptyContent()
Test whether the content type of this complex type is empty
booleanisIdRefType()
Ask whether this type is an IDREF or IDREFS type.
booleanisIdType()
Ask whether this type is an ID type.
booleanisMixedContent()
Test whether this complex type allows mixed content
booleanisRestricted()
Test whether this complex type is derived by restriction
booleanisSameType(SchemaType other)
Test whether this is the same type as another type.
booleanisSimpleContent()
Test whether this complex type has simple content
booleanisSimpleType()
Test whether this SchemaType is a simple type

Method Detail

allowsAttributes

public 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

allowsDerivation

public boolean allowsDerivation(int derivation)
Determines whether derivation (of a particular kind) from this type is allowed, based on the "final" property

Parameters: derivation the kind of derivation, for example DERIVATION_LIST

Returns: true if this kind of derivation is allowed

analyzeContentExpression

public void analyzeContentExpression(Expression expression, int kind, StaticContext env)
Analyze an expression to see whether the expression is capable of delivering a value of this type.

Parameters: expression the expression that delivers the content kind the node kind whose content is being delivered: ELEMENT, ATTRIBUTE, or DOCUMENT env

atomize

public Value atomize(NodeInfo node)
Get the typed value of a node that is annotated with this schema type. The result of this method will always be consistent with the method AnyType. However, this method is often more convenient and may be more efficient, especially in the common case where the value is expected to be a singleton.

Parameters: node the node whose typed value is required

Returns: the typed value.

Since: 8.5

checkTypeDerivationIsOK

public void checkTypeDerivationIsOK(SchemaType type, int block)
Check that this type is validly derived from a given type

Parameters: type the type from which this type is derived block the derivations that are blocked by the relevant element declaration

Throws: SchemaException if the derivation is not allowed

containsElementWildcard

public 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

gatherAllPermittedChildren

public 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. 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.

gatherAllPermittedDescendants

public 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. If the list is unbounded (because of wildcards or the use of xs:anyType), return null.

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.

getAttributeUseType

public SimpleType 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. 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.

Parameters: fingerprint Identifies the name of the child element within this content model

getBaseType

public SchemaType getBaseType()
Get the base type

Returns: null (this is the root of the type hierarchy)

getBlock

public int getBlock()
Returns the value of the 'block' attribute for this type, as a bit-signnificant integer with fields such as DERIVATION_LIST and DERIVATION_EXTENSION

Returns: the value of the 'block' attribute for this type

getDerivationMethod

public int getDerivationMethod()
Gets the integer code of the derivation method used to derive this type from its parent. Returns zero for primitive types.

Returns: a numeric code representing the derivation method, for example DERIVATION_RESTRICTION

getDescription

public String getDescription()
Get a description of this type for use in diagnostics

Returns: the string "xs:anyType"

getDisplayName

public String getDisplayName()
Get the display name of the type: that is, a lexical QName with an arbitrary prefix

Returns: a lexical QName identifying the type

getElementParticleCardinality

public 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. The value is one of EXACTLY_ONE, ALLOWS_ZERO_OR_ONE, ALLOWS_ZERO_OR_MORE, 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

getElementParticleType

public 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. 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 considerExtensions

getFingerprint

public int getFingerprint()
Get the fingerprint of the name of this type

Returns: the fingerprint.

getInstance

public static AnyType getInstance()
Get the singular instance of this class

Returns: the singular object representing xs:anyType

getKnownBaseType

public SchemaType getKnownBaseType()
Returns the base type that this type inherits from. This method can be used to get the base type of a type that is known to be valid. If this type is a Simpletype that is a built in primitive type then null is returned.

Returns: the base type.

Throws: IllegalStateException if this type is not valid.

getName

public String getName()
Get the local name of this type

Returns: the local name of this type definition, if it has one. Return null in the case of an anonymous type.

getNameCode

public int getNameCode()
Get the namecode of the name of this type. This includes the prefix from the original type declaration: in the case of built-in types, there may be a conventional prefix or there may be no prefix.

getRedefinitionLevel

public int getRedefinitionLevel()
Get the redefinition level. This is zero for a component that has not been redefined; for a redefinition of a level-0 component, it is 1; for a redefinition of a level-N component, it is N+1. This concept is used to support the notion of "pervasive" redefinition: if a component is redefined at several levels, the top level wins, but it is an error to have two versions of the component at the same redefinition level.

Returns: the redefinition level

getSimpleContentType

public SimpleType getSimpleContentType()
For a complex type with simple content, return the simple type of the content. Otherwise, return null.

Returns: null: this complex type does not have simple content

getSystemId

public String getSystemId()
Get the URI of the schema document containing the definition of this type

Returns: null for a built-in type

getTargetNamespace

public String getTargetNamespace()
Get the target namespace of this type

Returns: the target namespace of this type definition, if it has one. Return null in the case of an anonymous type, and in the case of a global type defined in a no-namespace schema.

getTypedValue

public SequenceIterator getTypedValue(NodeInfo node)
Get the typed value of a node that is annotated with this schema type

Parameters: node the node whose typed value is required

Returns: an iterator returning a single untyped atomic value, equivalent to the string value of the node. This follows the standard rules for elements with mixed content.

getValidationStatus

public int getValidationStatus()
Get the validation status - always valid

getVariety

public int getVariety()
Get the variety of this complex type. This will be one of the values AnyType, AnyType, AnyType, or AnyType

isAbstract

public boolean isAbstract()
Test whether this ComplexType has been marked as abstract.

Returns: false: this class is not abstract.

isAllContent

public boolean isAllContent()
Test whether this complex type has "all" content, that is, a content model using an xs:all compositor

Returns: false: this complex type does not use an "all" compositor

isAnonymousType

public boolean isAnonymousType()
Test whether this is an anonymous type

Returns: true if this SchemaType is an anonymous type

isAtomicType

public boolean isAtomicType()
Test whether this SchemaType is an atomic type

Returns: true if this SchemaType is an atomic type

isComplexContent

public boolean isComplexContent()
Test whether this complex type has complex content

Returns: true: this complex type has complex content

isComplexType

public boolean isComplexType()
Test whether this SchemaType is a complex type

Returns: true if this SchemaType is a complex type

isEmptiable

public boolean isEmptiable()
Test whether the content model of this complexType allows empty content

Returns: true: the content is allowed to be empty

isEmptyContent

public boolean isEmptyContent()
Test whether the content type of this complex type is empty

Returns: false: the content model is not empty

isIdRefType

public boolean isIdRefType()
Ask whether this type is an IDREF or IDREFS type. This is defined to be any simple type who typed value may contain atomic values of type xs:IDREF: that is, it includes types derived from IDREF or IDREFS by restriction, list, or union

isIdType

public boolean isIdType()
Ask whether this type is an ID type. This is defined to be any simple type who typed value may contain atomic values of type xs:ID: that is, it includes types derived from ID by restriction, list, or union. Note that for a node to be treated as an ID, its typed value must be a *single* atomic value of type ID; the type of the node, however, can still allow a list.

isMixedContent

public boolean isMixedContent()
Test whether this complex type allows mixed content

Returns: true: mixed content is allowed

isRestricted

public boolean isRestricted()
Test whether this complex type is derived by restriction

Returns: false: this type is not a restriction

isSameType

public boolean isSameType(SchemaType other)
Test whether this is the same type as another type. They are considered to be the same type if they are derived from the same type definition in the original XML representation (which can happen when there are multiple includes of the same file)

isSimpleContent

public boolean isSimpleContent()
Test whether this complex type has simple content

Returns: false: this complex type has complex content

isSimpleType

public boolean isSimpleType()
Test whether this SchemaType is a simple type

Returns: true if this SchemaType is a simple type