net.sf.saxon.type

Class AnySimpleType

Implemented Interfaces:
SchemaComponent, SchemaType, Serializable, SimpleType

public final class AnySimpleType
extends java.lang.Object
implements SimpleType

This class has a singleton instance which represents the XML Schema built-in type xs:anySimpleType

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

boolean
allowsDerivation(int derivation)
Determines whether derivation (of a particular kind) from this type is allowed, based on the "final" property
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.
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 type
SchemaType
getBaseType()
Get the base type
int
getBlock()
Returns the value of the 'block' attribute for this type, as a bit-signnificant integer with fields such as SchemaType.DERIVATION_LIST and SchemaType.DERIVATION_EXTENSION
SchemaType
getBuiltInBaseType()
Get the built-in ancestor of this type in the type hierarchy
AtomicType
getCommonAtomicType()
Get the most specific possible atomic type that all items in this SimpleType belong to
int
getDerivationMethod()
Gets the integer code of the derivation method used to derive this type from its parent.
String
getDescription()
Get a description of this type for use in diagnostics
String
getDisplayName()
Get the display name of the type: that is, a lexical QName with an arbitrary prefix
int
getFingerprint()
Get the fingerprint of the name of this type
static AnySimpleType
getInstance()
Get the singular instance of this class
SchemaType
getKnownBaseType()
Returns the base type that this type inherits from.
String
getName()
Get the local name of this type
int
getNameCode()
Get the namecode of the name of this type.
String
getSystemId()
Get the URI of the schema document containing the definition of this type
String
getTargetNamespace()
Get the target namespace of this type
SequenceIterator
getTypedValue(CharSequence value, NamespaceResolver resolver, NameChecker nameChecker)
Get the typed value corresponding to a given string value, assuming it is valid against this type
SequenceIterator
getTypedValue(NodeInfo node)
Get the typed value of a node that is annotated with this schema type.
int
getValidationStatus()
Get the validation status - always valid
int
getWhitespaceAction(TypeHierarchy th)
Determine how values of this simple type are whitespace-normalized.
boolean
isAnonymousType()
Test whether this is an anonymous type
boolean
isAtomicType()
Test whether this Simple Type is an atomic type
boolean
isBuiltInType()
Determine whether this is a built-in type or a user-defined type
boolean
isComplexType()
Test whether this SchemaType is a complex type
boolean
isExternalType()
Return true if this is an external object type, that is, a Saxon-defined type for external Java or .NET objects
boolean
isListType()
Determine whether this is a list type
boolean
isNamespaceSensitive()
Test whether this type represents namespace-sensitive content
boolean
isSameType(SchemaType other)
Test whether this is the same type as another type.
boolean
isSimpleType()
Test whether this SchemaType is a simple type
boolean
isUnionType()
Determin whether this is a union type
ValidationFailure
validateContent(CharSequence value, NamespaceResolver nsResolver, NameChecker nameChecker)
Check whether a given input string is valid according to this SimpleType

Method Details

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 interface SchemaType
Parameters:
derivation - the kind of derivation, for example SchemaType.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.
Specified by:
analyzeContentExpression in interface SchemaType
Parameters:
expression - the expression that delivers the content
kind - the node kind whose content is being delivered: Type.ELEMENT, Type.ATTRIBUTE, or Type.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 getTypedValue. 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 interface SchemaType
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 interface SchemaType
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

getBaseType

public SchemaType getBaseType()
Get the base type
Specified by:
getBaseType in interface SchemaType
Returns:
AnyType

getBlock

public int getBlock()
Specified by:
getBlock in interface SchemaType
Returns:
the value of the 'block' attribute for this type

getBuiltInBaseType

public SchemaType getBuiltInBaseType()
Get the built-in ancestor of this type in the type hierarchy
Specified by:
getBuiltInBaseType in interface SimpleType
Returns:
this type itself

getCommonAtomicType

public AtomicType getCommonAtomicType()
Get the most specific possible atomic type that all items in this SimpleType belong to
Specified by:
getCommonAtomicType in interface SimpleType
Returns:
the lowest common supertype of all member types

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 interface SchemaType
Returns:
a numeric code representing the derivation method, for example SchemaType.DERIVATION_RESTRICTION

getDescription

public String getDescription()
Get a description of this type for use in diagnostics
Specified by:
getDescription in interface SchemaType
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
Specified by:
getDisplayName in interface SchemaType
Returns:
a lexical QName identifying the type

getFingerprint

public int getFingerprint()
Get the fingerprint of the name of this type
Specified by:
getFingerprint in interface SchemaType
Returns:
the fingerprint.

getInstance

public static AnySimpleType getInstance()
Get the singular instance of this class
Returns:
the singular object representing xs:anyType

getKnownBaseType

public SchemaType getKnownBaseType()
            throws 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.
Returns:
the base type.

getName

public String getName()
Get the local name of this type
Specified by:
getName in interface SchemaType
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.
Specified by:
getNameCode in interface SchemaType

getSystemId

public String getSystemId()
Get the URI of the schema document containing the definition of this type
Specified by:
getSystemId in interface SchemaType
Returns:
null for a built-in type

getTargetNamespace

public String getTargetNamespace()
Get the target namespace of this type
Specified by:
getTargetNamespace in interface SchemaType
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(CharSequence value,
                                      NamespaceResolver resolver,
                                      NameChecker nameChecker)
Get the typed value corresponding to a given string value, assuming it is valid against this type
Specified by:
getTypedValue in interface SimpleType
Parameters:
value - the string value
resolver - a namespace resolver used to resolve any namespace prefixes appearing in the content of values. Can supply null, in which case any namespace-sensitive content will be rejected.
nameChecker -
Returns:
an iterator over the atomic sequence comprising the typed value. The objects returned by this SequenceIterator will all be of type AtomicValue

getTypedValue

public SequenceIterator getTypedValue(NodeInfo node)
Get the typed value of a node that is annotated with this schema type. This shouldn't happen: nodes are never annotated as xs:anySimpleType; but if it does happen, we treat it as if it were untypedAtomic.
Specified by:
getTypedValue in interface SchemaType
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.

getValidationStatus

public int getValidationStatus()
Get the validation status - always valid
Specified by:
getValidationStatus in interface SchemaComponent

getWhitespaceAction

public int getWhitespaceAction(TypeHierarchy th)
Determine how values of this simple type are whitespace-normalized.
Specified by:
getWhitespaceAction in interface SimpleType
Parameters:
th - the type hierarchy cache

isAnonymousType

public boolean isAnonymousType()
Test whether this is an anonymous type
Specified by:
isAnonymousType in interface SchemaType
Returns:
true if this SchemaType is an anonymous type

isAtomicType

public boolean isAtomicType()
Test whether this Simple Type is an atomic type
Specified by:
isAtomicType in interface SimpleType
isAtomicType in interface SchemaType
Returns:
false, this is not (necessarily) an atomic type

isBuiltInType

public boolean isBuiltInType()
Determine whether this is a built-in type or a user-defined type
Specified by:
isBuiltInType in interface SimpleType

isComplexType

public boolean isComplexType()
Test whether this SchemaType is a complex type
Specified by:
isComplexType in interface SchemaType
Returns:
true if this SchemaType is a complex type

isExternalType

public boolean isExternalType()
Return true if this is an external object type, that is, a Saxon-defined type for external Java or .NET objects
Specified by:
isExternalType in interface SimpleType

isListType

public boolean isListType()
Determine whether this is a list type
Specified by:
isListType in interface SimpleType
Returns:
false (it isn't a list type)

isNamespaceSensitive

public boolean isNamespaceSensitive()
Test whether this type represents namespace-sensitive content
Specified by:
isNamespaceSensitive in interface SimpleType
Returns:
false

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 interface SchemaType

isSimpleType

public boolean isSimpleType()
Test whether this SchemaType is a simple type
Specified by:
isSimpleType in interface SchemaType
Returns:
true if this SchemaType is a simple type

isUnionType

public boolean isUnionType()
Determin whether this is a union type
Specified by:
isUnionType in interface SimpleType
Returns:
false (it isn't a union type)

validateContent

public ValidationFailure validateContent(CharSequence value,
                                         NamespaceResolver nsResolver,
                                         NameChecker nameChecker)
Check whether a given input string is valid according to this SimpleType
Specified by:
validateContent in interface SimpleType
Parameters:
value - the input string to be checked
nsResolver - a namespace resolver used to resolve namespace prefixes if the type is namespace sensitive. The value supplied may be null; in this case any namespace-sensitive content will throw an UnsupportedOperationException.
nameChecker -
Returns:
null if validation succeeds (which it always does for this implementation)