public class NumericType extends java.lang.Object implements UnionType, PlainType
ItemType.WithSequenceTypeCache
DERIVATION_EXTENSION, DERIVATION_LIST, DERIVATION_RESTRICTION, DERIVATION_UNION, DERIVE_BY_SUBSTITUTION
COMPONENT_FUNCTION_TYPE, FIXED_UP, INCOMPLETE, INVALID, UNVALIDATED, VALIDATED, VALIDATING
Modifier and Type | Method and Description |
---|---|
boolean |
allowsDerivation(int derivation)
Determines whether derivation (of a particular kind)
from this type is allowed, based on the "final" property
|
void |
analyzeContentExpression(Expression expression,
int kind)
Analyze an XPath 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 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.
|
boolean |
containsListType()
Ask whether the union contains a list type among its member types
|
java.lang.String |
generateJavaScriptItemTypeAcceptor(java.lang.String errorCode,
int targetVersion)
Generate Javascript code to convert a supplied Javascript value to this item type,
if conversion is possible, or throw an error otherwise.
|
java.lang.String |
generateJavaScriptItemTypeTest(ItemType knownToBe,
int targetVersion)
Generate Javascript code to test whether an item conforms to this item type
|
PlainType |
getAtomizedItemType()
Get the item type of the atomic values that will be produced when an item
of this type is atomized
|
SchemaType |
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 as
SchemaType.DERIVATION_LIST and SchemaType.DERIVATION_EXTENSION . |
SchemaType |
getBuiltInBaseType()
Get the built-in type from which this type is derived by restriction
|
Function |
getComponentAsFunction()
Get the schema component in the form of a function item.
|
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 error messages.
|
java.lang.String |
getDisplayName()
Get the display name of the type: that is, a lexical QName with an arbitrary prefix
|
java.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 type
|
static NumericType |
getInstance() |
java.lang.String |
getName()
Get the local name of this type
|
java.lang.Iterable<PlainType> |
getPlainMemberTypes()
Get the "plain" types in the transitive membership.
|
AtomicType |
getPrimitiveItemType()
Get the primitive item type corresponding to this item type.
|
int |
getPrimitiveType()
Get the primitive type corresponding to this item type.
|
int |
getRedefinitionLevel()
Get the redefinition level.
|
SequenceType |
getResultTypeOfCast()
Get the result type of a cast operation to this union type, as a sequence type.
|
StructuredQName |
getStructuredQName()
Get the name of the type as a StructuredQName
|
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 type
|
AtomicSequence |
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
|
StructuredQName |
getTypeName()
Get the name of this type as a structured QName
|
UType |
getUType()
Get the corresponding
UType . |
int |
getValidationStatus()
Get the validation status of this component.
|
int |
getWhitespaceAction()
Determine how values of this simple type are whitespace-normalized.
|
boolean |
isAnonymousType()
Test whether this is an anonymous type
|
boolean |
isAtomicType()
Test whether this Simple Type is an atomic type
|
boolean |
isAtomizable()
Ask whether values of this type are atomizable
|
boolean |
isBuiltInType()
Determine whether this is a built-in type or a user-defined type
|
boolean |
isComplexType()
Test whether this SchemaType is a complex type
|
boolean |
isExternalType()
Return true if this is an external object type, that is, a Saxon-defined type for external
Java or .NET objects
|
boolean |
isIdRefType()
Ask whether this type is an IDREF or IDREFS type.
|
boolean |
isIdType()
Ask whether this type is an ID type.
|
boolean |
isListType()
Test whether this Simple Type is a list type
|
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.
|
boolean |
isPlainType()
Determine whether this item type is a plain type (that is, whether it can ONLY match
atomic values)
|
boolean |
isSameType(SchemaType other)
Test whether this is the same type as another type.
|
boolean |
isSimpleType()
Test whether this SchemaType is a simple type
|
boolean |
isUnionType()
Test whether this Simple Type is a union type
|
boolean |
matches(Item item,
TypeHierarchy th)
Test whether a given item conforms to this type
|
java.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.
|
java.lang.String |
toExportString()
Return a string representation of this SequenceType suitable for use in export (SEF) files.
|
java.lang.String |
toString() |
ValidationFailure |
validateContent(java.lang.CharSequence value,
NamespaceResolver nsResolver,
ConversionRules rules)
Check whether a given input string is valid according to this SimpleType
|
void |
visitNamedSchemaComponents(SchemaComponentVisitor visitor)
Visit all the schema components used in this ItemType definition
|
public static NumericType getInstance()
public StructuredQName getTypeName()
PlainType
getTypeName
in interface PlainType
public boolean containsListType()
containsListType
in interface UnionType
public java.lang.Iterable<PlainType> getPlainMemberTypes()
getPlainMemberTypes
in interface PlainType
getPlainMemberTypes
in interface UnionType
public SequenceType getResultTypeOfCast()
getResultTypeOfCast
in interface UnionType
public boolean isPlainType()
isPlainType
in interface ItemType
public boolean matches(Item item, TypeHierarchy th)
public AtomicType getPrimitiveItemType()
getPrimitiveItemType
in interface ItemType
getPrimitiveItemType
in interface PlainType
public int getPrimitiveType()
getPrimitiveType
in interface ItemType
public UType getUType()
UType
. A UType is a union of primitive item
types.public PlainType getAtomizedItemType()
getAtomizedItemType
in interface ItemType
public boolean isAtomizable()
isAtomizable
in interface ItemType
public void visitNamedSchemaComponents(SchemaComponentVisitor visitor) throws XPathException
visitNamedSchemaComponents
in interface ItemType
visitor
- the visitor class to be called when each component is visitedXPathException
- if an error occurspublic boolean isAtomicType()
isAtomicType
in interface ItemType
isAtomicType
in interface SchemaType
isAtomicType
in interface SimpleType
public boolean isListType()
isListType
in interface SimpleType
public boolean isUnionType()
isUnionType
in interface SimpleType
public boolean isExternalType()
isExternalType
in interface PlainType
isExternalType
in interface SimpleType
public boolean isBuiltInType()
isBuiltInType
in interface SimpleType
public SchemaType getBuiltInBaseType()
getBuiltInBaseType
in interface SimpleType
public AtomicSequence getTypedValue(java.lang.CharSequence value, NamespaceResolver resolver, ConversionRules rules) throws ValidationException
getTypedValue
in interface SimpleType
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 configurationAtomicValue
,
The next() method on the iterator throws no checked exceptions, although it is not actually
declared as an UnfailingIterator.ValidationException
- if the supplied value is not in the lexical space of the data typepublic ValidationFailure validateContent(java.lang.CharSequence value, NamespaceResolver nsResolver, ConversionRules rules)
validateContent
in interface SimpleType
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 configurationjava.lang.UnsupportedOperationException
- if the type is namespace-sensitive and no namespace
resolver is suppliedpublic ValidationFailure checkAgainstFacets(AtomicValue value, ConversionRules rules)
checkAgainstFacets
in interface UnionType
value
- the Atomic Value to be checked. This must be an instance of a member type of the
unionrules
- the ConversionRules for the Configurationpublic boolean isNamespaceSensitive()
isNamespaceSensitive
in interface SimpleType
public int getWhitespaceAction()
getWhitespaceAction
in interface SimpleType
Whitespace.PRESERVE
, Whitespace.COLLAPSE
,
Whitespace.REPLACE
.public java.lang.CharSequence preprocess(java.lang.CharSequence input) throws ValidationException
preprocess
in interface SimpleType
input
- the value to be preprocessedValidationException
- if preprocessing detects that the value is invalidpublic java.lang.CharSequence postprocess(java.lang.CharSequence input) throws ValidationException
postprocess
in interface SimpleType
input
- the value to be postprocessed: this is the "ordinary" result of converting
the value to a stringValidationException
- if postprocessing detects that the value is invalidpublic java.lang.String getName()
getName
in interface SchemaType
public java.lang.String getTargetNamespace()
getTargetNamespace
in interface SchemaType
public int getFingerprint()
getFingerprint
in interface SchemaType
public java.lang.String getDisplayName()
getDisplayName
in interface SchemaType
public java.lang.String getEQName()
getEQName
in interface SchemaType
public StructuredQName getStructuredQName()
getStructuredQName
in interface SchemaType
public boolean isComplexType()
isComplexType
in interface SchemaType
public boolean isSimpleType()
isSimpleType
in interface SchemaType
public boolean isAnonymousType()
isAnonymousType
in interface SchemaType
public int getBlock()
SchemaType.DERIVATION_LIST
and SchemaType.DERIVATION_EXTENSION
.
This corresponds to the property "prohibited substitutions" in the schema component model.getBlock
in interface SchemaType
public SchemaType getBaseType()
getBaseType
in interface SchemaType
public int getDerivationMethod()
getDerivationMethod
in interface SchemaType
SchemaType.DERIVATION_RESTRICTION
public int getFinalProhibitions()
getFinalProhibitions
in interface SchemaType
SchemaType.DERIVATION_EXTENSION
public boolean allowsDerivation(int derivation)
allowsDerivation
in interface SchemaType
derivation
- the kind of derivation, for example SchemaType.DERIVATION_LIST
public void analyzeContentExpression(Expression expression, int kind) throws XPathException
analyzeContentExpression
in interface SchemaType
expression
- the expression that delivers the contentkind
- the node kind whose content is being delivered: Type.ELEMENT
,
Type.ATTRIBUTE
, or Type.DOCUMENT
XPathException
- if the expression will never deliver a value of the correct typepublic AtomicSequence atomize(NodeInfo node) throws XPathException
atomize
in interface SchemaType
node
- the node whose typed value is requiredXPathException
- if the node cannot be atomized, for example if this is a complex type
with element-only contentpublic boolean isSameType(SchemaType other)
isSameType
in interface SchemaType
other
- the other typepublic java.lang.String getDescription()
getDescription
in interface SchemaType
public void checkTypeDerivationIsOK(SchemaType base, int block) throws SchemaException
checkTypeDerivationIsOK
in interface SchemaType
base
- the base type; the algorithm tests whether derivation from this type is permittedblock
- the derivations that are blocked by the relevant element declarationSchemaException
- if the derivation is not allowedpublic java.lang.String getSystemId()
getSystemId
in interface SchemaType
public boolean isIdType()
isIdType
in interface SchemaType
public boolean isIdRefType()
isIdRefType
in interface SchemaType
public int getValidationStatus()
getValidationStatus
in interface SchemaComponent
SchemaComponent.UNVALIDATED
, SchemaComponent.VALIDATING
,
SchemaComponent.VALIDATED
, SchemaComponent.INVALID
, SchemaComponent.INCOMPLETE
public int getRedefinitionLevel()
getRedefinitionLevel
in interface SchemaComponent
public Function getComponentAsFunction()
getComponentAsFunction
in interface SchemaComponent
public java.lang.String toString()
public java.lang.String toExportString()
toExportString
in interface ItemType
public java.lang.String generateJavaScriptItemTypeTest(ItemType knownToBe, int targetVersion)
generateJavaScriptItemTypeTest
in interface ItemType
knownToBe
- targetVersion
- public java.lang.String generateJavaScriptItemTypeAcceptor(java.lang.String errorCode, int targetVersion) throws XPathException
generateJavaScriptItemTypeAcceptor
in interface ItemType
errorCode
- the error to be thrown if conversion is not possibletargetVersion
- XPathException
Copyright (c) 2004-2018 Saxonica Limited. All rights reserved.