net.sf.saxon.type
Class ExternalObjectType

java.lang.Object
  net.sf.saxon.type.ExternalObjectType

All Implemented Interfaces:

Serializable, AtomicType, ItemType, SchemaComponent, SchemaType, SimpleType

public class ExternalObjectType
extends 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.

See Also:

Serialized Form

Field Summary

Fields inherited from interface net.sf.saxon.type.SimpleType

VARIETY_ATOMIC, VARIETY_LIST, VARIETY_UNION, VARIETY_UNSPECIFIED_SIMPLE

Fields inherited from interface net.sf.saxon.type.SchemaType

DERIVATION_EXTENSION, DERIVATION_LIST, DERIVATION_RESTRICTION, DERIVATION_UNION, DERIVE_BY_SUBSTITUTION

Fields inherited from interface net.sf.saxon.type.SchemaComponent

FIXED_UP, INCOMPLETE, INVALID, UNVALIDATED, VALIDATED, VALIDATING

Constructor Summary

ExternalObjectType(Class javaClass)
Create an anonymous external object type.

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
boolean	equals(Object obj) Test whether two ExternalObjectType objects represent the same 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	getRedefinitionLevel() Get the redefinition level.
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, ConversionRules rules) 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
StructuredQName	getTypeName() Get the name of this type as a StructuredQName, unless the type is anonymous, in which case return null
int	getValidationStatus() Get the validation status - always valid
int	getWhitespaceAction() Determine the whitespace normalization required for values of this type
int	hashCode() Returns a hash code value for the object.
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() Ask whether values of this type are atomizable
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	isIdRefType() Ask whether this type is an IDREF or IDREFS type.
boolean	isIdType() Ask whether this type is an ID type.
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
CharSequence	postprocess(CharSequence input) Reverse any pre-lexical facets, other than whitespace.
CharSequence	preprocess(CharSequence input) Apply any pre-lexical facets, other than whitespace.
String	toString()
String	toString(NamePool pool) Produce a representation of this type name for use in error messages.
ValidationFailure	validate(AtomicValue primValue, CharSequence lexicalValue, ConversionRules rules) 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, ConversionRules rules) Check whether a given input string is valid according to this SimpleType
void	visitNamedSchemaComponents(SchemaComponentVisitor visitor) Visit all the schema components used in this ItemType definition

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ExternalObjectType

public ExternalObjectType(Class javaClass)

Create an anonymous external object type. When constructed this way, the type will not have a nameCode or fingerprint in the name pool, so methods asking for the name of the type will return no value.

Parameters:

javaClass - the Java class to which this type corresponds

ExternalObjectType

public ExternalObjectType(Class javaClass,
                          Configuration config)

Create an external object type. When constructed this way, the type will have a fingerprint in the name pool based on the Java class name

Parameters:

javaClass - the Java class to which this type corresponds

config - the Saxon configuration

Method Detail

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.

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.

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

Returns:

true if this is an external type

isBuiltInType

public boolean isBuiltInType()

Determine whether this is a built-in type or a user-defined type

Specified by:

isBuiltInType in interface AtomicType

Specified by:

isBuiltInType in interface SimpleType

Returns:

false - external types are not built in

getTypeName

public StructuredQName getTypeName()

Get the name of this type as a StructuredQName, unless the type is anonymous, in which case return null

Specified by:

getTypeName in interface AtomicType

Returns:

the name of the atomic type, or null if the type is anonymous.

getRedefinitionLevel

public int getRedefinitionLevel()

Get the redefinition level. This is zero for a component that has not been redefined; for a redefinition of a level-0 component, it is 1; for a redefinition of a level-N component, it is N+1. This concept is used to support the notion of "pervasive" redefinition: if a component is redefined at several levels, the top level wins, but it is an error to have two versions of the component at the same redefinition level.

Specified by:

getRedefinitionLevel in interface SchemaComponent

Returns:

the redefinition level

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

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

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

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

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

getValidationStatus

public final int getValidationStatus()

Get the validation status - always valid

Specified by:

getValidationStatus in interface SchemaComponent

Returns:

one of the values SchemaComponent.UNVALIDATED, SchemaComponent.VALIDATING, SchemaComponent.VALIDATED, SchemaComponent.INVALID, SchemaComponent.INCOMPLETE

getBlock

public final 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

Specified by:

getBlock in interface SchemaType

Returns:

the value of the 'block' attribute for this type

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

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

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

Returns:

the namecode. Returns an invented namecode for an anonymous type.

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

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.

Throws:

IllegalStateException - if this type is not valid.

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

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

Parameters:

pool - the name pool

Returns:

a string representation of the type, in notation resembling but not necessarily identical to XPath syntax

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

Returns:

the item type of the atomic values that will be produced when an item of this type is atomized

isAtomizable

public boolean isAtomizable()

Ask whether values of this type are atomizable

Specified by:

isAtomizable in interface ItemType

Returns:

true unless it is known that these items will be elements with element-only content, in which case return false

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.

Throws:

IllegalStateException - if this type is not valid.

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

Parameters:

other - the other type

Returns:

true if this is the same type as other

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

getDescription

public String getDescription()

Description copied from interface: SchemaType

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

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

isSimpleType

public final boolean isSimpleType()

Returns true if this SchemaType is a SimpleType

Specified by:

isSimpleType in interface SchemaType

Returns:

true (always)

isAtomicType

public boolean isAtomicType()

Test whether this Simple Type is an atomic type

Specified by:

isAtomicType in interface ItemType

Specified by:

isAtomicType in interface SchemaType

Specified by:

isAtomicType in interface SimpleType

Returns:

true, this is considered to be an atomic type

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 interface SchemaType

isIdRefType

public boolean 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 interface SchemaType

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

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

getWhitespaceAction

public int getWhitespaceAction()

Determine the whitespace normalization required for values of this type

Specified by:

getWhitespaceAction in interface SimpleType

Returns:

one of PRESERVE, REPLACE, COLLAPSE

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

Throws:

ValidationException

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

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

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

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

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(net.sf.saxon.om.NodeInfo). 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.

Throws:

XPathException

Since:

8.5

getTypedValue

public SequenceIterator getTypedValue(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:

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.

rules -

Returns:

an iterator over the atomic sequence comprising the typed value. The objects returned by this SequenceIterator will all be of type AtomicValue

Throws:

ValidationException - if the supplied value is not in the lexical space of the data type

validate

public ValidationFailure validate(AtomicValue primValue,
                                  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:

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)

rules -

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

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

getJavaClass

public Class getJavaClass()

Get the Java class to which this external object type corresponds

Returns:

the corresponding Java class

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

validateContent

public ValidationFailure validateContent(CharSequence value,
                                         NamespaceResolver nsResolver,
                                         ConversionRules rules)

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.

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.

Throws:

UnsupportedOperationException - if the type is namespace-sensitive and no namespace resolver is supplied

getSuperType

public ItemType getSuperType(TypeHierarchy th)

Description copied from interface: ItemType

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

getFingerprint

public int getFingerprint()

Description copied from interface: SchemaType

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.

toString

public String toString()

Overrides:

toString in class Object

getDisplayName

public String getDisplayName()

Description copied from interface: SchemaType

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

hashCode

public int hashCode()

Returns a hash code value for the object.

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Test whether two ExternalObjectType objects represent the same type

Overrides:

equals in class Object

Parameters:

obj - the other ExternalObjectType

Returns:

true if the two objects represent the same type

preprocess

public CharSequence preprocess(CharSequence input)

Apply any pre-lexical facets, other than whitespace. At the moment the only such facet is saxon:preprocess

Specified by:

preprocess in interface SimpleType

Parameters:

input - the value to be preprocessed

Returns:

the value after preprocessing

postprocess

public CharSequence postprocess(CharSequence input)
                         throws ValidationException

Reverse any pre-lexical facets, other than whitespace. At the moment the only such facet is saxon:preprocess. This is called when converting a value of this type to a string

Specified by:

postprocess in interface SimpleType

Parameters:

input - the value to be postprocessed: this is the "ordinary" result of converting the value to a string

Returns:

the value after postprocessing

Throws:

ValidationException

visitNamedSchemaComponents

public void visitNamedSchemaComponents(SchemaComponentVisitor visitor)
                                throws XPathException

Visit all the schema components used in this ItemType definition

Specified by:

visitNamedSchemaComponents in interface ItemType

Parameters:

visitor - the visitor class to be called when each component is visited

Throws:

XPathException