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,javax.xml.transform.SourceLocator,Location,AtomicType,CastingTarget,ItemType,PlainType,SchemaComponent,SchemaType,SimpleType,org.xml.sax.Locator
public class UserAtomicType extends UserSimpleType implements AtomicType
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).
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface net.sf.saxon.type.ItemType
ItemType.WithSequenceTypeCache
-
Nested classes/interfaces inherited from interface net.sf.saxon.type.SchemaComponent
SchemaComponent.ValidationStatus
-
-
Field Summary
-
Fields inherited from class com.saxonica.ee.schema.UserDefinedType
extendedTypes, finalProhibitions
-
Fields inherited from interface net.sf.saxon.type.SchemaComponent
COMPONENT_FUNCTION_TYPE
-
Fields inherited from interface net.sf.saxon.type.SchemaType
DERIVATION_EXTENSION, DERIVATION_LIST, DERIVATION_RESTRICTION, DERIVATION_UNION, DERIVE_BY_SUBSTITUTION
-
-
Constructor Summary
Constructors Constructor Description UserAtomicType(EnterpriseConfiguration config)Create a UserAtomicType
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description AtomicTypegetAtomizedItemType()Get the item type of the atomic values that will be produced when an item of this type is atomizedjava.lang.StringgetBasicAlphaCode()Get an alphabetic code representing the type, or at any rate, the nearest built-in type from which this type is derived.java.util.Set<? extends PlainType>getPlainMemberTypes()Get the set of atomic types that are subsumed by this typeAtomicTypegetPrimitiveItemType()Get the primitive type from which this type is derived.intgetPrimitiveType()Get the primitive type from which this type is derived.java.lang.StringgetSharedInstance(java.lang.String value)Get an instance of the facet value that is stored in the schema rather than the instanceStringConvertergetStringConverter(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.AtomicValuegetTypedValue(java.lang.CharSequence value, NamespaceResolver resolver, ConversionRules rules)Get the typed value corresponding to a given string value, assuming it is valid against this typeUTypegetUType()Get the correspondingUType.inthashCode()Returns a hash code value for the object.booleanisAbstract()Determine whether the type is abstract, that is, whether it cannot have instances that are not also instances of some concrete subtypebooleanisAtomicType()Test whether this Simple Type is an atomic typebooleanisAtomizable(TypeHierarchy th)Ask whether values of this type are atomizablebooleanisBuiltInType()Determine whether this is a built-in type or a user-defined typebooleanisCompilable()Ask whether it is possible to generate bytecode to perform validation against this atomic typebooleanisIdRefType()Ask whether this type is an IDREF or IDREFS type.booleanisIdType()Ask whether this type is an ID type.booleanisNamespaceSensitive()Test whether this simple type is namespace-sensitive, that is, whether it is derived from xs:QName or xs:NOTATIONbooleanisOrdered(boolean optimistic)Determine whether the atomic type is ordered, that is, whether less-than and greater-than comparisons are permittedbooleanisPlainType()Ask whether this is a plain type (a type whose instances are always atomic values)booleanisPrimitiveType()Determine whether the atomic type is a primitive type.booleanmatches(Item item, TypeHierarchy th)Test whether a given item conforms to this typevoidserializeVariety(SchemaModelSerializer serializer)Serialize the schema componentvoidsetUncompilable(boolean flag)Say that compilation to bytecode for this type has failed, and should not be attempted againjava.lang.StringtoExportString()Return a string representation of this ItemType suitable for use in stylesheet export files.java.lang.StringtoString()Produce a string representation of the type name.booleanvalidate(SchemaCompiler compiler)Checks the validity of this SimpleType definition.ValidationFailurevalidate(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.ValidationFailurevalidateContent(java.lang.CharSequence value, NamespaceResolver nsResolver, ConversionRules rules)Check whether a given input string is valid according to this SimpleType-
Methods 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, 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, getTypeName
-
Methods inherited from interface net.sf.saxon.type.ItemType
getFullAlphaCode, getNormalizedDefaultPriority, isTrueItemType
-
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, getNearestNamedType, 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 Detail
-
UserAtomicType
public UserAtomicType(EnterpriseConfiguration config)
Create a UserAtomicType- Parameters:
config- the Saxon configuration
-
-
Method Detail
-
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 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:
isPlainTypein 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:
isIdTypein interfaceAtomicType- Specified by:
isIdTypein interfaceSchemaType- Overrides:
isIdTypein classUserSimpleType- Returns:
- true if this type is an ID type
-
isIdRefType
public boolean isIdRefType() throws MissingComponentExceptionAsk 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 interfaceAtomicType- Specified by:
isIdRefTypein interfaceSchemaType- Overrides:
isIdRefTypein 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:
isBuiltInTypein interfaceAtomicType- Specified by:
isBuiltInTypein interfaceSimpleType- Returns:
- true if this is a built-in type
-
getBasicAlphaCode
public java.lang.String 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- 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:
isPrimitiveTypein interfaceAtomicType- Returns:
- true if the type is considered primitive under the above rules
-
getUType
public UType 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:
isOrderedin 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:
isAbstractin interfaceAtomicType- Returns:
- false (always)
-
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:
getStringConverterin 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
public boolean validate(SchemaCompiler compiler) throws SchemaException
Checks the validity of this SimpleType definition.- Specified by:
validatein interfaceUserSchemaComponent- Overrides:
validatein 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
public boolean matches(Item item, TypeHierarchy th)
Test whether a given item conforms to this type
-
isCompilable
public boolean isCompilable()
Ask whether it is possible to generate bytecode to perform validation against this atomic type- Returns:
- true if bytecode generation is possible
-
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:
validateContentin 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:
java.lang.UnsupportedOperationException- if the type is namespace-sensitive and no namespace resolver is supplied
-
getTypedValue
public AtomicValue 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- Specified by:
getTypedValuein 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
public AtomicType getPrimitiveItemType()
Get the primitive type from which this type is derived. For the definition of primitive types, seeType.isPrimitiveAtomicType(int)- Specified by:
getPrimitiveItemTypein interfaceItemType- Specified by:
getPrimitiveItemTypein 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:
getPrimitiveTypein 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:
isNamespaceSensitivein interfacePlainType- Specified by:
isNamespaceSensitivein interfaceSimpleType- Returns:
- true if this type is derived from xs:QName or xs:NOTATION
-
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:
getAtomizedItemTypein 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
public boolean isAtomizable(TypeHierarchy th)
Ask whether values of this type are atomizable- Specified by:
isAtomizablein 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
-
getSharedInstance
public java.lang.String getSharedInstance(java.lang.String value)
Get an instance of the facet value that is stored in the schema rather than the instance- Parameters:
value- the value required- Returns:
- a string which is equal to the value required, but which if possible is the instance held in the compiled schema, reducing storage requirements in instances.
-
toString
public java.lang.String toString()
Produce a string representation of the type name. If the type is anonymous, an internally-allocated type name will be returned.- Specified by:
toStringin interfaceItemType- Overrides:
toStringin classUserDefinedType- Returns:
- the name of the atomic type in the form Q{uri}local
-
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:
toExportStringin 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.- Overrides:
hashCodein 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:
validatein 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:
java.lang.UnsupportedOperationException- in the case of an external object type
-
serializeVariety
public void serializeVariety(SchemaModelSerializer serializer) throws XPathException
Serialize the schema component- Specified by:
serializeVarietyin classUserSimpleType- Throws:
XPathException
-
getPlainMemberTypes
public java.util.Set<? extends PlainType> getPlainMemberTypes()
Get the set of atomic types that are subsumed by this type- Specified by:
getPlainMemberTypesin interfacePlainType- Returns:
- for an atomic type, the type itself; for a union type, the set of atomic types in its transitive membership
-
setUncompilable
public void setUncompilable(boolean flag)
Say that compilation to bytecode for this type has failed, and should not be attempted again- Parameters:
flag- true if bytecode generation has failed
-
-