Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
java.lang.Object
net.sf.saxon.type.BuiltInAtomicType
Fields inherited from interface net.sf.saxon.type.SchemaComponent | |
FIXED_UP , INCOMPLETE , INVALID , UNVALIDATED , VALIDATED , VALIDATING |
Fields inherited from interface net.sf.saxon.type.SchemaType | |
DERIVATION_EXTENSION , DERIVATION_LIST , DERIVATION_RESTRICTION , DERIVATION_UNION , DERIVE_BY_SUBSTITUTION |
Method Summary | |
boolean |
|
void |
|
static void |
|
Value | |
void |
|
boolean |
|
AtomicType |
|
SchemaType |
|
int |
|
SchemaType |
|
AtomicType |
|
int |
|
String | |
String |
|
int |
|
SchemaType |
|
String |
|
int |
|
ItemType |
|
int |
|
StructuredQName |
|
ItemType |
|
String |
|
String |
|
SequenceIterator |
|
SequenceIterator |
|
int |
|
int |
|
int |
|
static void |
|
boolean |
|
boolean |
|
boolean |
|
boolean |
|
boolean |
|
boolean |
|
boolean |
|
boolean |
|
boolean |
|
boolean |
|
boolean |
|
boolean |
|
boolean |
|
boolean |
|
boolean |
|
boolean |
|
void |
|
String |
|
String | |
ValidationFailure |
|
ValidationFailure |
|
public final boolean allowsDerivation(int derivation)
Determines whether derivation (of a particular kind) from this type is allowed, based on the "final" property
- Specified by:
- allowsDerivation in interface SchemaType
- Parameters:
derivation
- the kind of derivation, for exampleSchemaType.DERIVATION_LIST
- Returns:
- true if this kind of derivation is allowed
public void analyzeContentExpression(Expression expression, int kind, StaticContext env) throws XPathException
Analyze an expression to see whether the expression is capable of delivering a value of this type.
- Specified by:
- analyzeContentExpression in interface SchemaType
- Parameters:
expression
- the expression that delivers the contentkind
- the node kind whose content is being delivered:Type.ELEMENT
,Type.ATTRIBUTE
, orType.DOCUMENT
env
- the static context
- Throws:
XPathException
- if the expression will never deliver a value of the correct type
public static void analyzeContentExpression(SimpleType simpleType, Expression expression, StaticContext env, int kind) throws XPathException
Analyze an expression to see whether the expression is capable of delivering a value of this type.
- Parameters:
simpleType
- the simple type against which the expression is to be checkedexpression
- the expression that delivers the contentenv
- the static context of the expressionkind
- 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
public Value atomize(NodeInfo node) throws XPathException
Get the typed value of a node that is annotated with this schema type. The result of this method will always be consistent with the methodgetTypedValue
. However, this method is often more convenient and may be more efficient, especially in the common case where the value is expected to be a singleton.
- Specified by:
- atomize in interface SchemaType
- Parameters:
node
- the node whose typed value is required
- Returns:
- the typed value.
- Since:
- 8.5
public void checkTypeDerivationIsOK(SchemaType type, int block) throws SchemaException
Check that this type is validly derived from a given type
- Specified by:
- checkTypeDerivationIsOK in interface SchemaType
- Parameters:
type
- the type from which this type is derivedblock
- the derivations that are blocked by the relevant element declaration
- Throws:
SchemaException
- if the derivation is not allowed
public boolean equals(Object obj)
Two types are equal if they have the same fingerprint. Note: it is normally safe to use ==, because we always use the static constants, one instance for each built in atomic type. However, after serialization and deserialization a different instance can appear.
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:
- getAtomizedItemType in interface ItemType
public final SchemaType 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:
- getBaseType in interface SchemaType
- Returns:
- the base type.
public final int getBlock()
Returns the value of the 'block' attribute for this type, as a bit-significant integer with fields such asSchemaType.DERIVATION_LIST
andSchemaType.DERIVATION_EXTENSION
- Specified by:
- getBlock in interface SchemaType
- Returns:
- the value of the 'block' attribute for this type
public SchemaType getBuiltInBaseType()
Returns the built-in base type this type is derived from.
- Specified by:
- getBuiltInBaseType in interface SimpleType
- Returns:
- the first built-in type found when searching up the type hierarchy
public AtomicType getCommonAtomicType()
Get the most specific possible atomic type that all items in this SimpleType belong to
- Specified by:
- getCommonAtomicType in interface SimpleType
- Returns:
- the lowest common supertype of all member types
public final 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:
- getDerivationMethod in interface SchemaType
- Returns:
- a numeric code representing the derivation method, for example
SchemaType.DERIVATION_RESTRICTION
public String getDisplayName()
Get the display name of the type: that is, a lexical QName with an arbitrary prefix
- Specified by:
- getDisplayName in interface SchemaType
- Returns:
- a lexical QName identifying the type
public int getFingerprint()
Get the fingerprint of the name of this type
- Specified by:
- getFingerprint in interface SchemaType
- Returns:
- the fingerprint. Returns an invented fingerprint for an anonymous type.
public SchemaType getKnownBaseType()
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.
- Returns:
- the base type.
public String getName()
Get the local name of this type
- Specified by:
- getName in interface SchemaType
- Returns:
- the local name of this type definition, if it has one. Return null in the case of an anonymous type.
public int getNameCode()
Get the namecode of the name of this type. This includes the prefix from the original type declaration: in the case of built-in types, there may be a conventional prefix or there may be no prefix.
- Specified by:
- getNameCode in interface SchemaType
public ItemType 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 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 is considered to be a primitive type.
- Specified by:
- getPrimitiveItemType in interface ItemType
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 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 is considered to be a primitive type.
- Specified by:
- getPrimitiveType in interface ItemType
public StructuredQName getQualifiedName()
Get the name of the type as a QName
- Returns:
- a StructuredQName containing the name of the type. The conventional prefix "xs" is used to represent the XML Schema namespace
public ItemType getSuperType(TypeHierarchy th)
Get the type from which this item type is derived by restriction. This is the supertype in the XPath type heirarchy, as distinct from the Schema base type: this means that the supertype of xs:boolean is xs:anyAtomicType, whose supertype is item() (rather than xs:anySimpleType).
- Specified by:
- getSuperType in interface ItemType
- Parameters:
th
- the type hierarchy cache, not used in this implementation
- Returns:
- the supertype, or null if this type is item()
public String getSystemId()
Get the URI of the schema document where the type was originally defined.
- Specified by:
- getSystemId in interface SchemaType
- Returns:
- the URI of the schema document. Returns null if the information is unknown or if this is a built-in type
public String getTargetNamespace()
Get the target namespace of this type
- Specified by:
- getTargetNamespace in interface SchemaType
- 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.
public SequenceIterator getTypedValue(CharSequence value, NamespaceResolver resolver, NameChecker nameChecker) throws ValidationException
Get the typed value corresponding to a given string value, assuming it is valid against this type
- Specified by:
- getTypedValue in interface SimpleType
- 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.nameChecker
- XML 1.0 or 1.1 name checker. May be null if name checking is not required
- Returns:
- an iterator over the atomic sequence comprising the typed value. The objects returned by this SequenceIterator will all be of type
AtomicValue
public final SequenceIterator getTypedValue(NodeInfo node) throws XPathException
Get the typed value of a node that is annotated with this schema type
- Specified by:
- getTypedValue in interface SchemaType
- Parameters:
node
- the node whose typed value is required
- Returns:
- an iterator over the items making up the typed value of this node. The objects returned by this SequenceIterator will all be of type
AtomicValue
public final int getValidationStatus()
Get the validation status - always valid
- Specified by:
- getValidationStatus in interface SchemaComponent
public int getWhitespaceAction(TypeHierarchy th)
Determine the whitespace normalization required for values of this type
- Specified by:
- getWhitespaceAction in interface SimpleType
- Parameters:
th
- the type hierarchy cache
- Returns:
- one of PRESERVE, REPLACE, COLLAPSE
public int hashCode()
The fingerprint can be used as a hashcode
public static void init()
Static initialization
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 interface AtomicType
public boolean isAllowedInBasicXSLT()
Determine whether this type is supported in a basic XSLT processor
- Returns:
- true if this type is permitted in a basic XSLT processor
public boolean isAnonymousType()
Test whether this is an anonymous type
- Specified by:
- isAnonymousType in interface SchemaType
- Returns:
- true if this SchemaType is an anonymous type
public boolean isAtomicType()
Test whether this Simple Type is an atomic type
- Specified by:
- isAtomicType in interface SimpleType
- isAtomicType in interface SchemaType
- isAtomicType in interface ItemType
- Returns:
- true, this is an atomic type
public boolean isBuiltInType()
Determine whether this is a built-in type or a user-defined type
- Specified by:
- isBuiltInType in interface AtomicType
- isBuiltInType in interface SimpleType
public final boolean isComplexType()
Test whether this SchemaType is a complex type
- Specified by:
- isComplexType in interface SchemaType
- Returns:
- true if this SchemaType is a complex type
public boolean isExternalType()
Return true if this is an external object type, that is, a Saxon-defined type for external Java or .NET objects
- Specified by:
- isExternalType in interface SimpleType
public boolean isListType()
Returns true if this type is derived by list, or if it is derived by restriction from a list type, or if it is a union that contains a list as one of its members
- Specified by:
- isListType in interface SimpleType
- Returns:
- true if this is a list type
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 interface SimpleType
- Returns:
- true if this type is derived from xs:QName or xs:NOTATION
public boolean isOrdered()
Determine whether the atomic type is ordered, that is, whether less-than and greater-than comparisons are permitted
- Specified by:
- isOrdered in interface AtomicType
- Returns:
- true if ordering operations are permitted
public boolean isPrimitiveNumeric()
Determine whether the atomic type is numeric
- Returns:
- true if the type is a built-in numeric type
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 interface AtomicType
- Returns:
- true if the type is considered primitive under the above rules
public boolean isSameType(SchemaType other)
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:
- isSameType in interface SchemaType
public final boolean isSimpleType()
Returns true if this SchemaType is a SimpleType
- Specified by:
- isSimpleType in interface SchemaType
- Returns:
- true (always)
public boolean isUnionType()
Return true if this type is a union type (that is, if its variety is union)
- Specified by:
- isUnionType in interface SimpleType
- Returns:
- true for a union type
public boolean matchesItem(Item item, boolean allowURIPromotion, Configuration config)
Test whether a given item conforms to this type
- Specified by:
- matchesItem in interface ItemType
- Parameters:
item
- The item to be testedallowURIPromotion
- true if we regard a URI as effectively a subtype of Stringconfig
- the Saxon configuration (used to locate the type hierarchy cache)
- Returns:
- true if the item is an instance of this type; false otherwise
public final void setBaseTypeFingerprint(int baseFingerprint)
Set the base type of this type
- Parameters:
baseFingerprint
- the namepool fingerprint of the name of the base type
public String toString()
public String toString(NamePool pool)
Produce a representation of this type name for use in error messages. Where this is a QName, it will use conventional prefixes
public ValidationFailure validate(AtomicValue primValue, CharSequence lexicalValue, NameChecker checker)
Validate that a primitive atomic value is a valid instance of a type derived from the same primitive type.
- Specified by:
- validate in interface AtomicType
- 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)checker
- Used to check names against XML 1.0 or XML 1.1 syntax rules
- Returns:
- null if the value is valid; otherwise, a ValidationFailure object indicating the nature of the error.
public ValidationFailure validateContent(CharSequence value, NamespaceResolver nsResolver, NameChecker nameChecker)
Check whether a given input string is valid according to this SimpleType
- Specified by:
- validateContent in interface SimpleType
- 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.nameChecker
- XML 1.0 or 1.1 name checker. Must not be null.
- Returns:
- XPathException if the value is invalid. Note that the exception is returned rather than being thrown. Returns null if the value is valid.