Package net.sf.saxon.type
Class BuiltInListType
- java.lang.Object
-
- net.sf.saxon.type.BuiltInListType
-
- All Implemented Interfaces:
CastingTarget,ListType,SchemaComponent,SchemaType,SimpleType
public class BuiltInListType extends java.lang.Object implements ListType
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).
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface net.sf.saxon.type.SchemaComponent
SchemaComponent.ValidationStatus
-
-
Field Summary
Fields Modifier and Type Field Description static BuiltInListTypeANY_URISstatic BuiltInListTypeENTITIESstatic BuiltInListTypeIDREFSstatic BuiltInListTypeNMTOKENS-
Fields inherited from interface net.sf.saxon.type.SchemaComponent
COMPONENT_FUNCTION_TYPE
-
Fields inherited from interface net.sf.saxon.type.SchemaType
DERIVATION_EXTENSION, DERIVATION_LIST, DERIVATION_RESTRICTION, DERIVATION_UNION, DERIVE_BY_SUBSTITUTION
-
-
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 booleanallowsDerivation(int derivation)Determines whether derivation (of a particular kind) from this type is allowed, based on the "final" propertyvoidanalyzeContentExpression(Expression expression, int kind)Analyze an expression to see whether the expression is capable of delivering a value of this type.java.lang.StringapplyWhitespaceNormalization(java.lang.String value)Apply the whitespace normalization rules for this simple typeAtomicSequenceatomize(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 typeSchemaTypegetBaseType()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 asSchemaType.DERIVATION_LISTandSchemaType.DERIVATION_EXTENSIONSchemaTypegetBuiltInBaseType()Get the built-in type from which this type is derived by restrictionFunctiongetComponentAsFunction()Get the schema component in the form of a function item.intgetDerivationMethod()Gets the integer code of the derivation method used to derive this type from its parent.java.lang.StringgetDescription()Get a description of this type for use in error messages.java.lang.StringgetDisplayName()Get the display name of the type: that is, a lexical QName with an arbitrary prefixjava.lang.StringgetEQName()Get the name of this type as an EQName, that is, a string in the format Q{uri}local.intgetFinalProhibitions()Get the types of derivation that are not permitted, by virtue of the "final" property.intgetFingerprint()Get the fingerprint of the name of this typeSimpleTypegetItemType()Returns the simpleType of the items in this ListType.SchemaTypegetKnownBaseType()Returns the base type that this type inherits from.java.lang.StringgetLocalName()Get the local name of this typejava.lang.StringgetName()Get the local name of this typeintgetRedefinitionLevel()Get the redefinition level.StructuredQNamegetStructuredQName()Get the name of the type as a StructuredQNamejava.lang.StringgetSystemId()Get the URI of the schema document containing the definition of this typejava.lang.StringgetTargetNamespace()Get the target namespace of this typeAtomicSequencegetTypedValue(java.lang.CharSequence value, NamespaceResolver resolver, ConversionRules rules)Get the typed value of a given input string.SchemaComponent.ValidationStatusgetValidationStatus()Get the validation status - always validintgetWhitespaceAction()Determine how values of this simple type are whitespace-normalized.booleanisAnonymousType()Test whether this is an anonymous typebooleanisAtomicType()Test whether this Simple Type is an atomic typebooleanisBuiltInType()Determine whether this is a built-in type or a user-defined typebooleanisComplexType()Test whether this SchemaType is a complex typebooleanisIdRefType()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 membersbooleanisNamespaceSensitive()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.booleanisSameType(SchemaType other)Test whether this is the same type as another type.booleanisSimpleType()Test whether this SchemaType is a simple typebooleanisUnionType()Test whether this Simple Type is a union typejava.lang.CharSequencepostprocess(java.lang.CharSequence input)Reverse any pre-lexical facets, other than whitespace.java.lang.CharSequencepreprocess(java.lang.CharSequence input)Apply any pre-lexical facets, other than whitespace.ValidationFailurevalidateContent(java.lang.CharSequence value, NamespaceResolver nsResolver, ConversionRules rules)Check whether a given input string is valid according to this SimpleType-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface net.sf.saxon.type.SchemaType
getNearestNamedType
-
-
-
-
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
-
isBuiltInType
public boolean isBuiltInType()
Determine whether this is a built-in type or a user-defined type- Specified by:
isBuiltInTypein 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:
getSystemIdin 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:
getRedefinitionLevelin interfaceSchemaComponent- Returns:
- the redefinition level
-
getWhitespaceAction
public int getWhitespaceAction()
Determine how values of this simple type are whitespace-normalized.- Specified by:
getWhitespaceActionin interfaceSimpleType- Returns:
- one of
Whitespace.PRESERVE,Whitespace.COLLAPSE,Whitespace.REPLACE.
-
getValidationStatus
public SchemaComponent.ValidationStatus getValidationStatus()
Get the validation status - always valid- Specified by:
getValidationStatusin interfaceSchemaComponent- Returns:
- one of the values
SchemaComponent.ValidationStatus.UNVALIDATED,SchemaComponent.ValidationStatus.VALIDATING,SchemaComponent.ValidationStatus.VALIDATED,SchemaComponent.ValidationStatus.INVALID,SchemaComponent.ValidationStatus.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:
getBaseTypein interfaceSchemaType- Returns:
- the base type.
-
isAtomicType
public boolean isAtomicType()
Test whether this Simple Type is an atomic type- Specified by:
isAtomicTypein interfaceSchemaType- Specified by:
isAtomicTypein 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:
isIdTypein 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:
isIdRefTypein 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:
isListTypein interfaceSimpleType- Returns:
- true if this is a list type
-
isUnionType
public boolean isUnionType()
Description copied from interface:SimpleTypeTest whether this Simple Type is a union type- Specified by:
isUnionTypein interfaceSimpleType- Returns:
- true if this is a union type
-
isAnonymousType
public boolean isAnonymousType()
Test whether this is an anonymous type- Specified by:
isAnonymousTypein interfaceSchemaType- Returns:
- true if this SchemaType is an anonymous type
-
getBuiltInBaseType
public SchemaType getBuiltInBaseType()
Description copied from interface:SimpleTypeGet the built-in type from which this type is derived by restriction- Specified by:
getBuiltInBaseTypein 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:SimpleTypeTest 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:
isNamespaceSensitivein interfaceSimpleType- Returns:
- true if the type is namespace-sensitive, or if the namespace-sensitivity cannot be determined because there are missing schema components. (However, for xs:anyAtomicType, the result returned is false, even though the type allows xs:QName instances.)
-
getName
public java.lang.String getName()
Get the local name of this type- Specified by:
getNamein 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:
getTargetNamespacein 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.
-
getEQName
public java.lang.String getEQName()
Get the name of this type as an EQName, that is, a string in the format Q{uri}local.- Specified by:
getEQNamein interfaceSchemaType- Returns:
- an EQName identifying the type.
-
getFingerprint
public int getFingerprint()
Get the fingerprint of the name of this type- Specified by:
getFingerprintin interfaceSchemaType- Returns:
- the fingerprint. Returns an invented fingerprint 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:
getDisplayNamein interfaceSchemaType- Returns:
- a lexical QName identifying the type
-
isComplexType
public boolean isComplexType()
Test whether this SchemaType is a complex type- Specified by:
isComplexTypein interfaceSchemaType- Returns:
- true if this SchemaType is a complex type
-
isSimpleType
public boolean isSimpleType()
Test whether this SchemaType is a simple type- Specified by:
isSimpleTypein 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_LISTandSchemaType.DERIVATION_EXTENSION- Specified by:
getBlockin 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:
getDerivationMethodin 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:
allowsDerivationin interfaceSchemaType- Parameters:
derivation- the kind of derivation, for exampleSchemaType.DERIVATION_LIST- Returns:
- true if this kind of derivation is allowed
-
getFinalProhibitions
public int getFinalProhibitions()
Get the types of derivation that are not permitted, by virtue of the "final" property.- Specified by:
getFinalProhibitionsin interfaceSchemaType- Returns:
- the types of derivation that are not permitted, as a bit-significant integer
containing bits such as
SchemaType.DERIVATION_EXTENSION
-
getComponentAsFunction
public Function getComponentAsFunction()
Get the schema component in the form of a function item. This allows schema information to be made visible to XSLT or XQuery code. The function makes available the contents of the schema component as defined in the XSD specification. The function takes a string as argument representing a property name, and returns the corresponding property of the schema component. There is also a property "class" which returns the kind of schema component, for example "Attribute Declaration".- Specified by:
getComponentAsFunctionin interfaceSchemaComponent- Returns:
- the schema component represented as a function from property names to property values.
-
atomize
public AtomicSequence 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 method- Specified by:
atomizein 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:
isSameTypein 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:SchemaTypeGet 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:
getDescriptionin interfaceSchemaType- Returns:
- text identifing the type, for use in a phrase such as "the type XXXX".
-
checkTypeDerivationIsOK
public void checkTypeDerivationIsOK(SchemaType type, int block)
Check that this type is validly derived from a given type- Specified by:
checkTypeDerivationIsOKin interfaceSchemaType- Parameters:
type- the type from which this type is derivedblock- the derivations that are blocked by the relevant element declaration
-
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
-
getStructuredQName
public StructuredQName getStructuredQName()
Get the name of the type as a StructuredQName- Specified by:
getStructuredQNamein interfaceSchemaType- Returns:
- a StructuredQName identifying the type. In the case of an anonymous type, an internally-generated name is returned
-
getItemType
public SimpleType getItemType()
Returns the simpleType of the items in this ListType.- Specified by:
getItemTypein 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) throws XPathException
Analyze an expression to see whether the expression is capable of delivering a value of this type.- Specified by:
analyzeContentExpressionin interfaceSchemaType- Parameters:
expression- the expression that delivers the contentkind- the node kind whose content is being delivered:Type.ELEMENT,Type.ATTRIBUTE, orType.DOCUMENT- 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:
validateContentin 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 AtomicSequence 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:
getTypedValuein interfaceSimpleType- Parameters:
value- the string whose typed value is requiredresolver- namespace resolver for namespace-sensitive contentrules- the type conversion rules to be used- Returns:
- the atomic sequence comprising the typed value. The objects
returned by this SequenceIterator will all be of type
AtomicValue, - 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:
preprocessin interfaceSimpleType- Parameters:
input- the value to be preprocessed- Returns:
- the value after preprocessing
-
postprocess
public java.lang.CharSequence postprocess(java.lang.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- Specified by:
postprocessin 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
-
-