Package com.saxonica.ee.schema
Class UserAtomicType
java.lang.Object
com.saxonica.ee.schema.SchemaStructure
com.saxonica.ee.schema.UserDefinedType
com.saxonica.ee.schema.UserSimpleType
com.saxonica.ee.schema.UserAtomicType
- All Implemented Interfaces:
SerializableSchemaComponent
,UserSchemaComponent
,SourceLocator
,Location
,AtomicType
,CastingTarget
,HyperType
,ItemType
,PlainType
,SchemaComponent
,SchemaType
,SimpleType
,Locator
An object belonging to this class represents an atomic type: either a built-in
atomic type, or a user-defined atomic type. There is at most one AtomicType
object for each distinct type in the schema (so equality can safely be tested
using the == operator).
-
Field Summary
Fields inherited from class com.saxonica.ee.schema.UserDefinedType
extendedTypes, finalProhibitions
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionGet the item type of the atomic values that will be produced when an item of this type is atomizedGet an alphabetic code representing the type, or at any rate, the nearest built-in type from which this type is derived.Get the set of atomic types that are subsumed by this typeGet the primitive type from which this type is derived.int
Get the primitive type from which this type is derived.getSharedInstance
(String value) Get an instance of the facet value that is stored in the schema rather than the instanceGet 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.getTypedValue
(UnicodeString value, NamespaceResolver resolver, ConversionRules rules) Get the typed value corresponding to a given string value, assuming it is valid against this typegetUType()
Get the correspondingUType
.int
hashCode()
Returns a hash code value for the object.boolean
Determine whether the type is abstract, that is, whether it cannot have instances that are not also instances of some concrete subtypeboolean
Test whether this Simple Type is an atomic typeboolean
Ask whether values of this type are atomizableboolean
Determine whether this is a built-in type or a user-defined typeboolean
Ask whether this type is an IDREF or IDREFS type.boolean
isIdType()
Ask whether this type is an ID type.boolean
Test whether this simple type is namespace-sensitive, that is, whether it is derived from xs:QName or xs:NOTATIONboolean
isOrdered
(boolean optimistic) Determine whether the atomic type is ordered, that is, whether less-than and greater-than comparisons are permittedboolean
Ask whether this is a plain type (a type whose instances are always atomic values)boolean
Determine whether the atomic type is a primitive type.boolean
matches
(Item item, TypeHierarchy th) Test whether a given item conforms to this typeprotected void
serializeVariety
(SchemaModelSerializer serializer) Serialize the schema componentReturn a string representation of this ItemType suitable for use in stylesheet export files.toString()
Produce a string representation of the type name.boolean
validate
(SchemaCompiler compiler) Checks the validity of this SimpleType definition.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.validateContent
(UnicodeString value, NamespaceResolver nsResolver, ConversionRules rules) Check whether a given input string is valid according to this SimpleTypeMethods inherited from class com.saxonica.ee.schema.UserSimpleType
addFacet, addInheritedFacets, analyzeContentExpression, applyWhitespaceNormalization, atomize, checkAgainstFacets, checkTypeDerivationIsOK, convertFacetValues, elaborate, getBuiltInBaseType, getComponentAsFunction, getComponentAsFunction, getContextComponent, getEQName, getExtendedFacetList, getFacet, getLocalFacetList, getWhitespaceAction, isListType, isSimpleType, isTypeDerivationOK, isUnionType, makeValidationFailure, mergeEnumerationFacets, postprocess, preprocess, serialize, setContextComponent, setFacetList
Methods inherited from class com.saxonica.ee.schema.UserDefinedType
allowsDerivation, containingDeclarationIsElement, getBaseType, getBaseTypeFingerprint, getBaseTypeReference, getBlock, getContainingDeclarationName, getDepth, getDerivationMethod, getDescription, getDisplayName, getExtensionTypes, getFinalProhibitions, getFingerprint, getName, getNamePool, getStructuredQName, getTargetNamespace, getTypeName, isAnonymousType, isComplexType, isSameType, isSameURI, registerExtensionType, setBaseTypeReference, setContainingDeclaration, setDerivationMethod, setDerivationMethodName, setExtendedTypes, setFinalProhibitions, setTypeName
Methods inherited from class com.saxonica.ee.schema.SchemaStructure
fixup, getColumnNumber, getConfiguration, getFixupStatus, getGeneratedId, getLineNumber, getPublicId, getRedefinitionLevel, getSchemaDocumentURI, getSystemId, getValidationStatus, hasSameLocation, isValidationNeeded, lookForCycles, makeXPathExpressionPropertyRecord, saveLocation, setConfiguration, setFixupStatus, setGeneratedId, setLineNumber, setLocator, setRedefinitionLevel, setSchemaDocumentURI, setSystemId, setValidationStatus
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface net.sf.saxon.type.AtomicType
explainMismatch, getDefaultPriority, getGenre, getPrimitiveAtomicType, getTypeName
Methods inherited from interface net.sf.saxon.type.ItemType
getFullAlphaCode, getNormalizedDefaultPriority
Methods inherited from interface net.sf.saxon.type.SchemaComponent
getComponentAsFunction, getRedefinitionLevel, getValidationStatus
Methods inherited from interface net.sf.saxon.type.SchemaType
allowsDerivation, analyzeContentExpression, atomize, checkTypeDerivationIsOK, getBaseType, getBlock, getDerivationMethod, getDescription, getDisplayName, getEQName, getFinalProhibitions, getFingerprint, getName, getStructuredQName, getSystemId, getTargetNamespace, isAnonymousType, isComplexType, isSameType, isSimpleType
Methods inherited from interface net.sf.saxon.type.SimpleType
getBuiltInBaseType, getWhitespaceAction, isListType, isUnionType, postprocess, preprocess
Methods inherited from interface com.saxonica.ee.schema.UserSchemaComponent
fixup, lookForCycles
-
Constructor Details
-
UserAtomicType
Create a UserAtomicType- Parameters:
config
- the Saxon configuration
-
-
Method Details
-
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 classUserSimpleType
- Returns:
- true, this is an atomic 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
-
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
- Overrides:
isIdType
in classUserSimpleType
- Returns:
- true if this type is an ID type
-
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
- Overrides:
isIdRefType
in classUserSimpleType
- Returns:
- true if this type is an IDREF type
- Throws:
MissingComponentException
-
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
-
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:
getBasicAlphaCode
in interfaceItemType
- Returns:
- the alphacode for the nearest containing built-in type
-
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
-
getUType
Get the correspondingUType
. A UType is a union of primitive item types. -
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:
- false (always)
-
getStringConverter
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.
-
validate
Checks the validity of this SimpleType definition.- Specified by:
validate
in interfaceUserSchemaComponent
- Overrides:
validate
in classUserSimpleType
- Parameters:
compiler
- used for error reporting- Returns:
- true when this Schema definition is valid, otherwise false.
- Throws:
SchemaException
- when this SimpleType definition is invalid.
-
matches
Test whether a given item conforms to this 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:
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 for this Configuration- Returns:
- null if validation succeeds; return a ValidationFailure describing the validation failure if validation fails.
- Throws:
UnsupportedOperationException
- if the type is namespace-sensitive and no namespace resolver is supplied
-
getTypedValue
public AtomicValue 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
- Parameters:
value
- the string valueresolver
- the namespace resolverrules
- the conversion rules for the Saxon configuration- Returns:
- an iterator over the atomic sequence comprising the typed value
- Throws:
ValidationException
- if the supplied value is not in the lexical space of the data type
-
getPrimitiveItemType
Get the primitive type from which this type is derived. For the definition of primitive types, seeType.isPrimitiveAtomicType(int)
- Specified by:
getPrimitiveItemType
in interfaceItemType
- Specified by:
getPrimitiveItemType
in interfacePlainType
- Returns:
- the type code of the primitive type
-
getPrimitiveType
public int getPrimitiveType()Get the primitive type from which this type is derived. For the definition of primitive types, seeType.isPrimitiveAtomicType(int)
- Specified by:
getPrimitiveType
in interfaceItemType
- Returns:
- the type code of the primitive type
-
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 interfaceHyperType
- Returns:
- true if this type is derived from xs:QName or xs:NOTATION
-
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, or null if it is known that atomization will throw an error.
-
isAtomizable
Ask whether values of this type are atomizable- Specified by:
isAtomizable
in interfaceItemType
- 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
-
toString
Produce a string representation of the type name. If the type is anonymous, an internally-allocated type name will be returned.- Overrides:
toString
in classUserDefinedType
- Returns:
- the name of the atomic type in the form Q{uri}local
-
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
-
hashCode
public int hashCode()Returns a hash code value for the 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 used for this configuration- Returns:
- null if the value is valid; otherwise, a ValidationFailure object indicating the nature of the error.
- Throws:
UnsupportedOperationException
- in the case of an external object type
-
serializeVariety
Serialize the schema component- Specified by:
serializeVariety
in classUserSimpleType
- Throws:
XPathException
-
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
-