Class to hold XPath return types. More...

#include <xalanc/XPath/XNodeSetBase.hpp>

Inheritance diagram for xalanc::XNodeSetBase:

Collaboration diagram for xalanc::XNodeSetBase:

Public Types
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
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 const NodeRefListBase &	nodeset () const =0
	Cast result object to a nodelist. 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 XalanNode *	item (size_type index) const =0

virtual size_type	getLength () const =0

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)

Protected Member Functions
	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

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

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 45 of file XNodeSetBase.hpp.

Member Typedef Documentation

◆ ParentType

typedef XObject xalanc::XNodeSetBase::ParentType

Definition at line 51 of file XNodeSetBase.hpp.

◆ size_type

typedef NodeRefListBase::size_type xalanc::XNodeSetBase::size_type

Definition at line 49 of file XNodeSetBase.hpp.

Constructor & Destructor Documentation

◆ ~XNodeSetBase()

virtual xalanc::XNodeSetBase::~XNodeSetBase ( )

virtual

◆ XNodeSetBase() [1/2]

xalanc::XNodeSetBase::XNodeSetBase ( MemoryManager & theMemoryManager )

protected

Create an XNodeSetBase.

◆ XNodeSetBase() [2/2]

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

protected

Create an XNodeSetBase from another.

Parameters

source object to copy

Member Function Documentation

◆ boolean()

virtual bool xalanc::XNodeSetBase::boolean ( XPathExecutionContext & executionContext ) const

virtual

Cast result object to a boolean.

Parameters

executionContext The current XPathExecutionContext

Returns: boolean value

Implements xalanc::XObject.

◆ clearCachedValues()

void xalanc::XNodeSetBase::clearCachedValues ( )

protected

◆ getLength()

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

pure virtual

Implemented in xalanc::XNodeSet, and xalanc::XNodeSetNodeProxy.

◆ getTypeString()

virtual const XalanDOMString& xalanc::XNodeSetBase::getTypeString ( ) const

virtual

Given a request type, return the equivalent string.

For diagnostic purposes.

Returns: string for type

Implements xalanc::XObject.

◆ item()

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

pure virtual

Implemented in xalanc::XNodeSet, and xalanc::XNodeSetNodeProxy.

◆ nodeset()

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

pure 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

Reimplemented from xalanc::XObject.

Implemented in xalanc::XNodeSet, and xalanc::XNodeSetNodeProxy.

◆ num() [1/3]

virtual double xalanc::XObject::num

Cast result object to a number.

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.

Returns: numeric value

◆ num() [2/3]

virtual double xalanc::XNodeSetBase::num ( XPathExecutionContext & executionContext ) const

virtual

Cast result object to a number.

Parameters

executionContext The current XPathExecutionContext

Returns: numeric value

Reimplemented from xalanc::XObject.

◆ num() [3/3]

virtual double xalanc::XObject::num

Cast result object to a number.

Parameters

executionContext The current XPathExecutionContext

Returns: numeric value

◆ ProcessXObjectTypeCallback() [1/2]

virtual void xalanc::XNodeSetBase::ProcessXObjectTypeCallback ( XObjectTypeCallback & theCallbackObject )

virtual

Process a callback request for preferred type information.

Parameters

theCallbackObject object to call back

Implements xalanc::XObject.

◆ ProcessXObjectTypeCallback() [2/2]

virtual void xalanc::XNodeSetBase::ProcessXObjectTypeCallback ( XObjectTypeCallback & theCallbackObject ) const

virtual

Process a callback request for preferred type information.

Parameters

theCallbackObject object to call back

Implements xalanc::XObject.

◆ rtree()

virtual const XalanDocumentFragment& xalanc::XNodeSetBase::rtree ( ) const

virtual

Cast result object to a result tree fragment.

Parameters

executionContext The current XPathExecutionContext

Returns: result tree fragment

Reimplemented from xalanc::XObject.

◆ str() [1/6]

virtual const XalanDOMString& xalanc::XNodeSetBase::str ( ) const

virtual

Cast result object to a string.

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

Implements xalanc::XObject.

◆ str() [2/6]

virtual void xalanc::XNodeSetBase::str	(	FormatterListener &	formatterListener,
		MemberFunctionPtr	function
	)		const

virtual

Send the string value to a FormatterListener instance.

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

formatterListener	The FormatterListener instance
function	A pointer to the member function of FormatterListener to call

Implements xalanc::XObject.

◆ str() [3/6]

virtual void xalanc::XNodeSetBase::str ( XalanDOMString & theBuffer ) const

virtual

Append the string value directly a string.

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

theBuffer The buffer for the data

Implements xalanc::XObject.

◆ str() [4/6]

virtual const XalanDOMString& xalanc::XNodeSetBase::str ( XPathExecutionContext & executionContext ) const

virtual

Cast result object to a string.

Parameters

executionContext The current XPathExecutionContext

Returns: string value

Implements xalanc::XObject.

◆ str() [5/6]

virtual void xalanc::XNodeSetBase::str	(	XPathExecutionContext &	executionContext,
		FormatterListener &	formatterListener,
		MemberFunctionPtr	function
	)		const

virtual

Send the string value to a FormatterListener instance.

Parameters

executionContext	The current XPathExecutionContext
formatterListener	The FormatterListener instance
function	A pointer to the member function of FormatterListener to call

Implements xalanc::XObject.

◆ str() [6/6]

virtual void xalanc::XNodeSetBase::str	(	XPathExecutionContext &	executionContext,
		XalanDOMString &	theBuffer
	)		const

virtual

Append the string value directly a string.

Parameters

executionContext	The current XPathExecutionContext
theBuffer	The buffer for the data

Implements xalanc::XObject.

◆ stringLength()

virtual double xalanc::XNodeSetBase::stringLength ( XPathExecutionContext & executionContext ) const

virtual

Get the length of the string value of the instance.

Returns: The length of the string value

Implements xalanc::XObject.

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

xalanc/XPath/XNodeSetBase.hpp

Public Types

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ ParentType

◆ size_type

Constructor & Destructor Documentation

◆ ~XNodeSetBase()

◆ XNodeSetBase() [1/2]

◆ XNodeSetBase() [2/2]

Member Function Documentation

◆ boolean()

◆ clearCachedValues()

◆ getLength()

◆ getTypeString()

◆ item()

◆ nodeset()

◆ num() [1/3]

◆ num() [2/3]

◆ num() [3/3]

◆ ProcessXObjectTypeCallback() [1/2]

◆ ProcessXObjectTypeCallback() [2/2]

◆ rtree()

◆ str() [1/6]

◆ str() [2/6]

◆ str() [3/6]

◆ str() [4/6]

◆ str() [5/6]

◆ str() [6/6]

◆ stringLength()