Package net.sf.saxon.type
Class ExternalObjectType
java.lang.Object
net.sf.saxon.type.ExternalObjectType
- All Implemented Interfaces:
Serializable
,AtomicType
,ItemType
,SchemaComponent
,SchemaType
,SimpleType
This class represents the type of an external Java object returned by
an extension function, or supplied as an external variable/parameter.
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescription(package private) int
(package private) int
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
Constructors -
Method Summary
Modifier and TypeMethodDescriptionfinal boolean
allowsDerivation
(int derivation) Determines whether derivation (of a particular kind) from this type is allowed, based on the "final" propertyvoid
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.Apply the whitespace normalization rules for this simple typeGet 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 typeGet the item type of the atomic values that will be produced when an item of this type is atomizedfinal SchemaType
Returns the base type that this type inherits from.final int
getBlock()
Returns the value of the 'block' attribute for this type, as a bit-signnificant integer with fields such asSchemaType.DERIVATION_LIST
andSchemaType.DERIVATION_EXTENSION
Returns the built-in base type this type is derived from.Get the most specific possible atomic type that all items in this SimpleType belong tofinal int
Gets the integer code of the derivation method used to derive this type from its parent.Get a description of this type for use in error messages.Get the display name of the type: that is, a lexical QName with an arbitrary prefixint
Get the fingerprint of the name of this typeReturns the base type that this type inherits from.int
Get the namecode of the name of this type.Get the primitive item type corresponding to this item type.int
Get the primitive type corresponding to this item type.int
Get the relationship of this external object type to another external object typeGet the type from which this item type is derived by restriction.getTypedValue
(CharSequence value, NamespaceResolver resolver, NameChecker nameChecker) Get the typed value corresponding to a given string value, assuming it is valid against this typefinal SequenceIterator
getTypedValue
(NodeInfo node) Get the typed value of a node that is annotated with this schema typefinal int
Get the validation status - always validint
Determine the whitespace normalization required for values of this typeboolean
Test whether this is an anonymous typeboolean
Test whether this Simple Type is an atomic typeboolean
final boolean
Test whether this SchemaType is a complex typeboolean
Return true if this is an external object type, that is, a Saxon-defined type for external Java or .NET objectsboolean
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 membersboolean
Test whether this simple type is namespace-sensitive, that is, whether it is derived from xs:QName or xs:NOTATIONboolean
isSameType
(SchemaType other) Test whether this is the same type as another type.final boolean
Returns true if this SchemaType is a SimpleTypeboolean
Return true if this type is a union type (that is, if its variety is union)makeDerivedValue
(AtomicValue primValue, CharSequence lexicalValue, boolean validate) Factory method to create values of a derived atomic type.boolean
matchesItem
(Item item, boolean allowURIPromotion, Configuration config) Test whether a given item conforms to this typetoString()
Produce a representation of this type name for use in error messages.validateContent
(CharSequence value, NamespaceResolver nsResolver, NameChecker nameChecker) Check whether a given input string is valid according to this SimpleType
-
Field Details
-
fingerprint
int fingerprint -
baseFingerprint
int baseFingerprint
-
-
Constructor Details
-
ExternalObjectType
-
-
Method Details
-
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 interfaceSimpleType
-
getCommonAtomicType
Get the most specific possible atomic type that all items in this SimpleType belong to- Specified by:
getCommonAtomicType
in interfaceSimpleType
- Returns:
- the lowest common supertype of all member types
-
getValidationStatus
public final int getValidationStatus()Get the validation status - always valid- Specified by:
getValidationStatus
in interfaceSchemaComponent
- 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 asSchemaType.DERIVATION_LIST
andSchemaType.DERIVATION_EXTENSION
- Specified by:
getBlock
in interfaceSchemaType
- 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 interfaceSchemaType
- 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 interfaceSchemaType
- Parameters:
derivation
- the kind of derivation, for exampleSchemaType.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 interfaceSchemaType
-
isComplexType
public final boolean isComplexType()Test whether this SchemaType is a complex type- Specified by:
isComplexType
in interfaceSchemaType
- Returns:
- true if this SchemaType is a complex type
-
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 interfaceSchemaType
- Returns:
- the base type.
- Throws:
IllegalStateException
- if this type is not valid.
-
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 interfaceItemType
-
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 interfaceItemType
-
toString
Produce a representation of this type name for use in error messages. Where this is a QName, it will use conventional prefixes -
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 interfaceItemType
-
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
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 interfaceSchemaType
-
getRelationship
Get the relationship of this external object type to another 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 exampleTypeHierarchy.SUBSUMES
-
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 interfaceSchemaType
- 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, ValidationException Check that this type is validly derived from a given type- Specified by:
checkTypeDerivationIsOK
in interfaceSchemaType
- 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 allowedValidationException
-
isSimpleType
public final boolean isSimpleType()Returns true if this SchemaType is a SimpleType- Specified by:
isSimpleType
in interfaceSchemaType
- Returns:
- true (always)
-
isAtomicType
public boolean isAtomicType()Test whether this Simple Type is an atomic type- Specified by:
isAtomicType
in interfaceItemType
- Specified by:
isAtomicType
in interfaceSchemaType
- Specified by:
isAtomicType
in interfaceSimpleType
- Returns:
- true, this is considered to be an atomic type
-
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 interfaceSimpleType
- 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 interfaceSimpleType
- Returns:
- true for a union type
-
getWhitespaceAction
Determine the whitespace normalization required for values of this type- Specified by:
getWhitespaceAction
in interfaceSimpleType
- Parameters:
th
-- Returns:
- one of PRESERVE, REPLACE, COLLAPSE
-
applyWhitespaceNormalization
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
Returns the built-in base type this type is derived from.- Specified by:
getBuiltInBaseType
in interfaceSimpleType
- 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 interfaceSimpleType
- 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 interfaceSchemaType
- Returns:
- true if this SchemaType is an anonymous type
-
getTypedValue
Get the typed value of a node that is annotated with this schema type- Specified by:
getTypedValue
in interfaceSchemaType
- 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
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(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 interfaceSchemaType
- 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, 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 interfaceSimpleType
- 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
-- 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
-
makeDerivedValue
public AtomicValue makeDerivedValue(AtomicValue primValue, CharSequence lexicalValue, boolean validate) Factory method to create values of a derived atomic type. This method is not used to create values of a built-in type, even one that is not primitive.- Specified by:
makeDerivedValue
in interfaceAtomicType
- Parameters:
primValue
- the value in the value space of the primitive typelexicalValue
- the value in the lexical space. If null, the string value of primValuevalidate
- true if the value is to be validated against the facets of the derived type; false if the caller knows that the value is already valid.- Returns:
- the derived atomic value if validation succeeds, or an ErrorValue otherwise. The ErrorValue encapsulates the exception that occurred; it is the caller's responsibility to check for this.
-
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 interfaceSchemaType
- Parameters:
expression
- the expression that delivers the contentkind
- the node kind whose content is being delivered:Type.ELEMENT
,Type.ATTRIBUTE
, orType.DOCUMENT
env
-- 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 checkedexpression
- the expression that delivers the contentkind
- 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
-
getJavaClass
-
isBuiltIn
public boolean isBuiltIn() -
matchesItem
Description copied from interface:ItemType
Test whether a given item conforms to this type- Specified by:
matchesItem
in interfaceItemType
- Parameters:
item
- The item to be testedallowURIPromotion
-config
-- Returns:
- true if the item is an instance of this type; false otherwise
-
validateContent
public ValidationException validateContent(CharSequence value, NamespaceResolver nsResolver, NameChecker nameChecker) Check whether a given input string is valid according to this SimpleType- Specified by:
validateContent
in interfaceSimpleType
- 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
-- 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
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 xdt: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 interfaceItemType
- Parameters:
th
-- 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 interfaceSchemaType
- Returns:
- the fingerprint. Returns an invented fingerprint for an anonymous type.
-
toString
-
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 interfaceSchemaType
- Returns:
- a lexical QName identifying the type
-