net.sf.saxon.type

Class AnyItemType

java.lang.Object

net.sf.saxon.type.AnyItemType

All Implemented Interfaces:

ItemType

public class AnyItemType
extends Object
implements ItemType

An implementation of ItemType that matches any item (node or atomic value)

Method Summary

Modifier and Type	Method and Description
String	generateJavaScriptItemTypeAcceptor(String errorCode) Generate Javascript code to convert a supplied Javascript value to this item type, if conversion is possible, or throw an error otherwise.
String	generateJavaScriptItemTypeTest(ItemType knownToBe) Generate Javascript code to test whether an item conforms to this item type
AtomicType	getAtomizedItemType() Get the item type of the atomic values that will be produced when an item of this type is atomized
double	getDefaultPriority()
static AnyItemType	getInstance() Factory method to get the singleton instance
ItemType	getPrimitiveItemType() Get the primitive item type corresponding to this item type.
int	getPrimitiveType() Get the primitive type corresponding to this item type.
UType	getUType() Get the corresponding UType.
int	hashCode() Returns a hash code value for the object.
boolean	isAtomicType() Determine whether this item type is an atomic type
boolean	isAtomizable() Ask whether values of this type are atomizable
boolean	isPlainType() Determine whether this item type is atomic (that is, whether it can ONLY match atomic values)
boolean	matches(Item item, TypeHierarchy th) Test whether a given item conforms to this type
String	toString()
void	visitNamedSchemaComponents(SchemaComponentVisitor visitor) Visit all the schema components used in this ItemType definition

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static AnyItemType getInstance()

Factory method to get the singleton instance

Returns:

the singleton instance

getUType

public UType getUType()

Get the corresponding UType. A UType is a union of primitive item types.

Specified by:

getUType in interface ItemType

Returns:

the smallest UType that subsumes this item type

isAtomicType

public boolean isAtomicType()

Determine whether this item type is an atomic type

Specified by:

isAtomicType in interface ItemType

Returns:

true if this is ANY_ATOMIC_TYPE or a subtype thereof

isPlainType

public boolean isPlainType()

Determine whether this item type is atomic (that is, whether it can ONLY match atomic values)

Specified by:

isPlainType in interface ItemType

Returns:

false: this type can match nodes or atomic values

matches

public boolean matches(Item item,
                       TypeHierarchy th)

Test whether a given item conforms to this type

Specified by:

matches in interface ItemType

Parameters:

item - The item to be tested

th -

Returns:

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

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

Returns:

the corresponding primitive type

getPrimitiveType

public int getPrimitiveType()

Description copied from interface: ItemType

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

getPrimitiveType in interface ItemType

Returns:

the integer fingerprint of the corresponding primitive type

getAtomizedItemType

public AtomicType getAtomizedItemType()

Description copied from interface: ItemType

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

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

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 - if an error occurs

getDefaultPriority

public double getDefaultPriority()

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Returns a hash code value for the object.

Overrides:

hashCode in class Object

generateJavaScriptItemTypeTest

public String generateJavaScriptItemTypeTest(ItemType knownToBe)
                                      throws XPathException

Generate Javascript code to test whether an item conforms to this item type

Specified by:

generateJavaScriptItemTypeTest in interface ItemType

Parameters:

knownToBe -

Returns:

a Javascript instruction or sequence of instructions, which can be used as the body of a Javascript function, and which returns a boolean indication whether the value of the variable "item" is an instance of this item type.

Throws:

XPathException - if JS code cannot be generated for this item type, for example because the test is schema-aware.

generateJavaScriptItemTypeAcceptor

public String generateJavaScriptItemTypeAcceptor(String errorCode)
                                          throws XPathException

Generate Javascript code to convert a supplied Javascript value to this item type, if conversion is possible, or throw an error otherwise.

Specified by:

generateJavaScriptItemTypeAcceptor in interface ItemType

Parameters:

errorCode - the error to be thrown if conversion is not possible

Returns:

a Javascript instruction or sequence of instructions, which can be used as the body of a Javascript function, and which returns the result of conversion to this type, or throws an error if conversion is not possible. The variable "val" will hold the supplied Javascript value.

Throws:

XPathException