Package net.sf.saxon.type
Class NumericType
java.lang.Object
net.sf.saxon.type.LocalUnionType
net.sf.saxon.type.NumericType
- All Implemented Interfaces:
CastingTarget,HyperType,ItemType,PlainType,SchemaComponent,SchemaType,SimpleType,UnionType
Singleton class representing the class xs:numeric as defined in XPath 3.1: a union type
whose members are xs:double, xs:decimal, and xs:float
-
Method Summary
Modifier and TypeMethodDescriptionbooleanallowsDerivation(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 XPath expression to see whether the expression is capable of delivering a value of this type.Get the typed value of a node that is annotated with this schema type.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.voidcheckTypeDerivationIsOK(SchemaType base, int block) Check that this type is validly derived from a given type, following the rules for the Schema Component Constraint "Is Type Derivation OK (Simple)" (3.14.6) or "Is Type Derivation OK (Complex)" (3.4.6) as appropriate.booleanAsk whether the union contains a list type among its member typesGet the item type of the atomic values that will be produced when an item of this type is atomizedReturns the base type that this type inherits from.Get an alphabetic code representing the type, or at any rate, the nearest built-in type from which this type is derived.intgetBlock()Returns the value of the 'block' attribute for this type, as a bit-significant integer with fields such asDerivation.DERIVATION_LISTandDerivation.DERIVATION_EXTENSION.Get the built-in type from which this type is derived by restrictionGet the schema component in the form of a function item.doubleGet the default priority when this ItemType is used as an XSLT patternintGets the integer code of the derivation method used to derive this type from its parent.Get a description of this type for use in error messages.Get the display name of the type: that is, a lexical QName with an arbitrary prefixGet the name of this type as an EQName, that is, a string in the format Q{uri}local.intGet the types of derivation that are not permitted, by virtue of the "final" property.intGet the fingerprint of the name of this typegetGenre()Get the genre of this itemstatic NumericTypegetName()Get the local name of this typeGet the "plain" types in the transitive membership.Get the primitive item type corresponding to this item type.intGet the primitive type corresponding to this item type.intGet the redefinition level.Get the result type of a cast operation to this union type, as a sequence type.Get the name of the type as a StructuredQNameGet the URI of the schema document where the type was originally defined.Get the target namespace of this typegetTypedValue(UnicodeString value, NamespaceResolver resolver, ConversionRules rules) Get the typed value corresponding to a given string value, assuming it is valid against this typeGet the name of this type as a structured QNamegetUType()Get the correspondingUType.Get the validation status of this component.intDetermine how values of this simple type are whitespace-normalized.booleanTest whether this is an anonymous typebooleanTest whether this Simple Type is an atomic typebooleanAsk whether values of this type are atomizablebooleanDetermine whether this is a built-in type or a user-defined typebooleanTest whether this SchemaType is a complex typebooleanAsk whether this type is an IDREF or IDREFS type.booleanisIdType()Ask whether this type is an ID type.booleanTest whether this Simple Type is a list typebooleanTest whether this type is namespace sensitive, that is, if a namespace context is needed to translate between the lexical space and the value space.static booleanisNumericType(ItemType type) Ask whether a given atomic type is numeric, that is, whether it is a subtype of xs:double, xs:float, or xs:decimalbooleanDetermine whether this item type is a plain type (that is, whether it can ONLY match atomic values)booleanisSameType(SchemaType other) Test whether this is the same type as another type.booleanTest whether this SchemaType is a simple typebooleanTest whether this Simple Type is a union typebooleanmatches(Item item, TypeHierarchy th) Test whether a given item conforms to this typepostprocess(UnicodeString input) Reverse any pre-lexical facets, other than whitespace.preprocess(UnicodeString input) Apply any pre-lexical facets, other than whitespace.Return a string representation of this ItemType suitable for use in stylesheet export files.toString()Produce a string representation of the type name.validateContent(UnicodeString value, NamespaceResolver nsResolver, ConversionRules rules) Check whether a given input string is valid according to this SimpleTypeMethods inherited from class net.sf.saxon.type.LocalUnionType
getMemberTypesMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface net.sf.saxon.type.ItemType
getFullAlphaCode, getNormalizedDefaultPriorityMethods inherited from interface net.sf.saxon.type.UnionType
explainMismatch
-
Method Details
-
getInstance
-
getTypeName
Description copied from interface:PlainTypeGet the name of this type as a structured QName- Specified by:
getTypeNamein interfacePlainType- Specified by:
getTypeNamein interfaceUnionType- Overrides:
getTypeNamein classLocalUnionType- Returns:
- the name of this type. If the type is anonymous, an internally-generated type name is returned
-
getGenre
Get the genre of this item- Specified by:
getGenrein interfaceItemType- Overrides:
getGenrein classLocalUnionType- Returns:
- the genre
-
getBasicAlphaCode
Get an alphabetic code representing the type, or at any rate, the nearest built-in type from which this type is derived. The codes are designed so that for any two built-in types A and B, alphaCode(A) is a prefix of alphaCode(B) if and only if A is a supertype of B.- Specified by:
getBasicAlphaCodein interfaceItemType- Overrides:
getBasicAlphaCodein classLocalUnionType- Returns:
- the alphacode for the nearest containing built-in type
-
containsListType
public boolean containsListType()Ask whether the union contains a list type among its member types- Specified by:
containsListTypein interfaceUnionType- Overrides:
containsListTypein classLocalUnionType- Returns:
- true of one of the member types is a list type
-
getPlainMemberTypes
Get the "plain" types in the transitive membership. Plain types are atomic types and union types that are defined directly in terms of other plain types, without adding any restriction facets.- Specified by:
getPlainMemberTypesin interfacePlainType- Specified by:
getPlainMemberTypesin interfaceUnionType- Overrides:
getPlainMemberTypesin classLocalUnionType- Returns:
- the atomic types and plain union types in the transitive membership of the union type.
-
isNumericType
Ask whether a given atomic type is numeric, that is, whether it is a subtype of xs:double, xs:float, or xs:decimal -
getResultTypeOfCast
Get the result type of a cast operation to this union type, as a sequence type.- Specified by:
getResultTypeOfCastin interfaceUnionType- Overrides:
getResultTypeOfCastin classLocalUnionType- 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.
-
isPlainType
public boolean isPlainType()Determine whether this item type is a plain type (that is, whether it can ONLY match atomic values)- Specified by:
isPlainTypein interfaceItemType- Overrides:
isPlainTypein classLocalUnionType- Returns:
- true if this is ANY_ATOMIC_TYPE or a subtype thereof, or a "plain" union type (that is, unions of atomic types that impose no further restrictions)
-
getDefaultPriority
public double getDefaultPriority()Get the default priority when this ItemType is used as an XSLT pattern- Specified by:
getDefaultPriorityin interfaceItemType- Overrides:
getDefaultPriorityin classLocalUnionType- Returns:
- the default priority. This is the same as the union type (xs:double, xs:float, xs:decimal), namely 0.125 (= 0.5 * 0.5 * 0.5)
-
matches
Test whether a given item conforms to this type -
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 and union types 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, xs:dayTimeDuration, and xs:yearMonthDuration are considered to be primitive types.- Specified by:
getPrimitiveItemTypein interfaceItemType- Specified by:
getPrimitiveItemTypein interfacePlainType- Overrides:
getPrimitiveItemTypein classLocalUnionType- 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 BuiltInAtomicType.ANY_ATOMIC. 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:
getPrimitiveTypein interfaceItemType- Overrides:
getPrimitiveTypein classLocalUnionType- Returns:
- the integer fingerprint of the corresponding primitive type
-
getUType
Get the correspondingUType. A UType is a union of primitive item types.- Specified by:
getUTypein interfaceItemType- Overrides:
getUTypein classLocalUnionType- Returns:
- the smallest UType that subsumes this item type
-
getAtomizedItemType
Get the item type of the atomic values that will be produced when an item of this type is atomized- Specified by:
getAtomizedItemTypein interfaceItemType- Overrides:
getAtomizedItemTypein classLocalUnionType- 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
Ask whether values of this type are atomizable- Specified by:
isAtomizablein interfaceItemType- Overrides:
isAtomizablein classLocalUnionType- Parameters:
th- The type hierarchy cache- Returns:
- true unless it is known that these items will be elements with element-only content, or function items, in which case return false
-
isAtomicType
public boolean isAtomicType()Test whether this Simple Type is an atomic type- Specified by:
isAtomicTypein interfaceItemType- Specified by:
isAtomicTypein interfaceSchemaType- Specified by:
isAtomicTypein interfaceSimpleType- Overrides:
isAtomicTypein classLocalUnionType- Returns:
- true if this is an atomic type
-
isListType
public boolean isListType()Test whether this Simple Type is a list type- Specified by:
isListTypein interfaceSimpleType- Overrides:
isListTypein classLocalUnionType- Returns:
- true if this is a list type
-
isUnionType
public boolean isUnionType()Test whether this Simple Type is a union type- Specified by:
isUnionTypein interfaceSimpleType- Overrides:
isUnionTypein classLocalUnionType- Returns:
- true if this is a union type
-
isBuiltInType
public boolean isBuiltInType()Determine whether this is a built-in type or a user-defined type- Specified by:
isBuiltInTypein interfaceSimpleType- Overrides:
isBuiltInTypein classLocalUnionType- Returns:
- true if this is a built-in type
-
getBuiltInBaseType
Get 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.
-
getTypedValue
public DoubleValue 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:
getTypedValuein interfaceSimpleType- Specified by:
getTypedValuein interfaceUnionType- Overrides:
getTypedValuein classLocalUnionType- 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 from the configuration- 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 SequenceIterator. - Throws:
ValidationException- if the supplied value is not in the lexical space of the data type
-
validateContent
public ValidationFailure validateContent(UnicodeString value, NamespaceResolver nsResolver, ConversionRules rules) Check whether a given input string is valid according to this SimpleType- Specified by:
validateContentin interfaceSimpleType- Overrides:
validateContentin classLocalUnionType- 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 from the configuration- Returns:
- null if validation succeeds; or return a ValidationFailure describing the validation failure if validation fails. Note that the exception is returned rather than being thrown.
- Throws:
UnsupportedOperationException- if the type is namespace-sensitive and no namespace resolver is supplied
-
checkAgainstFacets
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:
checkAgainstFacetsin interfaceUnionType- Overrides:
checkAgainstFacetsin classLocalUnionType- 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.
-
isNamespaceSensitive
public boolean 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. This is true for types derived from, or containing, QNames and NOTATIONs- Specified by:
isNamespaceSensitivein interfaceHyperType- Overrides:
isNamespaceSensitivein classLocalUnionType- Returns:
- true if the type is namespace-sensitive
-
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.
-
preprocess
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
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
-
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
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.
-
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
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. In the case of an anonymous type, an internally-generated name is returned
-
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. In the case of an anonymous type, an internally-generated name is returned
-
getStructuredQName
Get the name of the type as a StructuredQName- Specified by:
getStructuredQNamein interfaceSchemaType- Specified by:
getStructuredQNamein interfaceUnionType- Returns:
- a StructuredQName identifying the type. In the case of an anonymous type, an internally-generated name is returned
-
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
-
isAnonymousType
public boolean isAnonymousType()Test whether this is an anonymous type- Specified by:
isAnonymousTypein interfaceSchemaType- Returns:
- true if this SchemaType is an anonymous type
-
getBlock
public int getBlock()Returns the value of the 'block' attribute for this type, as a bit-significant integer with fields such asDerivation.DERIVATION_LISTandDerivation.DERIVATION_EXTENSION. This corresponds to the property "prohibited substitutions" in the schema component model.- Specified by:
getBlockin interfaceSchemaType- Returns:
- the value of the 'block' attribute for this type
-
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:
getBaseTypein interfaceSchemaType- Returns:
- the base type, or null if this is xs:anyType (the root of the type hierarchy)
-
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
Derivation.DERIVATION_RESTRICTION
-
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
Derivation.DERIVATION_EXTENSION
-
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 exampleDerivation.DERIVATION_LIST- Returns:
- true if this kind of derivation is allowed
-
analyzeContentExpression
Analyze an XPath expression to see whether the expression is capable of delivering a value of this type. This method is called during static analysis of a query or stylesheet to give compile-time warnings when "impossible" paths are used.- 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
-
atomize
Get the typed value of a node that is annotated with this schema type.- 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. Changed in 9.5 to return the new type AtomicSequence
-
isSameType
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
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:
getDescriptionin interfaceSchemaType- Specified by:
getDescriptionin interfaceUnionType- Overrides:
getDescriptionin classLocalUnionType- Returns:
- text identifing the type, for use in a phrase such as "the type XXXX".
-
getSystemId
Get the URI of the schema document where the type was originally defined.- Specified by:
getSystemIdin interfaceSchemaType- Returns:
- the URI of the schema document. Returns null if the information is unknown or if this is a built-in 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 in XSD 1.0, its typed value must be a *single* atomic value of type ID; the type of the node, however, can still allow a list. But in XSD 1.1, a list of IDs is permitted- Specified by:
isIdTypein interfaceSchemaType- Overrides:
isIdTypein classLocalUnionType- 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- Overrides:
isIdRefTypein classLocalUnionType- Returns:
- true if this type is an IDREF type
-
getValidationStatus
Get the validation status of this component.- Specified by:
getValidationStatusin interfaceSchemaComponent- Returns:
- one of the values
SchemaValidationStatus.UNVALIDATED,SchemaValidationStatus.VALIDATING,SchemaValidationStatus.VALIDATED,SchemaValidationStatus.INVALID,SchemaValidationStatus.INCOMPLETE
-
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
-
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:
toExportStringin interfaceItemType- Overrides:
toExportStringin classLocalUnionType- Returns:
- the string representation as an instance of the XPath SequenceType construct
-
toString
Description copied from class:LocalUnionTypeProduce a string representation of the type name. If the type is anonymous, an internally-allocated type name will be returned.- Overrides:
toStringin classLocalUnionType- Returns:
- the name of the atomic type in the form Q{uri}local
-
checkTypeDerivationIsOK
Check that this type is validly derived from a given type, following the rules for the Schema Component Constraint "Is Type Derivation OK (Simple)" (3.14.6) or "Is Type Derivation OK (Complex)" (3.4.6) as appropriate.- Specified by:
checkTypeDerivationIsOKin interfaceSchemaType- Parameters:
base- the base type; the algorithm tests whether derivation from this type is permittedblock- the derivations that are blocked by the relevant element declaration- Throws:
SchemaException- if the derivation is not allowed
-
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.
-