Package net.sf.saxon.type
Class BuiltInAtomicType
- java.lang.Object
-
- net.sf.saxon.type.BuiltInAtomicType
-
- All Implemented Interfaces:
java.io.Serializable
,AtomicType
,ItemType
,PlainType
,SchemaComponent
,SchemaType
,SimpleType
public class BuiltInAtomicType extends java.lang.Object implements AtomicType, java.io.Serializable
This class represents a built-in atomic type, which may be either a primitive type (such as xs:decimal or xs:anyURI) or a derived type (such as xs:ID or xs:dayTimeDuration).- See Also:
- Serialized Form
-
-
Field Summary
-
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
-
-
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, StaticContext env)
Analyze an expression to see whether the expression is capable of delivering a value of this type.static void
analyzeContentExpression(SimpleType simpleType, Expression expression, StaticContext env, int kind)
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 typeboolean
equals(java.lang.Object obj)
Two types are equal if they have the same fingerprint.AtomicType
getAtomizedItemType()
Get the item type of the atomic values that will be produced when an item of this type is atomizedSchemaType
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-significant integer with fields such asSchemaType.DERIVATION_LIST
andSchemaType.DERIVATION_EXTENSION
SchemaType
getBuiltInBaseType()
Returns the built-in base type this type is derived from.double
getDefaultPriority()
Determine the default priority of this item type when used on its own as a Patternint
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 typeSchemaType
getKnownBaseType()
Returns the base type that this type inherits from.java.lang.String
getName()
Get the local name of this typeint
getNameCode()
Get the namecode of the name of this type.java.util.Set<PlainType>
getPlainMemberTypes()
Get the set of atomic types that are subsumed by this typeItemType
getPrimitiveItemType()
Get the primitive item type corresponding to this item type.int
getPrimitiveType()
Get the primitive type corresponding to this item type.StructuredQName
getQualifiedName()
Get the name of the type as a QNameint
getRedefinitionLevel()
Get the redefinition level.ItemType
getSuperType(TypeHierarchy th)
Get the type from which this item type is derived by restriction.java.lang.String
getSystemId()
Get the URI of the schema document where the type was originally defined.java.lang.String
getTargetNamespace()
Get the target namespace of this typeSequenceIterator
getTypedValue(java.lang.CharSequence value, NamespaceResolver resolver, ConversionRules rules)
Get the typed value corresponding to a given string value, assuming it is valid against this type (and that the containing node is not nilled)SequenceIterator
getTypedValue(NodeInfo node)
Get the typed value of a node that is annotated with this schema typeStructuredQName
getTypeName()
Get the name of this type as a StructuredQName, unless the type is anonymous, in which case return nullint
getValidationStatus()
Get the validation status - always validint
getWhitespaceAction()
Determine the whitespace normalization required for values of this typeint
hashCode()
The fingerprint can be used as a hashcodeboolean
isAbstract()
Determine whether the type is abstract, that is, whether it cannot have instances that are not also instances of some concrete subtypeboolean
isAllowedInBasicXSLT()
Determine whether this type is supported in a basic XSLT 2.0 processor (all types are allowed in a basic XSLT 3.0 processor)boolean
isAllowedInXSD10()
Determine whether this type is supported when using XSD 1.0boolean
isAnonymousType()
Ask whether this is an anonymous typeboolean
isAtomicType()
Test whether this Simple Type is an atomic typeboolean
isAtomizable()
Ask whether values of this type are atomizableboolean
isBuiltInType()
Determine whether this is a built-in type or a user-defined typeboolean
isComplexType()
Ask 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 simple type is namespace-sensitive, that is, whether it is derived from xs:QName or xs:NOTATIONboolean
isOrdered()
Determine whether the atomic type is ordered, that is, whether less-than and greater-than comparisons are permittedboolean
isPlainType()
Ask whether this is a plain type (a type whose instances are always atomic values)boolean
isPrimitiveNumeric()
Determine whether the atomic type is numericboolean
isPrimitiveType()
Ask whether the atomic type is a primitive type.boolean
isSameType(SchemaType other)
Test whether this is the same type as another type.boolean
isSimpleType()
Returns true if this SchemaType is a SimpleTypeboolean
isUnionType()
Return true if this type is a union type (that is, if its variety is union)boolean
matches(Item item, XPathContext context)
Test whether a given item conforms to this typeboolean
matchesItem(Item item, boolean allowURIPromotion, Configuration config)
Test whether a given item conforms to this 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.void
setBaseTypeFingerprint(int baseFingerprint)
Set the base type of this typejava.lang.String
toString()
java.lang.String
toString(NamePool pool)
Produce a representation of this type name for use in error messages.ValidationFailure
validate(AtomicValue primValue, java.lang.CharSequence lexicalValue, ConversionRules rules)
Validate that a primitive atomic value is a valid instance of a type derived from the same primitive type.ValidationFailure
validateContent(java.lang.CharSequence value, NamespaceResolver nsResolver, ConversionRules rules)
Check whether a given input string is valid according to this SimpleTypevoid
visitNamedSchemaComponents(SchemaComponentVisitor visitor)
Visit all the schema components used in this ItemType definition
-
-
-
Field Detail
-
fingerprint
int fingerprint
-
baseFingerprint
int baseFingerprint
-
primitiveFingerprint
int primitiveFingerprint
-
ordered
boolean ordered
-
ANY_ATOMIC
public static BuiltInAtomicType ANY_ATOMIC
-
NUMERIC
public static BuiltInAtomicType NUMERIC
-
STRING
public static BuiltInAtomicType STRING
-
BOOLEAN
public static BuiltInAtomicType BOOLEAN
-
DURATION
public static BuiltInAtomicType DURATION
-
DATE_TIME
public static BuiltInAtomicType DATE_TIME
-
DATE
public static BuiltInAtomicType DATE
-
TIME
public static BuiltInAtomicType TIME
-
G_YEAR_MONTH
public static BuiltInAtomicType G_YEAR_MONTH
-
G_MONTH
public static BuiltInAtomicType G_MONTH
-
G_MONTH_DAY
public static BuiltInAtomicType G_MONTH_DAY
-
G_YEAR
public static BuiltInAtomicType G_YEAR
-
G_DAY
public static BuiltInAtomicType G_DAY
-
HEX_BINARY
public static BuiltInAtomicType HEX_BINARY
-
BASE64_BINARY
public static BuiltInAtomicType BASE64_BINARY
-
ANY_URI
public static BuiltInAtomicType ANY_URI
-
QNAME
public static BuiltInAtomicType QNAME
-
NOTATION
public static BuiltInAtomicType NOTATION
-
UNTYPED_ATOMIC
public static BuiltInAtomicType UNTYPED_ATOMIC
-
DECIMAL
public static BuiltInAtomicType DECIMAL
-
FLOAT
public static BuiltInAtomicType FLOAT
-
DOUBLE
public static BuiltInAtomicType DOUBLE
-
INTEGER
public static BuiltInAtomicType INTEGER
-
NON_POSITIVE_INTEGER
public static BuiltInAtomicType NON_POSITIVE_INTEGER
-
NEGATIVE_INTEGER
public static BuiltInAtomicType NEGATIVE_INTEGER
-
LONG
public static BuiltInAtomicType LONG
-
INT
public static BuiltInAtomicType INT
-
SHORT
public static BuiltInAtomicType SHORT
-
BYTE
public static BuiltInAtomicType BYTE
-
NON_NEGATIVE_INTEGER
public static BuiltInAtomicType NON_NEGATIVE_INTEGER
-
POSITIVE_INTEGER
public static BuiltInAtomicType POSITIVE_INTEGER
-
UNSIGNED_LONG
public static BuiltInAtomicType UNSIGNED_LONG
-
UNSIGNED_INT
public static BuiltInAtomicType UNSIGNED_INT
-
UNSIGNED_SHORT
public static BuiltInAtomicType UNSIGNED_SHORT
-
UNSIGNED_BYTE
public static BuiltInAtomicType UNSIGNED_BYTE
-
YEAR_MONTH_DURATION
public static BuiltInAtomicType YEAR_MONTH_DURATION
-
DAY_TIME_DURATION
public static BuiltInAtomicType DAY_TIME_DURATION
-
NORMALIZED_STRING
public static BuiltInAtomicType NORMALIZED_STRING
-
TOKEN
public static BuiltInAtomicType TOKEN
-
LANGUAGE
public static BuiltInAtomicType LANGUAGE
-
NAME
public static BuiltInAtomicType NAME
-
NMTOKEN
public static BuiltInAtomicType NMTOKEN
-
NCNAME
public static BuiltInAtomicType NCNAME
-
ID
public static BuiltInAtomicType ID
-
IDREF
public static BuiltInAtomicType IDREF
-
ENTITY
public static BuiltInAtomicType ENTITY
-
DATE_TIME_STAMP
public static BuiltInAtomicType DATE_TIME_STAMP
-
-
Method Detail
-
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.
-
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
-
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 interfacePlainType
- 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 interfaceAtomicType
- Specified by:
isBuiltInType
in interfaceSimpleType
- Returns:
- true if this is a built-in type
-
getTypeName
public StructuredQName getTypeName()
Get the name of this type as a StructuredQName, unless the type is anonymous, in which case return null- Specified by:
getTypeName
in interfaceAtomicType
- Returns:
- the name of the atomic type, or null if the type is anonymous.
-
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
-
isOrdered
public boolean isOrdered()
Determine whether the atomic type is ordered, that is, whether less-than and greater-than comparisons are permitted- Specified by:
isOrdered
in interfaceAtomicType
- Returns:
- true if ordering operations are permitted
-
getSystemId
public java.lang.String getSystemId()
Get the URI of the schema document where the type was originally defined.- Specified by:
getSystemId
in interfaceSchemaType
- Returns:
- the URI of the schema document. Returns null if the information is unknown or if this is a built-in type
-
isPrimitiveNumeric
public boolean isPrimitiveNumeric()
Determine whether the atomic type is numeric- Returns:
- true if the type is a built-in numeric type
-
getValidationStatus
public final 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
-
getBlock
public final int getBlock()
Returns the value of the 'block' attribute for this type, as a bit-significant 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
-
getDerivationMethod
public final 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 final 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
-
setBaseTypeFingerprint
public final void setBaseTypeFingerprint(int baseFingerprint)
Set the base type of this type- Parameters:
baseFingerprint
- the namepool fingerprint of the name of the base type
-
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. 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 interfaceSchemaType
- Returns:
- the namecode. Returns an invented namecode for an anonymous type.
-
getQualifiedName
public StructuredQName getQualifiedName()
Get the name of the type as a QName- Returns:
- a StructuredQName containing the name of the type. The conventional prefix "xs" is used to represent the XML Schema namespace
-
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
-
isPrimitiveType
public boolean isPrimitiveType()
Ask 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
-
isComplexType
public final boolean isComplexType()
Ask whether this SchemaType is a complex type- Specified by:
isComplexType
in interfaceSchemaType
- Returns:
- true if this SchemaType is a complex type
-
isAnonymousType
public boolean isAnonymousType()
Ask whether this is an anonymous type- Specified by:
isAnonymousType
in interfaceSchemaType
- Returns:
- true if this SchemaType is an anonymous type
-
isPlainType
public boolean isPlainType()
Ask whether this is a plain type (a type whose instances are always atomic values)- Specified by:
isPlainType
in interfaceItemType
- Returns:
- true
-
getBaseType
public final SchemaType getBaseType()
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.- Specified by:
getBaseType
in interfaceSchemaType
- Returns:
- the base type.
- Throws:
java.lang.IllegalStateException
- if this type is not valid.
-
matches
public boolean matches(Item item, XPathContext context)
Test whether a given item conforms to this type
-
matchesItem
public boolean matchesItem(Item item, boolean allowURIPromotion, Configuration config)
Test whether a given item conforms to this type- Specified by:
matchesItem
in interfaceItemType
- Parameters:
item
- The item to be testedallowURIPromotion
- true if we regard a URI as effectively a subtype of Stringconfig
- the Saxon configuration (used to locate the type hierarchy cache)- Returns:
- true if the item is an instance of this type; false otherwise
-
getSuperType
public ItemType getSuperType(TypeHierarchy th)
Get the type from which this item type is derived by restriction. This is the supertype in the XPath type heirarchy, as distinct from the Schema base type: this means that the supertype of xs:boolean is xs:anyAtomicType, whose supertype is item() (rather than xs:anySimpleType).- Specified by:
getSuperType
in interfaceItemType
- Parameters:
th
- the type hierarchy cache, not used in this implementation- Returns:
- the supertype, or null if this type is item()
-
getPrimitiveItemType
public ItemType getPrimitiveItemType()
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
- Returns:
- the corresponding primitive type
-
getPrimitiveType
public int getPrimitiveType()
Get the primitive 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:
getPrimitiveType
in interfaceItemType
- Returns:
- the integer fingerprint of the corresponding primitive type
-
isAllowedInBasicXSLT
public boolean isAllowedInBasicXSLT()
Determine whether this type is supported in a basic XSLT 2.0 processor (all types are allowed in a basic XSLT 3.0 processor)- Returns:
- true if this type is permitted in a basic XSLT 2.0 processor
-
isAllowedInXSD10
public boolean isAllowedInXSD10()
Determine whether this type is supported when using XSD 1.0- Returns:
- true if this type is permitted in XSD 1.0
-
toString
public java.lang.String toString(NamePool pool)
Produce a representation of this type name for use in error messages. Where this is a QName, it will use conventional prefixes
-
getAtomizedItemType
public AtomicType getAtomizedItemType()
Get the item type of the atomic values that will be produced when an item of this type is atomized- Specified by:
getAtomizedItemType
in interfaceItemType
- Returns:
- the best available item type of the atomic values that will be produced when an item of this type is atomized
-
isAtomizable
public boolean isAtomizable()
Ask whether values of this type are atomizable- Specified by:
isAtomizable
in interfaceItemType
- Returns:
- true unless it is known that these items will be elements with element-only content, in which case return false
-
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:
java.lang.IllegalStateException
- if this type is not valid.
-
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".
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
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
-
isSimpleType
public final boolean isSimpleType()
Returns true if this SchemaType is a SimpleType- Specified by:
isSimpleType
in interfaceSchemaType
- Returns:
- true (always)
-
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
- Returns:
- true, this is 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()
Return true if this type is a union type (that is, if its variety is union)- Specified by:
isUnionType
in interfaceSimpleType
- Returns:
- true for a union type
-
getWhitespaceAction
public int getWhitespaceAction()
Determine the whitespace normalization required for values of this type- Specified by:
getWhitespaceAction
in interfaceSimpleType
- Returns:
- one of PRESERVE, REPLACE, COLLAPSE
-
getBuiltInBaseType
public SchemaType getBuiltInBaseType()
Returns the built-in base type this type is derived from.- Specified by:
getBuiltInBaseType
in interfaceSimpleType
- Returns:
- the first built-in type found when searching up the type hierarchy
-
isNamespaceSensitive
public boolean isNamespaceSensitive()
Test whether this simple type is namespace-sensitive, that is, whether it is derived from xs:QName or xs:NOTATION- Specified by:
isNamespaceSensitive
in interfaceSimpleType
- Returns:
- true if this type is derived from xs:QName or xs:NOTATION
-
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
-- Returns:
- XPathException if the value is invalid. Note that the exception is returned rather than being thrown. Returns null if the value is valid.
- Throws:
java.lang.UnsupportedOperationException
- if the type is namespace-sensitive and no namespace resolver is supplied
-
getTypedValue
public final SequenceIterator getTypedValue(NodeInfo node) throws XPathException
Get the typed value of a node that is annotated with this schema type- Specified by:
getTypedValue
in interfaceSchemaType
- Parameters:
node
- the node whose typed value is required- Returns:
- an iterator over the items making up the typed value of this node. The objects
returned by this SequenceIterator will all be 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
-
getTypedValue
public SequenceIterator getTypedValue(java.lang.CharSequence value, NamespaceResolver resolver, ConversionRules rules) throws ValidationException
Get the typed value corresponding to a given string value, assuming it is valid against this type (and that the containing node is not nilled)- Specified by:
getTypedValue
in interfaceSimpleType
- 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
-- 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
- This method should be called only if it is known that the value is valid. If the value is not valid, there is no guarantee that this method will perform validation, but if it does detect a validity error, then it MAY throw a ValidationException.
-
equals
public boolean equals(java.lang.Object obj)
Two types are equal if they have the same fingerprint. Note: it is normally safe to use ==, because we always use the static constants, one instance for each built in atomic type. However, after serialization and deserialization a different instance can appear.- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
The fingerprint can be used as a hashcode- Overrides:
hashCode
in classjava.lang.Object
-
validate
public ValidationFailure validate(AtomicValue primValue, java.lang.CharSequence 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
-- 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
-
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 static context- Throws:
XPathException
- if the expression will never deliver a value of the correct type
-
analyzeContentExpression
public static void analyzeContentExpression(SimpleType simpleType, Expression expression, StaticContext env, int kind) throws XPathException
Analyze an expression to see whether the expression is capable of delivering a value of this type.- Parameters:
simpleType
- the simple type against which the expression is to be checkedexpression
- the expression that delivers the contentenv
- the static context of the expressionkind
- 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 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
-
visitNamedSchemaComponents
public void visitNamedSchemaComponents(SchemaComponentVisitor visitor) throws XPathException
Visit all the schema components used in this ItemType definition- Specified by:
visitNamedSchemaComponents
in interfaceItemType
- Parameters:
visitor
- the visitor class to be called when each component is visited- Throws:
XPathException
- if an error occurs
-
getPlainMemberTypes
public java.util.Set<PlainType> getPlainMemberTypes()
Get the set of atomic types that are subsumed by this type- Specified by:
getPlainMemberTypes
in interfacePlainType
- Returns:
- for an atomic type, the type itself; for a union type, the set of atomic types in its transitive membership
-
getDefaultPriority
public double getDefaultPriority()
Description copied from interface:ItemType
Determine the default priority of this item type when used on its own as a Pattern- Specified by:
getDefaultPriority
in interfaceItemType
- Returns:
- the default priority
-
-