Package net.sf.saxon.type
Class ErrorType
- java.lang.Object
-
- net.sf.saxon.pattern.NodeTest
-
- net.sf.saxon.type.ErrorType
-
- All Implemented Interfaces:
NodePredicate
,AtomicType
,CastingTarget
,HyperType
,ItemType
,ItemTypeWithSequenceTypeCache
,PlainType
,SchemaComponent
,SchemaType
,SimpleType
,UnionType
public final class ErrorType extends NodeTest implements AtomicType, UnionType, PlainType
This class has a singleton instance which represents the XML Schema 1.1 built-in type xs:error.
-
-
Method Summary
All Methods Static 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)
Analyze an expression to see whether the expression is capable of delivering a value of this type.AtomicSequence
atomize(NodeInfo node)
Get the typed value of a node that is annotated with this schema type.ValidationFailure
checkAgainstFacets(AtomicValue value, ConversionRules rules)
Validate an atomic value, which is known to be an instance of one of the member types of the union, against any facets (pattern facets or enumeration facets) defined at the level of the union itself.void
checkTypeDerivationIsOK(SchemaType type, int block)
Check that this type is validly derived from a given typeboolean
containsListType()
Ask whether the union contains a list type among its member typesjava.util.Optional<java.lang.String>
explainMismatch(Item item, TypeHierarchy th)
Get extra diagnostic information about why a supplied item does not conform to this item type, if available.AtomicType
getAtomizedItemType()
Get the item type of the atomic values that will be produced when an item of this type is atomized (assuming that atomization succeeds)SchemaType
getBaseType()
Get the base typeint
getBlock()
Returns the value of the 'block' attribute for this type, as a bit-signnificant integer with fields such asDerivation.DERIVATION_LIST
andDerivation.DERIVATION_EXTENSION
SchemaType
getBuiltInBaseType()
Get the built-in ancestor of this type in the type hierarchyFunctionItem
getComponentAsFunction()
Get the schema component in the form of a function item.double
getDefaultPriority()
Determine the default priority to use if this node-test appears as a match pattern for a template with no explicit priority attribute.int
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 diagnosticsjava.lang.String
getDisplayName()
Get the display name of the type: that is, a lexical QName with an arbitrary prefixjava.lang.String
getEQName()
Get the name of this type as an EQName, that is, a string in the format Q{uri}local.int
getFinalProhibitions()
Get the types of derivation that are not permitted, by virtue of the "final" property.int
getFingerprint()
Get the fingerprint of the name of this typeGenre
getGenre()
Determine the Genre (top-level classification) of this typestatic ErrorType
getInstance()
Get the singular instance of this classSchemaType
getKnownBaseType()
Returns the base type that this type inherits from.StructuredQName
getMatchingNodeName()
Get the name of the nodes matched by this nodetest, if it matches a specific name.java.lang.String
getName()
Get the local name of this typejava.util.List<? extends PlainType>
getPlainMemberTypes()
Get the list of plain types that are subsumed by this typeAtomicType
getPrimitiveItemType()
Get the primitive item type corresponding to this item type.int
getPrimitiveType()
Get the basic kind of object that this ItemType matches: for a NodeTest, this is the kind of node, or Type.Node if it matches different kinds of nodes.int
getRedefinitionLevel()
Get the redefinition level.SequenceType
getResultTypeOfCast()
Get the result type of a cast operation to this union type, as a sequence type.StringConverter
getStringConverter(ConversionRules rules)
Get a StringConverter, an object which converts strings in the lexical space of this data type to instances (in the value space) of the data type.StructuredQName
getStructuredQName()
Get the name of this type as a StructuredQName, unless the type is anonymous, in which case return nulljava.lang.String
getSystemId()
Get the URI of the schema document containing the definition of this typeNamespaceUri
getTargetNamespace()
Get the target namespace of this typeAtomicSequence
getTypedValue(UnicodeString value, NamespaceResolver resolver, ConversionRules rules)
Get the typed value corresponding to a given string value, assuming it is valid against this typeStructuredQName
getTypeName()
Get the name of the type as a StructuredQNameUType
getUType()
Get the correspondingUType
.SchemaValidationStatus
getValidationStatus()
Get the validation status - always validint
getWhitespaceAction()
Determine how values of this simple type are whitespace-normalized.boolean
isAbstract()
Determine whether the type is abstract, that is, whether it cannot have instances that are not also instances of some concrete subtypeboolean
isAnonymousType()
Test whether this is an anonymous typeboolean
isAtomicType()
Test whether this Simple Type is an atomic typeboolean
isAtomizable(TypeHierarchy th)
Ask whether values of this type are atomizableboolean
isBuiltInType()
Determine whether this is a built-in type or a user-defined typeboolean
isComplexType()
Test whether this SchemaType is a complex typeboolean
isIdRefType()
Ask whether this type is an IDREF or IDREFS type.boolean
isIdType()
Ask whether this type is an ID type.boolean
isListType()
Determine whether this is a list typeboolean
isNamespaceSensitive()
Test whether this type represents namespace-sensitive contentboolean
isOrdered(boolean optimistic)
Determine whether the atomic type is ordered, that is, whether less-than and greater-than comparisons are permittedboolean
isPlainType()
Determine whether this item type is atomic (that is, whether it can ONLY match atomic values)boolean
isPrimitiveType()
Determine whether the atomic type is a primitive type.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()
Determin whether this is a union typeboolean
matches(int nodeKind, NodeName name, SchemaType annotation)
Test whether this node test is satisfied by a given node.boolean
matches(Item item, TypeHierarchy th)
Test whether a given item conforms to this typeUnicodeString
postprocess(UnicodeString input)
Reverse any pre-lexical facets, other than whitespace.UnicodeString
preprocess(UnicodeString input)
Apply any pre-lexical facets, other than whitespace.java.lang.String
toExportString()
Return a string representation of this ItemType suitable for use in stylesheet export files.java.lang.String
toString()
ValidationFailure
validate(AtomicValue primValue, UnicodeString lexicalValue, ConversionRules rules)
Validate that a primitive atomic value is a valid instance of a type derived from the same primitive type.ValidationFailure
validateContent(UnicodeString value, NamespaceResolver nsResolver, ConversionRules rules)
Check whether a given input string is valid according to this SimpleType-
Methods inherited from class net.sf.saxon.pattern.NodeTest
copy, getBasicAlphaCode, getContentType, getMatcher, getRequiredNodeNames, isNillable, one, oneOrMore, test, toShortString, zeroOrMore, zeroOrOne
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface net.sf.saxon.type.AtomicType
getPrimitiveAtomicType
-
Methods inherited from interface net.sf.saxon.type.ItemType
getBasicAlphaCode, getFullAlphaCode, getNormalizedDefaultPriority
-
-
-
-
Method Detail
-
getGenre
public Genre getGenre()
Description copied from class:NodeTest
Determine the Genre (top-level classification) of this type- Specified by:
getGenre
in interfaceAtomicType
- Specified by:
getGenre
in interfaceItemType
- Overrides:
getGenre
in classNodeTest
- Returns:
- the Genre to which this type belongs, specifically
Genre.NODE
-
getUType
public UType getUType()
Get the correspondingUType
. A UType is a union of primitive item types.
-
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 NamespaceUri 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.
-
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:
getEQName
in interfaceSchemaType
- Returns:
- an EQName identifying the type. In the case of an anonymous type, an internally-generated name is returned
-
containsListType
public boolean containsListType()
Description copied from interface:UnionType
Ask whether the union contains a list type among its member types- Specified by:
containsListType
in interfaceUnionType
- Returns:
- true of one of the member types is a list type
-
getPlainMemberTypes
public java.util.List<? extends PlainType> getPlainMemberTypes()
Description copied from interface:PlainType
Get the list of plain types that are subsumed by this type- Specified by:
getPlainMemberTypes
in interfacePlainType
- Specified by:
getPlainMemberTypes
in interfaceUnionType
- Returns:
- for an atomic type, the type itself; for a plain union type, the list of plain types in its transitive membership
-
isBuiltInType
public boolean isBuiltInType()
Determine whether this is a built-in type or a user-defined type- Specified by:
isBuiltInType
in interfaceAtomicType
- Specified by:
isBuiltInType
in interfaceSimpleType
- Returns:
- true if this is 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
-
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
-
getInstance
public static ErrorType getInstance()
Get the singular instance of this class- Returns:
- the singular object representing xs:anyType
-
getValidationStatus
public SchemaValidationStatus getValidationStatus()
Get the validation status - always valid- Specified by:
getValidationStatus
in interfaceSchemaComponent
- Returns:
- one of the values
SchemaValidationStatus.UNVALIDATED
,SchemaValidationStatus.VALIDATING
,SchemaValidationStatus.VALIDATED
,SchemaValidationStatus.INVALID
,SchemaValidationStatus.INCOMPLETE
-
getBaseType
public SchemaType getBaseType()
Get the base type- Specified by:
getBaseType
in interfaceSchemaType
- Returns:
- AnyType
-
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.- Returns:
- the base 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
-
getFingerprint
public int getFingerprint()
Get the fingerprint of the name of this type- Specified by:
getFingerprint
in interfaceSchemaType
- Overrides:
getFingerprint
in classNodeTest
- Returns:
- the fingerprint.
-
getMatchingNodeName
public StructuredQName getMatchingNodeName()
Get the name of the nodes matched by this nodetest, if it matches a specific name. Return null if the node test matches nodes of more than one name- Overrides:
getMatchingNodeName
in classNodeTest
-
getTypeName
public StructuredQName getTypeName()
Get the name of the type as a StructuredQName- Specified by:
getTypeName
in interfaceAtomicType
- Specified by:
getTypeName
in interfacePlainType
- Specified by:
getTypeName
in interfaceUnionType
- Returns:
- a StructuredQName identifying the type. In the case of an anonymous type, an internally-generated name is returned
-
getDescription
public java.lang.String getDescription()
Get a description of this type for use in diagnostics- Specified by:
getDescription
in interfaceSchemaType
- Specified by:
getDescription
in interfaceUnionType
- Returns:
- the string "xs:anyType"
-
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
-
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
-
atomize
public AtomicSequence atomize(NodeInfo node)
Get the typed value of a node that is annotated with this schema type.- Specified by:
atomize
in interfaceSchemaType
- 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 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
-
isAtomicType
public boolean isAtomicType()
Test whether this Simple Type is an atomic type- Specified by:
isAtomicType
in interfaceItemType
- Specified by:
isAtomicType
in interfaceSchemaType
- Specified by:
isAtomicType
in interfaceSimpleType
- Overrides:
isAtomicType
in classNodeTest
- Returns:
- false, this is not (necessarily) 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 interfaceAtomicType
- 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 interfaceAtomicType
- Specified by:
isIdRefType
in interfaceSchemaType
- Returns:
- true if this type is an IDREF type
-
isAnonymousType
public boolean isAnonymousType()
Description copied from interface:SchemaType
Test whether this is an anonymous type- Specified by:
isAnonymousType
in interfaceSchemaType
- Returns:
- true if this SchemaType is an anonymous type
-
isListType
public boolean isListType()
Determine whether this is a list type- Specified by:
isListType
in interfaceSimpleType
- Returns:
- false (it isn't a list type)
-
isUnionType
public boolean isUnionType()
Determin whether this is a union type- Specified by:
isUnionType
in interfaceSimpleType
- Returns:
- true (this is a union type with no members)
-
getBuiltInBaseType
public SchemaType getBuiltInBaseType()
Get the built-in ancestor of this type in the type hierarchy- Specified by:
getBuiltInBaseType
in interfaceSimpleType
- Returns:
- xs:anySimpleType
-
getTypedValue
public AtomicSequence getTypedValue(UnicodeString value, NamespaceResolver resolver, ConversionRules rules) throws ValidationException
Get the typed value corresponding to a given string value, assuming it is valid against this type- Specified by:
getTypedValue
in interfaceSimpleType
- Specified by:
getTypedValue
in interfaceUnionType
- Parameters:
value
- the string valueresolver
- 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.rules
- the conversion rules- Returns:
- an iterator over 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 (which is always true for this type)
-
getStringConverter
public StringConverter getStringConverter(ConversionRules rules)
Get a StringConverter, an object which converts strings in the lexical space of this data type to instances (in the value space) of the data type.- Specified by:
getStringConverter
in interfaceAtomicType
- Parameters:
rules
- the conversion rules to be used- Returns:
- a StringConverter to do the conversion, or null if no built-in converter is available.
-
validateContent
public ValidationFailure validateContent(UnicodeString 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- Returns:
- null if validation succeeds (which it never does for this implementation)
- Throws:
java.lang.UnsupportedOperationException
- if the type is namespace-sensitive and no namespace resolver is supplied
-
isNamespaceSensitive
public boolean isNamespaceSensitive()
Test whether this type represents namespace-sensitive content- Specified by:
isNamespaceSensitive
in interfaceHyperType
- Returns:
- false
-
getBlock
public int getBlock()
Returns the value of the 'block' attribute for this type, as a bit-signnificant integer with fields such asDerivation.DERIVATION_LIST
andDerivation.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
Derivation.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 exampleDerivation.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:
getFinalProhibitions
in interfaceSchemaType
- Returns:
- the types of derivation that are not permitted, as a bit-significant integer
containing bits such as
Derivation.DERIVATION_EXTENSION
-
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
.
-
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:
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
- Throws:
XPathException
- if the expression will never deliver a value of the correct type
-
preprocess
public UnicodeString preprocess(UnicodeString 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 UnicodeString postprocess(UnicodeString 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:
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
-
isPlainType
public boolean isPlainType()
Description copied from class:NodeTest
Determine whether this item type is atomic (that is, whether it can ONLY match atomic values)- Specified by:
isPlainType
in interfaceItemType
- Overrides:
isPlainType
in classNodeTest
- Returns:
- false: this is not ANY_ATOMIC_TYPE or a subtype thereof
-
matches
public boolean matches(Item item, TypeHierarchy th)
Description copied from interface:ItemType
Test whether a given item conforms to this type- Specified by:
matches
in interfaceItemType
- Specified by:
matches
in interfacePlainType
- Overrides:
matches
in classNodeTest
- Parameters:
item
- The item to be testedth
- The type hierarchy cache. Currently used only when matching function items.- Returns:
- true if the item is an instance of this type; false otherwise
-
matches
public boolean matches(int nodeKind, NodeName name, SchemaType annotation)
Description copied from class:NodeTest
Test whether this node test is satisfied by a given node. This method is only fully supported for a subset of NodeTests, because it doesn't provide all the information needed to evaluate all node tests. In particular (a) it can't be used to evaluate a node test of the form element(N,T) or schema-element(E) where it is necessary to know whether the node is nilled, and (b) it can't be used to evaluate a node test of the form document-node(element(X)). This in practice means that it is used (a) to evaluate the simple node tests found in the XPath 1.0 subset used in XML Schema, and (b) to evaluate node tests where the node kind is known to be an attribute.- Specified by:
matches
in classNodeTest
- Parameters:
nodeKind
- The kind of node to be matchedname
- identifies the expanded name of the node to be matched. The value should be null for a node with no name.annotation
- The actual content type of the node. Null means no constraint.- Returns:
- true if the node matches this node test
-
getPrimitiveItemType
public AtomicType getPrimitiveItemType()
Description copied from class:NodeTest
Get the primitive item type corresponding to this item type. For item(), this is Type.ITEM. For node(), it is Type.NODE. For specific node kinds, it is the value representing the node kind, for example Type.ELEMENT. For anyAtomicValue it is Type.ATOMIC_VALUE. For numeric it is Type.NUMBER. For other atomic types it is the primitive type as defined in XML Schema, except that INTEGER is considered to be a primitive type.- Specified by:
getPrimitiveItemType
in interfaceItemType
- Specified by:
getPrimitiveItemType
in interfacePlainType
- Overrides:
getPrimitiveItemType
in classNodeTest
- Returns:
- the corresponding primitive type
-
getPrimitiveType
public int getPrimitiveType()
Description copied from class:NodeTest
Get the basic kind of object that this ItemType matches: for a NodeTest, this is the kind of node, or Type.Node if it matches different kinds of nodes.- Specified by:
getPrimitiveType
in interfaceItemType
- Overrides:
getPrimitiveType
in classNodeTest
- Returns:
- the node kind matched by this node test
-
getDefaultPriority
public double getDefaultPriority()
Description copied from class:NodeTest
Determine the default priority to use if this node-test appears as a match pattern for a template with no explicit priority attribute.- Specified by:
getDefaultPriority
in interfaceAtomicType
- Specified by:
getDefaultPriority
in interfaceItemType
- Specified by:
getDefaultPriority
in classNodeTest
- Returns:
- the default priority for the pattern
-
getAtomizedItemType
public AtomicType getAtomizedItemType()
Description copied from class:NodeTest
Get the item type of the atomic values that will be produced when an item of this type is atomized (assuming that atomization succeeds)- Specified by:
getAtomizedItemType
in interfaceItemType
- Overrides:
getAtomizedItemType
in classNodeTest
- Returns:
- the best available item type of the atomic values that will be produced when an item of this type is atomized, or null if it is known that atomization will throw an error.
-
isAtomizable
public boolean isAtomizable(TypeHierarchy th)
Description copied from class:NodeTest
Ask whether values of this type are atomizable- Specified by:
isAtomizable
in interfaceItemType
- Overrides:
isAtomizable
in classNodeTest
- Parameters:
th
- The type hierarchy cache- Returns:
- true unless it is known that these items will be elements with element-only content, in which case return false
-
getResultTypeOfCast
public SequenceType getResultTypeOfCast()
Description copied from interface:UnionType
Get the result type of a cast operation to this union type, as a sequence type.- Specified by:
getResultTypeOfCast
in interfaceUnionType
- Returns:
- the result type of casting, as precisely as possible. For example, if all the member types of the union are derived from the same primitive type, this will return that primitive type.
-
toExportString
public java.lang.String toExportString()
Return a string representation of this ItemType suitable for use in stylesheet export files. This differs from the result of toString() in that it will not contain any references to anonymous types. Note that it may also use the Saxon extended syntax for union types and tuple types. The default implementation returns the result of callingtoString()
.- Specified by:
toExportString
in interfaceItemType
- Returns:
- the string representation as an instance of the XPath SequenceType construct
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
validate
public ValidationFailure validate(AtomicValue primValue, UnicodeString lexicalValue, ConversionRules rules)
Validate that a primitive atomic value is a valid instance of a type derived from the same primitive type.- Specified by:
validate
in interfaceAtomicType
- Parameters:
primValue
- the value in the value space of the primitive type.lexicalValue
- the value in the lexical space. If null, the string value of primValue is used. This value is checked against the pattern facet (if any)rules
- the conversion rules- Returns:
- null if the value is valid; otherwise, a ValidationFailure object indicating the nature of the error.
- Throws:
java.lang.UnsupportedOperationException
- in the case of an external object type
-
isOrdered
public boolean isOrdered(boolean optimistic)
Determine whether the atomic type is ordered, that is, whether less-than and greater-than comparisons are permitted- Specified by:
isOrdered
in interfaceAtomicType
- Parameters:
optimistic
- if true, the function takes an optimistic view, returning true if ordering comparisons are available for some subtype. This mainly affects xs:duration, where the function returns true if optimistic is true, false if it is false.- Returns:
- true if ordering operations are permitted
-
isAbstract
public boolean isAbstract()
Determine whether the type is abstract, that is, whether it cannot have instances that are not also instances of some concrete subtype- Specified by:
isAbstract
in interfaceAtomicType
- Returns:
- true if the type is abstract
-
isPrimitiveType
public boolean isPrimitiveType()
Determine whether the atomic type is a primitive type. The primitive types are the 19 primitive types of XML Schema, plus xs:integer, xs:dayTimeDuration and xs:yearMonthDuration; xs:untypedAtomic; and all supertypes of these (xs:anyAtomicType, xs:numeric, ...)- Specified by:
isPrimitiveType
in interfaceAtomicType
- Returns:
- true if the type is considered primitive under the above rules
-
getStructuredQName
public StructuredQName getStructuredQName()
Get the name of this type as a StructuredQName, unless the type is anonymous, in which case return null- Specified by:
getStructuredQName
in interfaceSchemaType
- Specified by:
getStructuredQName
in interfaceUnionType
- Returns:
- the name of the atomic type, or null if the type is anonymous.
-
checkAgainstFacets
public ValidationFailure checkAgainstFacets(AtomicValue value, ConversionRules rules)
Validate an atomic value, which is known to be an instance of one of the member types of the union, against any facets (pattern facets or enumeration facets) defined at the level of the union itself.- Specified by:
checkAgainstFacets
in interfaceUnionType
- Parameters:
value
- the Atomic Value to be checked. This must be an instance of a member type of the unionrules
- the ConversionRules for the Configuration- Returns:
- a ValidationFailure if the value is not valid; null if it is valid.
-
explainMismatch
public java.util.Optional<java.lang.String> explainMismatch(Item item, TypeHierarchy th)
Get extra diagnostic information about why a supplied item does not conform to this item type, if available. If extra information is returned, it should be in the form of a complete sentence, minus the closing full stop. No information should be returned for obvious cases.- Specified by:
explainMismatch
in interfaceAtomicType
- Specified by:
explainMismatch
in interfaceItemType
- Specified by:
explainMismatch
in interfaceUnionType
- Overrides:
explainMismatch
in classNodeTest
- Parameters:
item
- the item that doesn't match this typeth
- the type hierarchy cache- Returns:
- optionally, a message explaining why the item does not match the type
-
getComponentAsFunction
public FunctionItem 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:
getComponentAsFunction
in interfaceSchemaComponent
- Returns:
- the schema component represented as a function from property names to property values.
-
-