#include <xalanc/XPath/XToken.hpp>

Inheritance diagram for xalanc::XToken:

Collaboration diagram for xalanc::XToken:

Public Member Functions
	XToken (MemoryManager &theMemoryManager)
	Create an XToken. More...

	XToken (const XalanDOMString &theString, double theNumber, MemoryManager &theMemoryManager)
	Create an XToken for string in the token queue. More...

	XToken (double theNumber, const XalanDOMString &theString, MemoryManager &theMemoryManager)
	Create an XToken for number in the token queue. More...

	XToken (const XToken &theSource)
	Create an XToken from another one. More...

	XToken (const XToken &theSource, MemoryManager &theMemoryManager)
	Create an XToken from another one. More...

virtual	~XToken ()

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

XToken &	operator= (const XToken &theRHS)

bool	boolean () const

double	num () const
	Cast result object to a number. More...

double	stringLength () const

void	set (const XalanDOMString &theString, double theNumber)
	Set the instance as a string in the token queue. More...

void	set (double theNumber, const XalanDOMString &theString)
	Set the instance as a number in the token queue. More...

Public Member Functions inherited from xalanc::XObject
	XObject (eObjectType theObjectType, MemoryManager &theMemoryManager)
	Create an XObject. More...

virtual const XalanDocumentFragment &	rtree () const
	Cast result object to a result tree fragment. More...

virtual const NodeRefListBase &	nodeset () const
	Cast result object to a nodelist. 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
virtual void	referenced ()

virtual void	dereferenced ()

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

Protected Member Functions inherited from xalanc::XalanReferenceCountedObject
	XalanReferenceCountedObject ()
	Create a XalanReferenceCountedObject. More...

virtual	~XalanReferenceCountedObject ()

virtual XalanSize_t	getReferenceCount () const

Additional Inherited Members
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)

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

Definition at line 41 of file XToken.hpp.

Constructor & Destructor Documentation

◆ XToken() [1/5]

xalanc::XToken::XToken ( MemoryManager & theMemoryManager )

Create an XToken.

Parameters

theMemoryManager The MemoryManager instance.

◆ XToken() [2/5]

xalanc::XToken::XToken	(	const XalanDOMString &	theString,
		double	theNumber,
		MemoryManager &	theMemoryManager
	)

Create an XToken for string in the token queue.

Parameters

theString	The string data for the token. The instance will keep a point to this string, so it must be persistent.
theNumber	The numeric data for the token. This must be consistent with the lexical value in theString.
theMemoryManager	The MemoryManager instance.

◆ XToken() [3/5]

xalanc::XToken::XToken	(	double	theNumber,
		const XalanDOMString &	theString,
		MemoryManager &	theMemoryManager
	)

Create an XToken for number in the token queue.

Parameters

theNumber	The numeric data for the token. This must be consistent with the lexical value in theString.
theString	The string data for the token. The instance will keep a point to this string, so it must be persistent.
theMemoryManager	The MemoryManager instance.

◆ XToken() [4/5]

xalanc::XToken::XToken ( const XToken & theSource )

Create an XToken from another one.

In most cases, the following copy constructor, which accepts an explicit MemoryManager instance, is recommended.

Parameters

theSource The source XToken instance.

◆ XToken() [5/5]

xalanc::XToken::XToken	(	const XToken &	theSource,
		MemoryManager &	theMemoryManager
	)

Create an XToken from another one.

Parameters

theSource	The source XToken instance.
theMemoryManager	The MemoryManager instance.

◆ ~XToken()

virtual xalanc::XToken::~XToken ( )

virtual

Member Function Documentation

◆ boolean() [1/2]

bool xalanc::XToken::boolean ( ) const

inline

Definition at line 154 of file XToken.hpp.

◆ boolean() [2/2]

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

virtual

Cast result object to a boolean.

Parameters

executionContext The current XPathExecutionContext

Returns: boolean value

Implements xalanc::XObject.

◆ dereferenced()

virtual void xalanc::XToken::dereferenced ( )

protectedvirtual

Reimplemented from xalanc::XObject.

◆ getTypeString()

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

virtual

Given a request type, return the equivalent string.

For diagnostic purposes.

Returns: string for type

Implements xalanc::XObject.

◆ num() [1/2]

double xalanc::XToken::num ( ) const

inlinevirtual

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

Reimplemented from xalanc::XObject.

Definition at line 162 of file XToken.hpp.

◆ num() [2/2]

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

virtual

Cast result object to a number.

Parameters

executionContext The current XPathExecutionContext

Returns: numeric value

Reimplemented from xalanc::XObject.

◆ operator=()

XToken& xalanc::XToken::operator= ( const XToken & theRHS )

inline

Definition at line 144 of file XToken.hpp.

◆ ProcessXObjectTypeCallback() [1/2]

virtual void xalanc::XToken::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::XToken::ProcessXObjectTypeCallback ( XObjectTypeCallback & theCallbackObject ) const

virtual

Process a callback request for preferred type information.

Parameters

theCallbackObject object to call back

Implements xalanc::XObject.

◆ referenced()

virtual void xalanc::XToken::referenced ( )

protectedvirtual

Reimplemented from xalanc::XObject.

◆ set() [1/2]

void xalanc::XToken::set	(	const XalanDOMString &	theString,
		double	theNumber
	)

Set the instance as a string in the token queue.

Parameters

theString	The string data for the token. XToken will keep a point to this string, so it must be persistent.
theNumber	The numeric data for the token. This must be consistent with the lexical value in theString.

◆ set() [2/2]

void xalanc::XToken::set	(	double	theNumber,
		const XalanDOMString &	theString
	)

Set the instance as a number in the token queue.

Parameters

theNumber	The numeric data for the token. This must be consistent with the lexical value in theString.
theString	The string data for the token. XToken will keep a point to this string, so it must be persistent.

◆ str() [1/6]

virtual const XalanDOMString& xalanc::XToken::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::XToken::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::XToken::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::XToken::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::XToken::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::XToken::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() [1/2]

double xalanc::XToken::stringLength ( ) const

inline

Definition at line 170 of file XToken.hpp.

◆ stringLength() [2/2]

virtual double xalanc::XToken::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/XToken.hpp

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ XToken() [1/5]

◆ XToken() [2/5]

◆ XToken() [3/5]

◆ XToken() [4/5]

◆ XToken() [5/5]

◆ ~XToken()

Member Function Documentation

◆ boolean() [1/2]

◆ boolean() [2/2]

◆ dereferenced()

◆ getTypeString()

◆ num() [1/2]

◆ num() [2/2]

◆ operator=()

◆ ProcessXObjectTypeCallback() [1/2]

◆ ProcessXObjectTypeCallback() [2/2]

◆ referenced()

◆ set() [1/2]

◆ set() [2/2]

◆ str() [1/6]

◆ str() [2/6]

◆ str() [3/6]

◆ str() [4/6]

◆ str() [5/6]

◆ str() [6/6]

◆ stringLength() [1/2]

◆ stringLength() [2/2]