net.sf.saxon.type

Class BuiltInListType

public class BuiltInListType extends Object implements ListType, Serializable

This class is used to implement the built-in list types NMTOKENS, ENTITIES, IDREFS. It is also used to represent the anonymous type of the xsi:schemaLocation attribute (a list of xs:anyURI values).

Field Summary
static BuiltInListTypeANY_URIS
static BuiltInListTypeENTITIES
static BuiltInListTypeIDREFS
static BuiltInListTypeNMTOKENS
Constructor Summary
BuiltInListType(int fingerprint)
Create a new ListType.
Method Summary
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.
StringapplyWhitespaceNormalization(String value)
Apply the whitespace normalization rules for this simple 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
SchemaTypegetBaseType()
Returns the base type that this type inherits from.
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
SchemaTypegetBuiltInBaseType()
AtomicTypegetCommonAtomicType()
Get the most specific possible atomic type that all items in this SimpleType belong to
intgetDerivationMethod()
Gets the integer code of the derivation method used to derive this type from its parent.
StringgetDescription()
StringgetDisplayName()
Get the display name of the type: that is, a lexical QName with an arbitrary prefix
intgetFingerprint()
Get the fingerprint of the name of this type
SimpleTypegetItemType()
Returns the simpleType of the items in this ListType.
SchemaTypegetKnownBaseType()
Returns the base type that this type inherits from.
StringgetLocalName()
Get the local name of this type
StringgetName()
Get the local name of this type
intgetNameCode()
Get the namecode of the name of this type.
intgetRedefinitionLevel()
Get the redefinition level.
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.
SequenceIteratorgetTypedValue(CharSequence value, NamespaceResolver resolver, NameChecker nameChecker)
Get the typed value of a given input string.
intgetValidationStatus()
Get the validation status - always valid
intgetWhitespaceAction(TypeHierarchy th)
Determine how values of this simple type are whitespace-normalized.
booleanisAnonymousType()
Test whether this is an anonymous type
booleanisAtomicType()
Test whether this Simple Type is an atomic type
booleanisBuiltInType()
Determine whether this is a built-in type or a user-defined type
booleanisComplexType()
Test whether this SchemaType is a complex type
booleanisExternalType()
Return true if this is an external object type, that is, a Saxon-defined type for external Java or .NET objects
booleanisIdRefType()
Ask whether this type is an IDREF or IDREFS type.
booleanisIdType()
Ask whether this type is an ID type.
booleanisListType()
Returns true if this type is derived by list, or if it is derived by restriction from a list type, or if it is a union that contains a list as one of its members
booleanisNamespaceSensitive()
booleanisSameType(SchemaType other)
Test whether this is the same type as another type.
booleanisSimpleType()
Test whether this SchemaType is a simple type
booleanisUnionType()
CharSequencepostprocess(CharSequence input)
Reverse any pre-lexical facets, other than whitespace.
CharSequencepreprocess(CharSequence input)
Apply any pre-lexical facets, other than whitespace.
ValidationFailurevalidateContent(CharSequence value, NamespaceResolver nsResolver, NameChecker nameChecker)
Check whether a given input string is valid according to this SimpleType

Field Detail

ANY_URIS

public static BuiltInListType ANY_URIS

ENTITIES

public static BuiltInListType ENTITIES

IDREFS

public static BuiltInListType IDREFS

NMTOKENS

public static BuiltInListType NMTOKENS

Constructor Detail

BuiltInListType

public BuiltInListType(int fingerprint)
Create a new ListType.

Parameters: fingerprint identifies the name of the type

Method Detail

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 the XPath static context

Throws: net.sf.saxon.trans.XPathException if the expression will never deliver a value of the correct type

applyWhitespaceNormalization

public String applyWhitespaceNormalization(String value)
Apply the whitespace normalization rules for this simple type

Parameters: value the string before whitespace normalization

Returns: the string after whitespace normalization

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

getBaseType

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

Returns: the base type.

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

getBuiltInBaseType

public SchemaType getBuiltInBaseType()

getCommonAtomicType

public AtomicType getCommonAtomicType()
Get the most specific possible atomic type that all items in this SimpleType belong to

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.

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

getDescription

public String getDescription()

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

getFingerprint

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

Returns: the fingerprint. Returns an invented fingerprint for an anonymous type.

getItemType

public SimpleType getItemType()
Returns the simpleType of the items in this ListType.

Returns: the simpleType of the items in this ListType.

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.

getLocalName

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

Returns: the local part of the name, or null if the type is anonymous

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. Because built-in types don't depend on the namePool, this actually returns the fingerprint, which contains no information about the namespace 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

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. This method must be called only for a valid type.

Parameters: node the node whose typed value is required

Returns: a SequenceIterator over the atomic values making up the typed value of the specified node. The objects returned by this iterator are of type AtomicValue

getTypedValue

public SequenceIterator getTypedValue(CharSequence value, NamespaceResolver resolver, NameChecker nameChecker)
Get the typed value of a given input string. This method assumes that the input value is valid according to this SimpleType

Parameters: value the string whose typed value is required resolver namespace resolver for namespace-sensitive content nameChecker name checker for XML-version sensitive content

getValidationStatus

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

getWhitespaceAction

public int getWhitespaceAction(TypeHierarchy th)
Determine how values of this simple type are whitespace-normalized.

Parameters: th the type hierarchy cache

Returns: one of PRESERVE, COLLAPSE, REPLACE.

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 Simple Type is an atomic type

Returns: false, this is not an atomic type

isBuiltInType

public boolean isBuiltInType()
Determine whether this is a built-in type or a user-defined type

isComplexType

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

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

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.

isListType

public boolean isListType()
Returns true if this type is derived by list, or if it is derived by restriction from a list type, or if it is a union that contains a list as one of its members

isNamespaceSensitive

public boolean isNamespaceSensitive()

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)

isSimpleType

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

Returns: true if this SchemaType is a simple type

isUnionType

public boolean isUnionType()

postprocess

public CharSequence postprocess(CharSequence input)
Reverse any pre-lexical facets, other than whitespace. At the moment the only such facet is saxon:preprocess. This is called when converting a value of this type to a string

Parameters: input the value to be postprocessed: this is the "ordinary" result of converting the value to a string

Returns: the value after postprocessing

preprocess

public CharSequence preprocess(CharSequence input)
Apply any pre-lexical facets, other than whitespace. At the moment the only such facet is saxon:preprocess

Parameters: input the value to be preprocessed

Returns: the value after preprocessing

validateContent

public ValidationFailure validateContent(CharSequence value, NamespaceResolver nsResolver, NameChecker nameChecker)
Check whether a given input string is valid according to this 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 XML 1.0 or 1.1 name checker, for types such as xs:NCName

Throws: UnsupportedOperationException if the type is namespace-sensitive and no namespace resolver is supplied