com.xmlmind.xml.xpath

Class PermanentNodeSetVariant

java.lang.Object

com.xmlmind.xml.xpath.VariantBase

com.xmlmind.xml.xpath.PermanentNodeSetVariant

All Implemented Interfaces:

Variant

public class PermanentNodeSetVariant
extends VariantBase

A Variant which is a node set (i.e. a NodeIterator) value.

A NodeSetVariant is an ephemeral object: it cannot be stored for later use, it must be immediately converted and used. And this conversion may occur only once.

Unlike the NodeSetVariant, a PermanentNodeSetVariant is not an ephemeral object: it can be stored for later use (as long as the document is not modified) and it can be converted several times.

Constructor Summary

Constructors

Constructor and Description
PermanentNodeSetVariant(NodeIterator iter) Constructs a Variant for specified node set.

Method Summary

Modifier and Type	Method and Description
boolean	convertToBoolean() Returns this Variant converted to a boolean.
NodeIterator	convertToNodeSet() Returns this Variant converted to a node set.
double	convertToNumber() Returns this Variant converted to a double.
Object	convertToObject() Returns this Variant converted to an alien Java object (typically returned by an extension function invoked using Java introspection).
String	convertToString() Returns this Variant converted to a string.
boolean	isNodeSet() Returns true if this Variant is a node set value.
String	toString() Returns a string representation of this Variant which is useful when debugging or when testing this implementation of XPath.

Methods inherited from class com.xmlmind.xml.xpath.VariantBase

convertToPredicate, create, isBoolean, isNumber, isString, makePermanent

Methods inherited from class java.lang.Object

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

Constructor Detail

PermanentNodeSetVariant

public PermanentNodeSetVariant(NodeIterator iter)
                        throws EvalException

Constructs a Variant for specified node set.

Throws:

EvalException - if an EvalException is thrown during the copy of the nodes contained in specified node set

Method Detail

convertToNodeSet

public NodeIterator convertToNodeSet()

Description copied from interface: Variant

Returns this Variant converted to a node set.

Specified by:

convertToNodeSet in interface Variant

Overrides:

convertToNodeSet in class VariantBase

convertToObject

public Object convertToObject()

Description copied from interface: Variant

Returns this Variant converted to an alien Java object (typically returned by an extension function invoked using Java introspection).

convertToString

public String convertToString()
                       throws EvalException

Description copied from interface: Variant

Returns this Variant converted to a string.

Throws:

EvalException - if this Variant cannot be converted to a string.

convertToBoolean

public boolean convertToBoolean()
                         throws EvalException

Description copied from interface: Variant

Returns this Variant converted to a boolean.

Throws:

EvalException - if this Variant cannot be converted to a boolean.

convertToNumber

public double convertToNumber()
                       throws EvalException

Description copied from interface: Variant

Returns this Variant converted to a double.

Specified by:

convertToNumber in interface Variant

Overrides:

convertToNumber in class VariantBase

Throws:

EvalException - if this Variant cannot be converted to a double.

isNodeSet

public boolean isNodeSet()

Description copied from interface: Variant

Returns true if this Variant is a node set value.

Specified by:

isNodeSet in interface Variant

Overrides:

isNodeSet in class VariantBase

toString

public String toString()

Description copied from interface: Variant

Returns a string representation of this Variant which is useful when debugging or when testing this implementation of XPath.

Specified by:

toString in interface Variant

Overrides:

toString in class Object