Package net.sf.saxon.type
Class BuiltInListType
- java.lang.Object
-
- net.sf.saxon.type.BuiltInListType
-
- All Implemented Interfaces:
java.io.Serializable
,ListType
,SchemaComponent
,SchemaType
,SimpleType
public class BuiltInListType extends java.lang.Object implements ListType, java.io.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).
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static BuiltInListType
ANY_URIS
static BuiltInListType
ENTITIES
static BuiltInListType
IDREFS
static BuiltInListType
NMTOKENS
-
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
-
Fields inherited from interface net.sf.saxon.type.SimpleType
VARIETY_ATOMIC, VARIETY_LIST, VARIETY_UNION, VARIETY_UNSPECIFIED_SIMPLE
-
-
Constructor Summary
Constructors Constructor Description BuiltInListType(int fingerprint)
Create a new ListType.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description 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.java.lang.String
applyWhitespaceNormalization(java.lang.String value)
Apply the whitespace normalization rules for this simple typeValue
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 typeSchemaType
getBaseType()
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
SchemaType
getBuiltInBaseType()
Get the built-in type from which this type is derived by restrictionint
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 error messages.java.lang.String
getDisplayName()
Get the display name of the type: that is, a lexical QName with an arbitrary prefixint
getFingerprint()
Get the fingerprint of the name of this typeSimpleType
getItemType()
Returns the simpleType of the items in this ListType.SchemaType
getKnownBaseType()
Returns the base type that this type inherits from.java.lang.String
getLocalName()
Get the local name of this typejava.lang.String
getName()
Get the local name of this typeint
getNameCode()
Get the namecode of the name of this type.int
getRedefinitionLevel()
Get the redefinition level.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<AtomicValue>
getTypedValue(java.lang.CharSequence value, NamespaceResolver resolver, ConversionRules rules)
Get the typed value of a given input string.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 validint
getWhitespaceAction()
Determine how values of this simple type are whitespace-normalized.boolean
isAnonymousType()
Test whether this is an anonymous typeboolean
isAtomicType()
Test whether this Simple Type is an atomic typeboolean
isBuiltInType()
Determine whether this is a built-in type or a user-defined typeboolean
isComplexType()
Test whether this SchemaType is a complex typeboolean
isExternalType()
Return true if this is an external object type, that is, a Saxon-defined type for external Java or .NET objectsboolean
isIdRefType()
Ask whether this type is an IDREF or IDREFS type.boolean
isIdType()
Ask whether this type is an ID type.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 membersboolean
isNamespaceSensitive()
Test whether this type is namespace sensitive, that is, if a namespace context is needed to translate between the lexical space and the value space.boolean
isSameType(SchemaType other)
Test whether this is the same type as another type.boolean
isSimpleType()
Test whether this SchemaType is a simple typeboolean
isUnionType()
Test whether this Simple Type is a union typejava.lang.CharSequence
postprocess(java.lang.CharSequence input)
Reverse any pre-lexical facets, other than whitespace.java.lang.CharSequence
preprocess(java.lang.CharSequence input)
Apply any pre-lexical facets, other than whitespace.ValidationFailure
validateContent(java.lang.CharSequence value, NamespaceResolver nsResolver, ConversionRules rules)
Check whether a given input string is valid according to this SimpleType
-
-
-
Field Detail
-
ENTITIES
public static BuiltInListType ENTITIES
-
IDREFS
public static BuiltInListType IDREFS
-
NMTOKENS
public static BuiltInListType NMTOKENS
-
ANY_URIS
public static BuiltInListType ANY_URIS
-
-
Method Detail
-
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 interfaceSimpleType
- Returns:
- true if this is an external type
-
isBuiltInType
public boolean isBuiltInType()
Determine whether this is a built-in type or a user-defined type- Specified by:
isBuiltInType
in interfaceSimpleType
- Returns:
- true if this is a built-in 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
-
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.- Specified by:
getRedefinitionLevel
in interfaceSchemaComponent
- Returns:
- the redefinition level
-
getWhitespaceAction
public int getWhitespaceAction()
Determine how values of this simple type are whitespace-normalized.- Specified by:
getWhitespaceAction
in interfaceSimpleType
- Returns:
- one of
Whitespace.PRESERVE
,Whitespace.COLLAPSE
,Whitespace.REPLACE
.
-
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()
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.
-
isAtomicType
public boolean isAtomicType()
Test whether this Simple Type is an atomic type- Specified by:
isAtomicType
in interfaceSchemaType
- Specified by:
isAtomicType
in interfaceSimpleType
- Returns:
- false, this is not an atomic type
-
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.- Specified by:
isIdType
in interfaceSchemaType
- Returns:
- true if this type is an ID type
-
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- Specified by:
isIdRefType
in interfaceSchemaType
- Returns:
- true if this type is an IDREF type
-
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- Specified by:
isListType
in interfaceSimpleType
- Returns:
- true if this is a list type
-
isUnionType
public boolean isUnionType()
Description copied from interface:SimpleType
Test whether this Simple Type is a union type- Specified by:
isUnionType
in interfaceSimpleType
- Returns:
- true if this is a union 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
-
getBuiltInBaseType
public SchemaType getBuiltInBaseType()
Description copied from interface:SimpleType
Get the built-in type from which this type is derived by restriction- Specified by:
getBuiltInBaseType
in interfaceSimpleType
- Returns:
- the built-in type from which this type is derived by restriction. This will not necessarily be a primitive type.
-
isNamespaceSensitive
public boolean isNamespaceSensitive()
Description copied from interface:SimpleType
Test whether this type is namespace sensitive, that is, if a namespace context is needed to translate between the lexical space and the value space. This is true for types derived from, or containing, QNames and NOTATIONs- Specified by:
isNamespaceSensitive
in interfaceSimpleType
- Returns:
- true if the type is namespace-sensitive
-
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.
-
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. Because built-in types don't depend on the namePool, this actually returns the fingerprint, which contains no information about the namespace prefix- Specified by:
getNameCode
in interfaceSchemaType
- Returns:
- the namecode. Returns an invented namecode for an anonymous type.
-
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
-
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
-
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
-
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
-
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
-
getTypedValue
public SequenceIterator getTypedValue(NodeInfo node) throws XPathException
Get the typed value of a node that is annotated with this schema type. This method must be called only for a valid type.- Specified by:
getTypedValue
in interfaceSchemaType
- 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
- Throws:
XPathException
- if the node has no typed value (typically, if it is an element with an element-only content type)
-
atomize
public Value atomize(NodeInfo node) throws XPathException
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.
- Throws:
XPathException
- if the node cannot be atomized, for example if this is a complex type with element-only content- Since:
- 8.5
-
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
-
getDescription
public java.lang.String getDescription()
Description copied from interface:SchemaType
Get a description of this type for use in error messages. This is the same as the display name in the case of named types; for anonymous types it identifies the type by its position in a source schema document.- Specified by:
getDescription
in interfaceSchemaType
- Returns:
- text identifing the type, for use in a phrase such as "the type XXXX".
-
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
-
getLocalName
public java.lang.String getLocalName()
Get the local name of this type- Returns:
- the local part of the name, or null if the type is anonymous
-
getItemType
public SimpleType getItemType()
Returns the simpleType of the items in this ListType.- Specified by:
getItemType
in interfaceListType
- Returns:
- the simpleType of the items in this ListType.
-
applyWhitespaceNormalization
public java.lang.String applyWhitespaceNormalization(java.lang.String value)
Apply the whitespace normalization rules for this simple type- Parameters:
value
- the string before whitespace normalization- Returns:
- the string after whitespace normalization
-
analyzeContentExpression
public void analyzeContentExpression(Expression expression, int kind, StaticContext env) throws XPathException
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
- the XPath static context- Throws:
XPathException
- if the expression will never deliver a value of the correct type
-
validateContent
public ValidationFailure validateContent(java.lang.CharSequence value, NamespaceResolver nsResolver, ConversionRules rules)
Check whether a given input string is valid according to this SimpleType- Specified by:
validateContent
in interfaceSimpleType
- Parameters:
value
- the input string to be checkednsResolver
- 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.rules
- the conversion rules for this configuration- Returns:
- either null to indicate that validation succeeded, or a ValidationFailure object giving information about why it failed
- Throws:
java.lang.UnsupportedOperationException
- if the type is namespace-sensitive and no namespace resolver is supplied
-
getTypedValue
public SequenceIterator<AtomicValue> getTypedValue(java.lang.CharSequence value, NamespaceResolver resolver, ConversionRules rules) throws ValidationException
Get the typed value of a given input string. This method assumes that the input value is valid according to this SimpleType- Specified by:
getTypedValue
in interfaceSimpleType
- Parameters:
value
- the string whose typed value is requiredresolver
- namespace resolver for namespace-sensitive contentrules
-- Returns:
- an iterator over the atomic sequence comprising the typed value. The objects
returned by this SequenceIterator will all be of type
AtomicValue
, The next() method on the iterator throws no checked exceptions, although it is not actually declared as an UnfailingIterator. - Throws:
ValidationException
- if the supplied value is not in the lexical space of the data type
-
preprocess
public java.lang.CharSequence preprocess(java.lang.CharSequence input)
Apply any pre-lexical facets, other than whitespace. At the moment the only such facet is saxon:preprocess- Specified by:
preprocess
in interfaceSimpleType
- Parameters:
input
- the value to be preprocessed- Returns:
- the value after preprocessing
-
postprocess
public java.lang.CharSequence postprocess(java.lang.CharSequence input) throws ValidationException
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- Specified by:
postprocess
in interfaceSimpleType
- Parameters:
input
- the value to be postprocessed: this is the "ordinary" result of converting the value to a string- Returns:
- the value after postprocessing
- Throws:
ValidationException
- if postprocessing detects that the value is invalid
-
-