Package net.sf.saxon.type
Class Untyped
java.lang.Object
net.sf.saxon.type.Untyped
- All Implemented Interfaces:
Serializable
,ComplexType
,SchemaComponent
,SchemaType
This class has a singleton instance which represents the complex type xdt:untyped,
used for elements that have not been validated.
- See Also:
-
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
Modifier and TypeMethodDescriptionboolean
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.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 typegetAttributeUseType
(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.Returns the base type that this type inherits from.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
int
Gets the integer code of the derivation method used to derive this type from its parent.Get a description of this type for use in diagnosticsGet the display name of the type: that is, a lexical QName with an arbitrary prefixint
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.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.int
Get the fingerprint of the name of this typestatic Untyped
Get the singular instance of this classReturns the base type that this type inherits from.int
Get the namecode of the name of this type.For a complex type with simple content, return the simple type of the content.getTypedValue
(NodeInfo node) Get the typed value of a node that is annotated with this schema typeint
Get the validation status - always validboolean
Test whether this ComplexType 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 is an anonymous typeboolean
Test whether this SchemaType is an atomic typeboolean
Test whether this complex type has complex contentboolean
Test whether this SchemaType is a complex typeboolean
Test whether the content model of this complexType allows empty contentboolean
Test whether the content type of this complex type is emptyboolean
Test whether this complex type allows mixed contentboolean
Test whether this complex type is derived by restrictionboolean
isSameType
(SchemaType other) Test whether this is the same type as another type.boolean
Test whether this complex type has simple contentboolean
Test whether this SchemaType is a simple typesubsumes
(ComplexType sub) Test whether this complex type subsumes another complex type.
-
Method Details
-
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
-
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
-
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
-
checkTypeDerivationIsOK
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
-
getFingerprint
public int getFingerprint()Get the fingerprint of the name of this type- Specified by:
getFingerprint
in interfaceSchemaType
- Returns:
- the fingerprint. Returns an invented fingerprint for 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.- Specified by:
getNameCode
in interfaceSchemaType
-
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
-
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
-
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.
-
isSameType
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
-
getBaseType
Returns the base type that this type inherits from. If this type is a Simpletype that is a built in primitive type then null is returned.- Specified by:
getBaseType
in interfaceSchemaType
- Returns:
- the base type.
-
getInstance
Get the singular instance of this class- Returns:
- the singular object representing xs:anyType
-
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.
-
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
-
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
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:
- true: this type is treated as a restriction of xs:anyType
-
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
-
getDescription
Get a description of this type for use in diagnostics- Specified by:
getDescription
in interfaceSchemaType
- Returns:
- the string "xs:anyType"
-
analyzeContentExpression
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
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
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
-
subsumes
Test whether this complex type subsumes another complex type. The algorithm used is as published by Thompson and Tobin, XML Europe 2003.- Specified by:
subsumes
in interfaceComplexType
- 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.
-
getElementParticleType
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 model
-
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 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 model
-
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.- Specified by:
getAttributeUseType
in interfaceComplexType
- Parameters:
fingerprint
- Identifies the name of the child element within this content model
-