net.sf.saxon.type

Class ExternalObjectType

Implemented Interfaces:
AtomicType, ItemType, SchemaComponent, SchemaType, Serializable, SimpleType

public class ExternalObjectType
extends java.lang.Object
implements AtomicType, Serializable

This class represents the type of an external Java object returned by an extension function, or supplied as an external variable/parameter.

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

Constructor Summary

ExternalObjectType(Class javaClass, Configuration config)
Create an external object type

Method Summary

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, StaticContext env)
Analyze an expression to see whether the expression is capable of delivering a value of this type.
static void
analyzeContentExpression(SimpleType simpleType, Expression expression, StaticContext env, int kind)
Analyze an expression to see whether the expression is capable of delivering a value of this type.
CharSequence
applyWhitespaceNormalization(CharSequence value)
Apply the whitespace normalization rules for this simple type
Value
atomize(NodeInfo node)
Get the typed value of a node that is annotated with this schema type.
void
checkTypeDerivationIsOK(SchemaType type, int block)
Check that this type is validly derived from a given type
AtomicType
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-signnificant integer with fields such as SchemaType.DERIVATION_LIST and SchemaType.DERIVATION_EXTENSION
SchemaType
getBuiltInBaseType()
Returns the built-in base type this type is derived from.
AtomicType
getCommonAtomicType()
Get the most specific possible atomic type that all items in this SimpleType belong to
int
getDerivationMethod()
Gets the integer code of the derivation method used to derive this type from its parent.
String
getDescription()
Get a description of this type for use in error messages.
String
getDisplayName()
Get the display name of the type: that is, a lexical QName with an arbitrary prefix
int
getFingerprint()
Get the fingerprint of the name of this type
Class
getJavaClass()
Get the Java class to which this external object type corresponds
SchemaType
getKnownBaseType()
Returns the base type that this type inherits from.
String
getName()
Get the local name of this type
int
getNameCode()
Get the namecode of the name of this type.
ItemType
getPrimitiveItemType()
Get the primitive item type corresponding to this item type.
int
getPrimitiveType()
Get the primitive type corresponding to this item type.
int
getRelationship(ExternalObjectType other)
Get the relationship of this external object type to another external object type
ItemType
getSuperType(TypeHierarchy th)
Get the type from which this item type is derived by restriction.
String
getSystemId()
Get the URI of the schema document where the type was originally defined.
String
getTargetNamespace()
Get the target namespace of this type
SequenceIterator
getTypedValue(CharSequence value, NamespaceResolver resolver, NameChecker nameChecker)
Get the typed value corresponding to a given string value, assuming it is valid against this type
SequenceIterator
getTypedValue(NodeInfo node)
Get the typed value of a node that is annotated with this schema type
int
getValidationStatus()
Get the validation status - always valid
int
getWhitespaceAction(TypeHierarchy th)
Determine the whitespace normalization required for values of this type
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
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
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
boolean
isNamespaceSensitive()
Test whether this simple type is namespace-sensitive, that is, whether it is derived from xs:QName or xs:NOTATION
boolean
isOrdered()
Determine whether the atomic type is ordered, that is, whether less-than and greater-than comparisons are permitted
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()
Returns true if this SchemaType is a SimpleType
boolean
isUnionType()
Return true if this type is a union type (that is, if its variety is union)
boolean
matchesItem(Item item, boolean allowURIPromotion, Configuration config)
Test whether a given item conforms to this type
String
toString()
String
toString(NamePool pool)
Produce a representation of this type name for use in error messages.
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.
ValidationFailure
validateContent(CharSequence value, NamespaceResolver nsResolver, NameChecker nameChecker)
Check whether a given input string is valid according to this SimpleType

Constructor Details

ExternalObjectType

public ExternalObjectType(Class javaClass,
                          Configuration config)
Create an external object type
Parameters:
javaClass - the Java class to which this type corresponds
config - the Saxon configuration

Method Details

allowsDerivation

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 example SchemaType.DERIVATION_LIST
Returns:
true if this kind of derivation is allowed

analyzeContentExpression

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 content
kind - the node kind whose content is being delivered: Type.ELEMENT, Type.ATTRIBUTE, or Type.DOCUMENT
env - the static evaluation context
Throws:
XPathException - if the expression will never deliver a value of the correct type

analyzeContentExpression

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 checked
expression - the expression that delivers the content
env - the static evaluation context
kind - the node kind whose content is being delivered: Type.ELEMENT, Type.ATTRIBUTE, or Type.DOCUMENT
Throws:
XPathException - if the expression will never deliver a value of the correct type

applyWhitespaceNormalization

public CharSequence applyWhitespaceNormalization(CharSequence value)
            throws ValidationException
Apply the whitespace normalization rules for this simple type
Parameters:
value - the string before whitespace normalization
Returns:
the string after whitespace normalization

atomize

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 method getTypedValue. 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

checkTypeDerivationIsOK

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 derived
block - the derivations that are blocked by the relevant element declaration
Throws:
SchemaException - if the derivation is not allowed

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:
getAtomizedItemType in interface ItemType

getBaseType

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.

getBlock

public final int getBlock()
Specified by:
getBlock in interface SchemaType
Returns:
the value of the 'block' attribute for this type

getBuiltInBaseType

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

getCommonAtomicType

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

getDerivationMethod

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

getDescription

public String getDescription()
Get a description of this type for use in error messages. This is the same as the display name in the case of named types; for anonymous types it identifies the type by its position in a source schema document.
Specified by:
getDescription in interface SchemaType
Returns:
text identifing the type, for use in a phrase such as "the type XXXX".

getDisplayName

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

getFingerprint

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.

getJavaClass

public Class getJavaClass()
Get the Java class to which this external object type corresponds
Returns:
the corresponding Java class

getKnownBaseType

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.

getName

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.

getNameCode

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

getPrimitiveItemType

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

getPrimitiveType

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. 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

getRelationship

public int getRelationship(ExternalObjectType other)
Get the relationship of this external object type to another external object type
Parameters:
other - the other external object type
Returns:
the relationship of this external object type to another external object type, as one of the constants in class TypeHierarchy, for example TypeHierarchy.SUBSUMES

getSuperType

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).

In fact the concept of "supertype" is not really well-defined, because the types form a lattice rather than a hierarchy. The only real requirement on this function is that it returns a type that strictly subsumes this type, ideally as narrowly as possible.

Specified by:
getSuperType in interface ItemType
Parameters:
th - the type hierarchy cache
Returns:
the supertype, or null if this type is item()

getSystemId

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

getTargetNamespace

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.

getTypedValue

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 value
resolver - 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 - checks names against XML 1.0 or XML 1.1 syntax rules
Returns:
an iterator over the atomic sequence comprising the typed value. The objects returned by this SequenceIterator will all be of type AtomicValue

getTypedValue

public final SequenceIterator getTypedValue(NodeInfo node)
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

getValidationStatus

public final int getValidationStatus()
Get the validation status - always valid
Specified by:
getValidationStatus in interface SchemaComponent

getWhitespaceAction

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

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 interface AtomicType
Returns:
false - external types are not abstract

isAnonymousType

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

isAtomicType

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 considered to be an atomic type

isBuiltInType

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
Returns:
false - external types are not built in

isComplexType

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

isExternalType

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

isListType

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

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 interface SimpleType
Returns:
true if this type is derived from xs:QName or xs:NOTATION

isOrdered

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

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 interface AtomicType
Returns:
true if the type is considered primitive under the above rules

isSameType

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

isSimpleType

public final boolean isSimpleType()
Returns true if this SchemaType is a SimpleType
Specified by:
isSimpleType in interface SchemaType
Returns:
true (always)

isUnionType

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

matchesItem

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 tested
allowURIPromotion -
config -
Returns:
true if the item is an instance of this type; false otherwise

toString

public String toString()

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
Specified by:
toString in interface ItemType

validate

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 -
Returns:
null if the value is valid; otherwise, a ValidationFailure object indicating the nature of the error.

validateContent

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 checked
nsResolver - 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 - used to check names against XML 1.0 or XML 1.1 syntax rules
Returns:
null if validation succeeds; return a ValidationException describing the validation failure if validation fails, unless throwException is true, in which case the exception is thrown rather than being returned.