Package net.sf.saxon.type
Class AnyExternalObjectType
- java.lang.Object
-
- net.sf.saxon.type.AnyExternalObjectType
-
- All Implemented Interfaces:
ItemType
- Direct Known Subclasses:
ExternalObjectType
public class AnyExternalObjectType extends java.lang.Object implements ItemType
This class represents the type of an external object returned by an extension function, or supplied as an external variable/parameter.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface net.sf.saxon.type.ItemType
ItemType.WithSequenceTypeCache
-
-
Field Summary
Fields Modifier and Type Field Description static AnyExternalObjectTypeTHE_INSTANCE
-
Constructor Summary
Constructors Modifier Constructor Description protectedAnyExternalObjectType()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description AtomicTypegetAtomizedItemType()Get the item type of the atomic values that will be produced when an item of this type is atomizedjava.lang.StringgetBasicAlphaCode()Get an alphabetic code representing the type, or at any rate, the nearest built-in type from which this type is derived.doublegetDefaultPriority()Get the default priority when this ItemType is used as an XSLT patternGenregetGenre()Determine the Genre (top-level classification) of this typeItemTypegetPrimitiveItemType()Get the primitive item type corresponding to this item type.intgetPrimitiveType()Get the primitive type corresponding to this item type.UTypegetUType()Get the correspondingUType.booleanisAtomicType()Determine whether this item type is an atomic typebooleanisAtomizable(TypeHierarchy th)Ask whether values of this type are atomizablebooleanisPlainType()Determine whether this item type is a plain type (that is, whether it can ONLY match atomic values)booleanmatches(Item item, TypeHierarchy th)Test whether a given item conforms to this type-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface net.sf.saxon.type.ItemType
explainMismatch, getFullAlphaCode, getNormalizedDefaultPriority, isTrueItemType, toExportString, toString
-
-
-
-
Field Detail
-
THE_INSTANCE
public static AnyExternalObjectType THE_INSTANCE
-
-
Method Detail
-
isAtomicType
public boolean isAtomicType()
Description copied from interface:ItemTypeDetermine whether this item type is an atomic type- Specified by:
isAtomicTypein interfaceItemType- Returns:
- true if this is ANY_ATOMIC_TYPE or a subtype thereof
-
matches
public boolean matches(Item item, TypeHierarchy th) throws XPathException
Description copied from interface:ItemTypeTest whether a given item conforms to this type- Specified by:
matchesin interfaceItemType- Parameters:
item- The item to be testedth- The type hierarchy cache. Currently used only when matching function items.- Returns:
- true if the item is an instance of this type; false otherwise
- Throws:
XPathException
-
isPlainType
public boolean isPlainType()
Description copied from interface:ItemTypeDetermine whether this item type is a plain type (that is, whether it can ONLY match atomic values)- Specified by:
isPlainTypein interfaceItemType- Returns:
- true if this is ANY_ATOMIC_TYPE or a subtype thereof, or a "plain" union type (that is, unions of atomic types that impose no further restrictions). Return false if this is a union type whose member types are not all known.
-
getPrimitiveType
public int getPrimitiveType()
Description copied from interface:ItemTypeGet 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 BuiltInAtomicType.ANY_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:
getPrimitiveTypein interfaceItemType- Returns:
- the integer fingerprint of the corresponding primitive type
-
getBasicAlphaCode
public java.lang.String getBasicAlphaCode()
Get an alphabetic code representing the type, or at any rate, the nearest built-in type from which this type is derived. The codes are designed so that for any two built-in types A and B, alphaCode(A) is a prefix of alphaCode(B) if and only if A is a supertype of B.- Specified by:
getBasicAlphaCodein interfaceItemType- Returns:
- the alphacode for the nearest containing built-in type
-
getPrimitiveItemType
public ItemType getPrimitiveItemType()
Description copied from interface:ItemTypeGet 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 and union types 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, xs:dayTimeDuration, and xs:yearMonthDuration are considered to be primitive types.- Specified by:
getPrimitiveItemTypein interfaceItemType- Returns:
- the corresponding primitive type
-
getUType
public UType getUType()
Description copied from interface:ItemTypeGet the correspondingUType. A UType is a union of primitive item types.
-
getAtomizedItemType
public AtomicType getAtomizedItemType()
Description copied from interface:ItemTypeGet the item type of the atomic values that will be produced when an item of this type is atomized- Specified by:
getAtomizedItemTypein interfaceItemType- Returns:
- the best available item type of the atomic values that will be produced when an item of this type is atomized, or null if it is known that atomization will throw an error.
-
isAtomizable
public boolean isAtomizable(TypeHierarchy th)
Description copied from interface:ItemTypeAsk whether values of this type are atomizable- Specified by:
isAtomizablein interfaceItemType- Parameters:
th- the type hierarchy cache- Returns:
- true if some or all instances of this type can be successfully atomized; false if no instances of this type can be atomized
-
getGenre
public Genre getGenre()
Description copied from interface:ItemTypeDetermine the Genre (top-level classification) of this type
-
getDefaultPriority
public double getDefaultPriority()
Get the default priority when this ItemType is used as an XSLT pattern- Specified by:
getDefaultPriorityin interfaceItemType- Returns:
- the default priority
-
-