Package net.sf.saxon.type
Class AnyType
- java.lang.Object
-
- net.sf.saxon.type.AnyType
-
- All Implemented Interfaces:
java.io.Serializable
,ComplexType
,SchemaComponent
,SchemaType
public final class AnyType extends java.lang.Object implements ComplexType, java.io.Serializable
This class has a singleton instance which represents the XML Schema built-in type xs:anyType, also known as the urtype.- See Also:
- Serialized Form
-
-
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 Static Methods Instance Methods Concrete 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.boolean
allowsDerivation(int derivation)
Determines whether derivation (of a particular kind) from this type is allowed, based on the "final" propertyvoid
analyzeContentExpression(Expression expression, int kind, StaticContext env)
Analyze an expression to see whether the expression is capable of delivering a value of this type.Value
atomize(NodeInfo node)
Get the typed value of a node that is annotated with this schema type.void
checkTypeDerivationIsOK(SchemaType type, int block)
Check that this type is validly derived from a given typevoid
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.SchemaType
getBaseType()
Get the base typeint
getBlock()
Returns the value of the 'block' attribute for this type, as a bit-signnificant integer with fields such asSchemaType.DERIVATION_LIST
andSchemaType.DERIVATION_EXTENSION
int
getDerivationMethod()
Gets the integer code of the derivation method used to derive this type from its parent.java.lang.String
getDescription()
Get a description of this type for use in diagnosticsjava.lang.String
getDisplayName()
Get the display name of the type: that is, a lexical QName with an arbitrary prefixint
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.int
getFingerprint()
Get the fingerprint of the name of this typestatic AnyType
getInstance()
Get the singular instance of this classSchemaType
getKnownBaseType()
Returns the base type that this type inherits from.java.lang.String
getName()
Get the local name of this typeint
getNameCode()
Get the namecode of the name of this type.SimpleType
getSimpleContentType()
For a complex type with simple content, return the simple type of the content.java.lang.String
getSystemId()
Get the URI of the schema document containing the definition of this typejava.lang.String
getTargetNamespace()
Get the target namespace of this typeSequenceIterator
getTypedValue(NodeInfo node)
Get the typed value of a node that is annotated with this schema typeint
getValidationStatus()
Get the validation status - always validboolean
isAbstract()
Test whether this ComplexType 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
isAnonymousType()
Test whether this is an anonymous typeboolean
isAtomicType()
Test whether this SchemaType is an atomic typeboolean
isComplexContent()
Test whether this complex type has complex contentboolean
isComplexType()
Test whether this SchemaType is a complex typeboolean
isEmptiable()
Test whether the content model of this complexType allows empty contentboolean
isEmptyContent()
Test whether the content type of this complex type is emptyboolean
isMixedContent()
Test whether this complex type allows mixed contentboolean
isRestricted()
Test whether this complex type is derived by restrictionboolean
isSameType(SchemaType other)
Test whether this is the same type as another type.boolean
isSimpleContent()
Test whether this complex type has simple contentboolean
isSimpleType()
Test whether this SchemaType is a simple type
-
-
-
Method Detail
-
getInstance
public static AnyType getInstance()
Get the singular instance of this class- Returns:
- the singular object representing xs:anyType
-
getName
public java.lang.String getName()
Get the local name of this type- Specified by:
getName
in interfaceSchemaType
- Returns:
- the local name of this type definition, if it has one. Return null in the case of an anonymous type.
-
getTargetNamespace
public java.lang.String getTargetNamespace()
Get the target namespace of this type- Specified by:
getTargetNamespace
in interfaceSchemaType
- 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.
-
getValidationStatus
public int getValidationStatus()
Get the validation status - always valid- Specified by:
getValidationStatus
in interfaceSchemaComponent
- Returns:
- one of the values
SchemaComponent.UNVALIDATED
,SchemaComponent.VALIDATING
,SchemaComponent.VALIDATED
,SchemaComponent.INVALID
,SchemaComponent.INCOMPLETE
-
getBaseType
public SchemaType getBaseType()
Get the base type- Specified by:
getBaseType
in interfaceSchemaType
- Returns:
- null (this is the root of the type hierarchy)
-
getKnownBaseType
public SchemaType getKnownBaseType() throws java.lang.IllegalStateException
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:
java.lang.IllegalStateException
- if this type is not valid.
-
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.- Specified by:
getDerivationMethod
in interfaceSchemaType
- Returns:
- a numeric code representing the derivation method, for example
SchemaType.DERIVATION_RESTRICTION
-
allowsDerivation
public boolean allowsDerivation(int derivation)
Determines whether derivation (of a particular kind) from this type is allowed, based on the "final" property- Specified by:
allowsDerivation
in interfaceSchemaType
- Parameters:
derivation
- the kind of derivation, for exampleSchemaType.DERIVATION_LIST
- Returns:
- true if this kind of derivation is allowed
-
isAbstract
public boolean isAbstract()
Test whether this ComplexType has been marked as abstract.- Specified by:
isAbstract
in interfaceComplexType
- Returns:
- false: this class is not abstract.
-
isComplexType
public boolean isComplexType()
Test whether this SchemaType is a complex type- Specified by:
isComplexType
in interfaceSchemaType
- Returns:
- true if this SchemaType is a complex type
-
isAnonymousType
public boolean isAnonymousType()
Test whether this is an anonymous type- Specified by:
isAnonymousType
in interfaceSchemaType
- Returns:
- true if this SchemaType is an anonymous type
-
isSimpleType
public boolean isSimpleType()
Test whether this SchemaType is a simple type- Specified by:
isSimpleType
in interfaceSchemaType
- Returns:
- true if this SchemaType is a simple type
-
isAtomicType
public boolean isAtomicType()
Test whether this SchemaType is an atomic type- Specified by:
isAtomicType
in interfaceSchemaType
- Returns:
- true if this SchemaType is an atomic type
-
getBlock
public int getBlock()
Returns the value of the 'block' attribute for this type, as a bit-signnificant integer with fields such asSchemaType.DERIVATION_LIST
andSchemaType.DERIVATION_EXTENSION
- Specified by:
getBlock
in interfaceSchemaType
- Returns:
- the value of the 'block' attribute for this type
-
isComplexContent
public boolean isComplexContent()
Test whether this complex type has complex content- Specified by:
isComplexContent
in interfaceComplexType
- Returns:
- true: this complex type has complex content
-
isSimpleContent
public boolean isSimpleContent()
Test whether this complex type has simple content- Specified by:
isSimpleContent
in interfaceComplexType
- Returns:
- false: this complex type has complex content
-
isAllContent
public boolean isAllContent()
Test whether this complex type has "all" content, that is, a content model using an xs:all compositor- Specified by:
isAllContent
in interfaceComplexType
- Returns:
- false: this complex type does not use an "all" compositor
-
getSimpleContentType
public SimpleType getSimpleContentType()
For a complex type with simple content, return the simple type of the content. Otherwise, return null.- Specified by:
getSimpleContentType
in interfaceComplexType
- Returns:
- null: this complex type does not have simple content
-
isRestricted
public boolean isRestricted()
Test whether this complex type is derived by restriction- Specified by:
isRestricted
in interfaceComplexType
- Returns:
- false: this type is not a restriction
-
isEmptyContent
public boolean isEmptyContent()
Test whether the content type of this complex type is empty- Specified by:
isEmptyContent
in interfaceComplexType
- Returns:
- false: the content model is not empty
-
isEmptiable
public boolean isEmptiable()
Test whether the content model of this complexType allows empty content- Specified by:
isEmptiable
in interfaceComplexType
- Returns:
- true: the content is allowed to be empty
-
isMixedContent
public boolean isMixedContent()
Test whether this complex type allows mixed content- Specified by:
isMixedContent
in interfaceComplexType
- Returns:
- true: mixed content is allowed
-
getFingerprint
public int getFingerprint()
Get the fingerprint of the name of this type- Specified by:
getFingerprint
in interfaceSchemaType
- Returns:
- the fingerprint.
-
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.- Specified by:
getNameCode
in interfaceSchemaType
- Returns:
- the namecode. Returns an invented namecode for an anonymous type.
-
getDescription
public java.lang.String getDescription()
Get a description of this type for use in diagnostics- Specified by:
getDescription
in interfaceSchemaType
- Returns:
- the string "xs:anyType"
-
getDisplayName
public java.lang.String getDisplayName()
Get the display name of the type: that is, a lexical QName with an arbitrary prefix- Specified by:
getDisplayName
in interfaceSchemaType
- Returns:
- a lexical QName identifying the type
-
getSystemId
public java.lang.String getSystemId()
Get the URI of the schema document containing the definition of this type- Specified by:
getSystemId
in interfaceSchemaType
- Returns:
- null for a built-in type
-
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)- Specified by:
isSameType
in interfaceSchemaType
- Parameters:
other
- the other type- Returns:
- true if this is the same type as other
-
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.- Specified by:
analyzeContentExpression
in interfaceSchemaType
- Parameters:
expression
- the expression that delivers the contentkind
- the node kind whose content is being delivered:Type.ELEMENT
,Type.ATTRIBUTE
, orType.DOCUMENT
env
-
-
getTypedValue
public SequenceIterator getTypedValue(NodeInfo node)
Get the typed value of a node that is annotated with this schema type- Specified by:
getTypedValue
in interfaceSchemaType
- 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.
-
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 methodgetTypedValue(net.sf.saxon.om.NodeInfo)
. 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.- Specified by:
atomize
in interfaceSchemaType
- Parameters:
node
- the node whose typed value is required- Returns:
- the typed value.
- Since:
- 8.5
-
checkTypeDerivationIsOK
public void checkTypeDerivationIsOK(SchemaType type, int block) throws SchemaException
Check that this type is validly derived from a given type- Specified by:
checkTypeDerivationIsOK
in interfaceSchemaType
- Parameters:
type
- the type from which this type is derivedblock
- the derivations that are blocked by the relevant element declaration- Throws:
SchemaException
- if the derivation is not allowed
-
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.- Specified by:
getElementParticleType
in interfaceComplexType
- 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.
-
getElementParticleCardinality
public 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. 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, return zero.- Specified by:
getElementParticleCardinality
in interfaceComplexType
- 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
.
-
getAttributeUseType
public 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. 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.- Specified by:
getAttributeUseType
in interfaceComplexType
- 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.
-
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.- Specified by:
allowsAttributes
in interfaceComplexType
- Returns:
- true if attributes are allowed
-
gatherAllPermittedChildren
public 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.- Specified by:
gatherAllPermittedChildren
in interfaceComplexType
- 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
public 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), return null.- Specified by:
gatherAllPermittedDescendants
in interfaceComplexType
- 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
-
-