net.sf.saxon.type

Class ExternalObjectType

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.
Field Summary
intbaseFingerprint
intfingerprint
Constructor Summary
ExternalObjectType(Class javaClass)
Create an anonymous external object type.
ExternalObjectType(Class javaClass, Configuration config)
Create an external object type.
Method Summary
booleanallowsDerivation(int derivation)
Determines whether derivation (of a particular kind) from this type is allowed, based on the "final" property
voidanalyzeContentExpression(Expression expression, int kind, StaticContext env)
Analyze an expression to see whether the expression is capable of delivering a value of this type.
static voidanalyzeContentExpression(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.
CharSequenceapplyWhitespaceNormalization(CharSequence value)
Apply the whitespace normalization rules for this simple type
Valueatomize(NodeInfo node)
Get the typed value of a node that is annotated with this schema type.
voidcheckTypeDerivationIsOK(SchemaType type, int block)
Check that this type is validly derived from a given type
booleanequals(Object obj)
Test whether two ExternalObjectType objects represent the same type
AtomicTypegetAtomizedItemType()
Get the item type of the atomic values that will be produced when an item of this type is atomized
SchemaTypegetBaseType()
Returns the base type that this type inherits from.
intgetBlock()
Returns the value of the 'block' attribute for this type, as a bit-signnificant integer with fields such as DERIVATION_LIST and DERIVATION_EXTENSION
SchemaTypegetBuiltInBaseType()
Returns the built-in base type this type is derived from.
AtomicTypegetCommonAtomicType()
Get the most specific possible atomic type that all items in this SimpleType belong to
intgetDerivationMethod()
Gets the integer code of the derivation method used to derive this type from its parent.
StringgetDescription()
StringgetDisplayName()
intgetFingerprint()
ClassgetJavaClass()
Get the Java class to which this external object type corresponds
SchemaTypegetKnownBaseType()
Returns the base type that this type inherits from.
StringgetName()
Get the local name of this type
intgetNameCode()
Get the namecode of the name of this type.
ItemTypegetPrimitiveItemType()
Get the primitive item type corresponding to this item type.
intgetPrimitiveType()
Get the primitive type corresponding to this item type.
intgetRedefinitionLevel()
Get the redefinition level.
intgetRelationship(ExternalObjectType other)
Get the relationship of this external object type to another external object type
ItemTypegetSuperType(TypeHierarchy th)
StringgetSystemId()
Get the URI of the schema document where the type was originally defined.
StringgetTargetNamespace()
Get the target namespace of this type
SequenceIteratorgetTypedValue(NodeInfo node)
Get the typed value of a node that is annotated with this schema type
SequenceIteratorgetTypedValue(CharSequence value, NamespaceResolver resolver, NameChecker nameChecker)
Get the typed value corresponding to a given string value, assuming it is valid against this type
StructuredQNamegetTypeName()
Get the name of this type as a StructuredQName, unless the type is anonymous, in which case return null
intgetValidationStatus()
Get the validation status - always valid
intgetWhitespaceAction(TypeHierarchy th)
Determine the whitespace normalization required for values of this type
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 subtype
booleanisAnonymousType()
Test whether this is an anonymous type
booleanisAtomicType()
Test whether this Simple Type is an atomic type
booleanisAtomizable()
Ask whether values of this type are atomizable
booleanisBuiltInType()
Determine whether this is a built-in type or a user-defined type
booleanisComplexType()
Test whether this SchemaType is a complex type
booleanisExternalType()
Return true if this is an external object type, that is, a Saxon-defined type for external Java or .NET objects
booleanisIdRefType()
Ask whether this type is an IDREF or IDREFS type.
booleanisIdType()
Ask whether this type is an ID type.
booleanisListType()
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
booleanisNamespaceSensitive()
Test whether this simple type is namespace-sensitive, that is, whether it is derived from xs:QName or xs:NOTATION
booleanisOrdered()
Determine whether the atomic type is ordered, that is, whether less-than and greater-than comparisons are permitted
booleanisPrimitiveType()
Determine whether the atomic type is a primitive type.
booleanisSameType(SchemaType other)
Test whether this is the same type as another type.
booleanisSimpleType()
Returns true if this SchemaType is a SimpleType
booleanisUnionType()
Return true if this type is a union type (that is, if its variety is union)
booleanmatchesItem(Item item, boolean allowURIPromotion, Configuration config)
Test whether a given item conforms to this type
CharSequencepostprocess(CharSequence input)
Reverse any pre-lexical facets, other than whitespace.
CharSequencepreprocess(CharSequence input)
Apply any pre-lexical facets, other than whitespace.
StringtoString(NamePool pool)
Produce a representation of this type name for use in error messages.
StringtoString()
ValidationFailurevalidate(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.
ValidationFailurevalidateContent(CharSequence value, NamespaceResolver nsResolver, NameChecker nameChecker)
Check whether a given input string is valid according to this SimpleType

Field Detail

baseFingerprint

int baseFingerprint

fingerprint

int fingerprint

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

allowsDerivation

public final boolean allowsDerivation(int derivation)
Determines whether derivation (of a particular kind) from this type is allowed, based on the "final" property

Parameters: derivation the kind of derivation, for example DERIVATION_LIST

Returns: true if this kind of derivation is allowed

analyzeContentExpression

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

Parameters: expression the expression that delivers the content kind the node kind whose content is being delivered: ELEMENT, ATTRIBUTE, or DOCUMENT env the static evaluation context

Throws: net.sf.saxon.trans.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)
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: ELEMENT, ATTRIBUTE, or DOCUMENT

Throws: net.sf.saxon.trans.XPathException if the expression will never deliver a value of the correct type

applyWhitespaceNormalization

public CharSequence applyWhitespaceNormalization(CharSequence value)
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)
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 ExternalObjectType. 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.

Parameters: node the node whose typed value is required

Returns: the typed value.

Since: 8.5

checkTypeDerivationIsOK

public void checkTypeDerivationIsOK(SchemaType type, int block)
Check that this type is validly derived from a given type

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

equals

public boolean equals(Object obj)
Test whether two ExternalObjectType objects represent the same type

Parameters: obj the other ExternalObjectType

Returns: true if the two objects represent the same type

getAtomizedItemType

public AtomicType getAtomizedItemType()
Get the item type of the atomic values that will be produced when an item of this type is atomized

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.

Returns: the base type.

Throws: IllegalStateException if this type is not valid.

getBlock

public final int getBlock()
Returns the value of the 'block' attribute for this type, as a bit-signnificant integer with fields such as DERIVATION_LIST and DERIVATION_EXTENSION

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.

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

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.

Returns: a numeric code representing the derivation method, for example DERIVATION_RESTRICTION

getDescription

public String getDescription()

getDisplayName

public String getDisplayName()

getFingerprint

public int getFingerprint()

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.

Throws: IllegalStateException if this type is not valid.

getName

public String getName()
Get the local name of this type

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.

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.

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.

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.

Returns: the redefinition level

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 SUBSUMES

getSuperType

public ItemType getSuperType(TypeHierarchy th)

getSystemId

public String getSystemId()
Get the URI of the schema document where the type was originally defined.

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

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 final SequenceIterator getTypedValue(NodeInfo node)
Get the typed value of a node that is annotated with this schema type

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

getTypedValue

public 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

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

getTypeName

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

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

getValidationStatus

public final int getValidationStatus()
Get the validation status - always valid

getWhitespaceAction

public int getWhitespaceAction(TypeHierarchy th)
Determine the whitespace normalization required for values of this type

Parameters: th the type hierarchy cache

Returns: one of PRESERVE, REPLACE, COLLAPSE

hashCode

public int hashCode()
Returns a hash code value for the object.

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

Returns: false - external types are not abstract

isAnonymousType

public boolean isAnonymousType()
Test whether this is an anonymous type

Returns: true if this SchemaType is an anonymous type

isAtomicType

public boolean isAtomicType()
Test whether this Simple Type is an atomic type

Returns: true, this is considered to be an atomic type

isAtomizable

public boolean isAtomizable()
Ask whether values of this type are atomizable

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

isBuiltInType

public boolean isBuiltInType()
Determine whether this is a built-in type or a user-defined type

Returns: false - external types are not built in

isComplexType

public final boolean isComplexType()
Test whether this SchemaType is a complex type

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

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

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.

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

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

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

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

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)

isSimpleType

public final boolean isSimpleType()
Returns true if this SchemaType is a SimpleType

Returns: true (always)

isUnionType

public boolean isUnionType()
Return true if this type is a union type (that is, if its variety is union)

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

Parameters: item The item to be tested allowURIPromotion config

Returns: true if the item is an instance of this type; false otherwise

postprocess

public CharSequence postprocess(CharSequence input)
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

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

Returns: the value after postprocessing

preprocess

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

Parameters: input the value to be preprocessed

Returns: the value after preprocessing

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

toString

public String toString()

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.

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.

Throws: UnsupportedOperationException in the case of an external object type

validateContent

public ValidationFailure validateContent(CharSequence value, NamespaceResolver nsResolver, NameChecker nameChecker)
Check whether a given input string is valid according to this 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.

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