public class EnumerationType extends java.lang.Object implements AtomicType
The XPath syntax proposed is enum("A", "B", "C")
Constructor and Description |
---|
EnumerationType(java.util.Set<java.lang.String> values)
Create an enumeration type permitting a defined set of values
|
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.
|
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.
|
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.
|
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.
|
int |
getBlock()
Returns the value of the 'block' attribute for this type, as a bit-significant
integer with fields such as
Derivation.DERIVATION_LIST and Derivation.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.
|
double |
getDefaultPriority()
Get the default priority when this ItemType is used as an XSLT pattern.
|
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
|
java.lang.String |
getName()
Get the local name of this type
|
java.util.List<? extends PlainType> |
getPlainMemberTypes()
Get the list of plain types that are subsumed by this type
|
AtomicType |
getPrimitiveItemType()
Redeclare getPrimitiveItemType() to return a more specific result type
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.
|
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.
|
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(UnicodeString 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 StructuredQName, unless the type is anonymous, in which case
return null
|
UType |
getUType()
Get the corresponding
UType . |
SchemaValidationStatus |
getValidationStatus()
Get the validation status of this component.
|
int |
getWhitespaceAction()
Determine how values of this simple type are whitespace-normalized.
|
boolean |
isAbstract()
Determine whether the type is abstract, that is, whether it cannot have instances that are not also
instances of some concrete subtype
|
boolean |
isAnonymousType()
Test whether this is an anonymous type
|
boolean |
isAtomicType()
Test whether this Simple Type is an atomic type
|
boolean |
isAtomizable(TypeHierarchy th)
Ask whether values of this type are atomizable
|
boolean |
isBuiltInType()
Determine whether the atomic type is a built-in type.
|
boolean |
isComplexType()
Test whether this SchemaType is a complex type
|
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 |
isOrdered(boolean optimistic)
Determine whether the atomic type is ordered, that is, whether less-than and greater-than comparisons
are permitted
|
boolean |
isPlainType()
Determine whether this item type is a plain type (that is, whether it can ONLY match
atomic values)
|
boolean |
isPrimitiveType()
Determine whether the atomic type is a primitive type.
|
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
|
UnicodeString |
postprocess(UnicodeString input)
Reverse any pre-lexical facets, other than whitespace.
|
UnicodeString |
preprocess(UnicodeString input)
Apply any pre-lexical facets, other than whitespace.
|
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.
|
ValidationFailure |
validateContent(UnicodeString value,
NamespaceResolver nsResolver,
ConversionRules rules)
Check whether a given input string is valid according to this SimpleType
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
explainMismatch, getGenre, getPrimitiveAtomicType
getFullAlphaCode, getNormalizedDefaultPriority, toExportString
public EnumerationType(java.util.Set<java.lang.String> values)
values
- the values to be permittedpublic ValidationFailure validate(AtomicValue primValue, UnicodeString lexicalValue, ConversionRules rules)
validate
in interface AtomicType
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 for this configurationjava.lang.UnsupportedOperationException
- in the case of an external object typepublic boolean isOrdered(boolean optimistic)
isOrdered
in interface AtomicType
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.public boolean isAbstract()
isAbstract
in interface AtomicType
public boolean isPrimitiveType()
isPrimitiveType
in interface AtomicType
public boolean isIdType()
isIdType
in interface AtomicType
isIdType
in interface SchemaType
public boolean isIdRefType()
isIdRefType
in interface AtomicType
isIdRefType
in interface SchemaType
public boolean isBuiltInType()
isBuiltInType
in interface AtomicType
isBuiltInType
in interface SimpleType
public StructuredQName getTypeName()
getTypeName
in interface AtomicType
getTypeName
in interface PlainType
public double getDefaultPriority()
AtomicType
getDefaultPriority
in interface AtomicType
getDefaultPriority
in interface ItemType
public StringConverter getStringConverter(ConversionRules rules)
getStringConverter
in interface AtomicType
rules
- the conversion rules to be usedpublic java.util.List<? extends PlainType> getPlainMemberTypes()
getPlainMemberTypes
in interface PlainType
public boolean matches(Item item, TypeHierarchy th)
public AtomicType getPrimitiveItemType()
getPrimitiveItemType
in interface ItemType
getPrimitiveItemType
in interface PlainType
public boolean isPlainType()
isPlainType
in interface ItemType
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(TypeHierarchy th)
isAtomizable
in interface ItemType
th
- the type hierarchy cachepublic java.lang.String getBasicAlphaCode()
getBasicAlphaCode
in interface ItemType
public 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 SchemaType getBuiltInBaseType()
getBuiltInBaseType
in interface SimpleType
public AtomicSequence getTypedValue(UnicodeString 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
,ValidationException
- if the supplied value is not in the lexical space of the data typepublic ValidationFailure validateContent(UnicodeString 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 boolean isNamespaceSensitive()
isNamespaceSensitive
in interface HyperType
public int getWhitespaceAction()
getWhitespaceAction
in interface SimpleType
Whitespace.PRESERVE
, Whitespace.COLLAPSE
,
Whitespace.REPLACE
.public UnicodeString preprocess(UnicodeString input) throws ValidationException
preprocess
in interface SimpleType
input
- the value to be preprocessedValidationException
- if preprocessing detects that the value is invalidpublic UnicodeString postprocess(UnicodeString 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 StructuredQName getStructuredQName()
getStructuredQName
in interface SchemaType
public java.lang.String getEQName()
getEQName
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()
Derivation.DERIVATION_LIST
and Derivation.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
Derivation.DERIVATION_RESTRICTION
public int getFinalProhibitions()
getFinalProhibitions
in interface SchemaType
Derivation.DERIVATION_EXTENSION
public boolean allowsDerivation(int derivation)
allowsDerivation
in interface SchemaType
derivation
- the kind of derivation, for example Derivation.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 SchemaValidationStatus getValidationStatus()
getValidationStatus
in interface SchemaComponent
SchemaValidationStatus.UNVALIDATED
, SchemaValidationStatus.VALIDATING
,
SchemaValidationStatus.VALIDATED
, SchemaValidationStatus.INVALID
, SchemaValidationStatus.INCOMPLETE
public int getRedefinitionLevel()
getRedefinitionLevel
in interface SchemaComponent
public Function getComponentAsFunction()
getComponentAsFunction
in interface SchemaComponent
Copyright (c) 2004-2022 Saxonica Limited. All rights reserved.