xalanc::XNodeSet Class Reference

Class to hold XPath return types. More...

#include <xalanc/XPath/XNodeSet.hpp>

Inheritance diagram for xalanc::XNodeSet:

Collaboration diagram for xalanc::XNodeSet:

Public Types
typedef XPathExecutionContext::BorrowReturnMutableNodeRefList	BorrowReturnMutableNodeRefList
Public Types inherited from xalanc::XNodeSetBase
typedef NodeRefListBase::size_type	size_type
typedef XObject	ParentType
Public Types inherited from xalanc::XObject
enum	eObjectType {   eTypeNull = 0, eTypeUnknown = 1, eTypeBoolean = 2, eTypeNumber = 3,   eTypeString = 4, eTypeNodeSet = 5, eTypeResultTreeFrag = 6, eTypeUserDefined = 7,   eTypeStringReference = 8, eTypeStringAdapter = 9, eTypeStringCached = 10, eTypeXTokenNumberAdapter = 11,   eTypeXTokenStringAdapter = 12, eTypeNodeSetNodeProxy = 13, eUnknown }
	Enumeration of possible object types. More...
typedef XPathExecutionContext::GetCachedString	GetCachedString
typedef void(FormatterListener::*	MemberFunctionPtr) (const XMLCh *const, const FormatterListener::size_type)

Public Member Functions
	XNodeSet (BorrowReturnMutableNodeRefList &value, MemoryManager &theMemoryManager)
	Create an XNodeSet from a node list. More...
	XNodeSet (const XNodeSet &source, MemoryManager &theMemoryManager)
	Create an XNodeSet from another. More...
virtual	~XNodeSet ()
virtual const NodeRefListBase &	nodeset () const
	Cast result object to a nodelist. More...
virtual XalanNode *	item (size_type index) const
virtual size_type	getLength () const
void	release ()
	Release the node set held by the instance. More...
void	set (BorrowReturnMutableNodeRefList &value)
	Change the value of an XNodeSet. More...
Public Member Functions inherited from xalanc::XNodeSetBase
virtual	~XNodeSetBase ()
virtual const XalanDOMString &	getTypeString () const
	Given a request type, return the equivalent string. More...
virtual double	num (XPathExecutionContext &executionContext) const
	Cast result object to a number. More...
virtual bool	boolean (XPathExecutionContext &executionContext) const
	Cast result object to a boolean. More...
virtual const XalanDOMString &	str (XPathExecutionContext &executionContext) const
	Cast result object to a string. More...
virtual const XalanDOMString &	str () const
	Cast result object to a string. More...
virtual void	str (XPathExecutionContext &executionContext, FormatterListener &formatterListener, MemberFunctionPtr function) const
	Send the string value to a FormatterListener instance. More...
virtual void	str (FormatterListener &formatterListener, MemberFunctionPtr function) const
	Send the string value to a FormatterListener instance. More...
virtual void	str (XPathExecutionContext &executionContext, XalanDOMString &theBuffer) const
	Append the string value directly a string. More...
virtual void	str (XalanDOMString &theBuffer) const
	Append the string value directly a string. More...
virtual double	stringLength (XPathExecutionContext &executionContext) const
	Get the length of the string value of the instance. More...
virtual const XalanDocumentFragment &	rtree () const
	Cast result object to a result tree fragment. More...
virtual void	ProcessXObjectTypeCallback (XObjectTypeCallback &theCallbackObject)
	Process a callback request for preferred type information. More...
virtual void	ProcessXObjectTypeCallback (XObjectTypeCallback &theCallbackObject) const
	Process a callback request for preferred type information. More...
virtual double	num (XPathExecutionContext &executionContext) const
	Cast result object to a number. More...
virtual double	num () const
	Cast result object to a number. More...
Public Member Functions inherited from xalanc::XObject
	XObject (eObjectType theObjectType, MemoryManager &theMemoryManager)
	Create an XObject. More...
virtual double	num () const
	Cast result object to a number. More...
bool	equals (const XObject &theRHS, XPathExecutionContext &executionContext) const
	Tell if two objects are functionally equal. More...
bool	notEquals (const XObject &theRHS, XPathExecutionContext &executionContext) const
	Tell if two objects are functionally not equal. More...
bool	lessThan (const XObject &theRHS, XPathExecutionContext &executionContext) const
	Tell if one object is less than the other. More...
bool	lessThanOrEquals (const XObject &theRHS, XPathExecutionContext &executionContext) const
	Tell if one object is less than or equal the other. More...
bool	greaterThan (const XObject &theRHS, XPathExecutionContext &executionContext) const
	Tell if one object is greater than the other. More...
bool	greaterThanOrEquals (const XObject &theRHS, XPathExecutionContext &executionContext) const
	Tell if one object is greater than or equal the other. More...
eObjectType	getType () const
	Tell what kind of class this is. More...
void	setFactory (XObjectFactory *theFactory)

Additional Inherited Members
Static Public Member Functions inherited from xalanc::XObject
static void	initialize (MemoryManager &theMemoryManager)
	Perform static initialization. More...
static void	terminate ()
	Perform static shut down. More...
static bool	boolean (double theNumber)
	Static conversion function. More...
static bool	boolean (const XalanDOMString &theString)
	Static conversion function. More...
static bool	boolean (const NodeRefListBase &theNodeList)
	Static conversion function. More...
static const XalanDOMString &	string (bool theBool)
	Static conversion function. More...
static void	string (bool theBool, XalanDOMString &theString)
	Static conversion function. More...
static void	string (bool theBool, FormatterListener &formatterListener, MemberFunctionPtr function)
	Static conversion function. More...
static void	string (double theNumber, XalanDOMString &theString)
	Static conversion function. More...
static void	string (double theNumber, FormatterListener &formatterListener, MemberFunctionPtr function)
	Static conversion function. More...
static void	string (const XalanNode &theNode, XalanDOMString &theString)
	Static conversion function. More...
static void	string (const XalanNode &theNode, FormatterListener &formatterListener, MemberFunctionPtr function)
	Static conversion function. More...
static void	string (const NodeRefListBase &theNodeList, XalanDOMString &theString)
	Static conversion function. More...
static void	string (const NodeRefListBase &theNodeList, FormatterListener &formatterListener, MemberFunctionPtr function)
	Static conversion function. More...
static void	string (const XalanNode &theNode, XPathExecutionContext &theExecutionContext, XalanDOMString &theString)
	Static conversion function. More...
static void	string (const XalanNode &theNode, XPathExecutionContext &theExecutionContext, FormatterListener &formatterListener, MemberFunctionPtr function)
	Static conversion function. More...
static void	string (const NodeRefListBase &theNodeList, XPathExecutionContext &theExecutionContext, XalanDOMString &theString)
	Static conversion function. More...
static void	string (const NodeRefListBase &theNodeList, XPathExecutionContext &theExecutionContext, FormatterListener &formatterListener, MemberFunctionPtr function)
	Static conversion function. More...
static void	string (const XalanDOMString &theString, FormatterListener &formatterListener, MemberFunctionPtr function)
	Calls the supplied FormatterListener member function with the string. More...
static double	number (bool theBoolean)
	Static conversion function. More...
static double	number (const XalanDOMString &theString, MemoryManager &theManager)
static double	number (XPathExecutionContext &executionContext, const NodeRefListBase &theNodeList)
	Static conversion function. More...
static double	number (XPathExecutionContext &executionContext, const XalanNode &theNode)
	Static conversion function. More...
Protected Member Functions inherited from xalanc::XNodeSetBase
	XNodeSetBase (MemoryManager &theMemoryManager)
	Create an XNodeSetBase. More...
	XNodeSetBase (const XNodeSetBase &source, MemoryManager &theMemoryManager)
	Create an XNodeSetBase from another. More...
void	clearCachedValues ()
Protected Member Functions inherited from xalanc::XObject
	XObject (const XObject &)
	Create an XObject from another XObject. More...
	XObject (const XObject &source, MemoryManager &theManager)
	Create an XObject from another XObject. More...
MemoryManager &	getMemoryManager () const
	Get the MemoryManager for this instance. More...
void	throwInvalidConversionException (const XalanDOMString &theTargetType) const
virtual eObjectType	getRealType () const
	Tell what kind of class this is. More...
virtual void	referenced ()
virtual void	dereferenced ()
virtual	~XObject ()
Protected Member Functions inherited from xalanc::XalanReferenceCountedObject
	XalanReferenceCountedObject ()
	Create a XalanReferenceCountedObject. More...
virtual	~XalanReferenceCountedObject ()
virtual XalanSize_t	getReferenceCount () const
Static Protected Member Functions inherited from xalanc::XalanReferenceCountedObject
static void	addReference (XalanReferenceCountedObject *theInstance)
	Increment reference count. More...
static void	removeReference (XalanReferenceCountedObject *theInstance)
	Decrement reference count. More...
Static Protected Attributes inherited from xalanc::XObject
static const XalanDOMString	s_emptyString
static const XalanDOMString &	s_booleanString
static const XalanDOMString &	s_falseString
static const XalanDOMString &	s_nodesetString
static const XalanDOMString &	s_numberString
static const XalanDOMString &	s_resultTreeFragmentString
static const XalanDOMString &	s_stringString
static const XalanDOMString &	s_trueString

Detailed Description

Class to hold XPath return types.

Definition at line 44 of file XNodeSet.hpp.

Member Typedef Documentation

BorrowReturnMutableNodeRefList

typedef XPathExecutionContext::BorrowReturnMutableNodeRefList xalanc::XNodeSet::BorrowReturnMutableNodeRefList

Definition at line 48 of file XNodeSet.hpp.

Constructor & Destructor Documentation

XNodeSet() [1/2]

xalanc::XNodeSet::XNodeSet	(	BorrowReturnMutableNodeRefList &	value,
		MemoryManager &	theMemoryManager
	)

Create an XNodeSet from a node list.

Parameters

value	Pointer to source node list. The XNodeSet will adopt the pointer.
theMemoryManager	The MemoryManager for the instance.

XNodeSet() [2/2]

xalanc::XNodeSet::XNodeSet	(	const XNodeSet &	source,
		MemoryManager &	theMemoryManager
	)

Create an XNodeSet from another.

Parameters

source	object to copy
theMemoryManager	The MemoryManager for the instance.

~XNodeSet()

virtual xalanc::XNodeSet::~XNodeSet ( )

virtual

Member Function Documentation

getLength()

virtual size_type xalanc::XNodeSet::getLength ( ) const

virtual

Implements xalanc::XNodeSetBase.

item()

virtual XalanNode* xalanc::XNodeSet::item ( size_type  index ) const

virtual

Implements xalanc::XNodeSetBase.

nodeset()

virtual const NodeRefListBase& xalanc::XNodeSet::nodeset ( ) const

virtual

Cast result object to a nodelist.

This function does not have access to the current XPathExecutionContext, so the result may contain data from whitespace text nodes that might have been stripped otherwise.

Parameters

executionContext

The current XPathExecutionContext

Returns

node list

Implements xalanc::XNodeSetBase.

release()

void xalanc::XNodeSet::release

(

)

Release the node set held by the instance.

set()

void xalanc::XNodeSet::set

(

BorrowReturnMutableNodeRefList &

value

)

Change the value of an XNodeSet.

Parameters

theValue

The new value.

---

The documentation for this class was generated from the following file:

• xalanc/XPath/XNodeSet.hpp