Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.10

Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Attributes | Friends
XObject Class Reference

Class to hold XPath return types. More...

Inheritance diagram for XObject:
XalanReferenceCountedObject XBoolean XNodeSetBase XNull XNumberBase XResultTreeFrag XStringBase XToken XUnknown

List of all members.

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Attributes

Friends


Detailed Description

Class to hold XPath return types.


Member Typedef Documentation

typedef void(FormatterListener::* XObject::MemberFunctionPtr)(const XMLCh *const, const unsigned int)

Member Enumeration Documentation

Enumeration of possible object types.

Enumerator:
eTypeNull 
eTypeUnknown 
eTypeBoolean 
eTypeNumber 
eTypeString 
eTypeNodeSet 
eTypeResultTreeFrag 
eTypeUserDefined 
eTypeStringReference 
eTypeStringAdapter 
eTypeStringCached 
eTypeXTokenNumberAdapter 
eTypeXTokenStringAdapter 
eTypeNodeSetNodeProxy 
eUnknown 

Constructor & Destructor Documentation

XObject::XObject ( eObjectType  theObjectType)

Create an XObject.

Parameters:
theObjectTypeThe enum for the type of the object.
XObject::XObject ( const XObject source)
virtual XObject::~XObject ( ) [protected, virtual]

Member Function Documentation

virtual bool XObject::boolean ( ) const [virtual]

Cast result object to a boolean.

Returns:
boolean value

Reimplemented in XBoolean, XNodeSetBase, XNull, XNumberBase, XStringBase, XToken, XUnknown, and XResultTreeFrag.

static bool XObject::boolean ( double  theNumber) [static]

Static conversion function.

Returns:
bool value
static bool XObject::boolean ( const XalanDOMString theString) [static]

Static conversion function.

Returns:
bool value
static bool XObject::boolean ( const NodeRefListBase theNodeList) [static]

Static conversion function.

Returns:
bool value
virtual void XObject::dereferenced ( ) [protected, virtual]

Implements XalanReferenceCountedObject.

Reimplemented in XToken, and XResultTreeFrag.

bool XObject::equals ( const XObject theRHS,
XPathExecutionContext executionContext 
) const

Tell if two objects are functionally equal.

Parameters:
theRHSobject to compare
executionContextthe current execution context
Returns:
true if they are equal
virtual eObjectType XObject::getRealType ( ) const [protected, virtual]

Tell what kind of class this is.

Returns:
numeric type value

Reimplemented in XNodeSetNodeProxy, XStringAdapter, XStringCached, XStringReference, XTokenNumberAdapter, and XTokenStringAdapter.

eObjectType XObject::getType ( ) const

Tell what kind of class this is.

Returns:
numeric type value
virtual const XalanDOMString& XObject::getTypeString ( ) const [pure virtual]

Given a request type, return the equivalent string.

For diagnostic purposes.

Returns:
string for type

Implemented in XBoolean, XNodeSetBase, XNull, XNumberBase, XStringBase, XToken, XUnknown, and XResultTreeFrag.

bool XObject::greaterThan ( const XObject theRHS,
XPathExecutionContext executionContext 
) const

Tell if one object is greater than the other.

Parameters:
theRHSobject to compare
Returns:
true if they are equal
bool XObject::greaterThanOrEquals ( const XObject theRHS,
XPathExecutionContext executionContext 
) const

Tell if one object is greater than or equal the other.

Parameters:
theRHSobject to compare
Returns:
true if they are equal
static void XObject::initialize ( MemoryManagerType theManager) [static]

Perform static initialization.

See class XPathInit.

Reimplemented in XUnknown.

bool XObject::lessThan ( const XObject theRHS,
XPathExecutionContext executionContext 
) const

Tell if one object is less than the other.

Parameters:
theRHSobject to compare
Returns:
true if they are equal
bool XObject::lessThanOrEquals ( const XObject theRHS,
XPathExecutionContext executionContext 
) const

Tell if one object is less than or equal the other.

Parameters:
theRHSobject to compare
Returns:
true if they are equal
virtual const NodeRefListBase& XObject::nodeset ( ) const [virtual]

Cast result object to a nodelist.

Returns:
node list

Reimplemented in XNodeSet, XNodeSetBase, XNodeSetNodeProxy, and XResultTreeFrag.

bool XObject::notEquals ( const XObject theRHS,
XPathExecutionContext executionContext 
) const

Tell if two objects are functionally not equal.

Parameters:
theRHSobject to compare
executionContextthe current execution context
Returns:
true if they are equal
virtual double XObject::num ( ) const [virtual]

Cast result object to a number.

Returns:
numeric value

Reimplemented in XBoolean, XNodeSetBase, XNull, XNumber, XNumberBase, XStringBase, XToken, XTokenNumberAdapter, XTokenStringAdapter, XUnknown, and XResultTreeFrag.

static double XObject::number ( bool  theBoolean) [static]

Static conversion function.

Returns:
bool value
static double XObject::number ( XPathExecutionContext executionContext,
const NodeRefListBase theNodeList 
) [static]

Static conversion function.

Returns:
The number value of the node list
static double XObject::number ( const XalanDOMString theString,
MemoryManagerType theManager 
) [static]
static double XObject::number ( XPathExecutionContext executionContext,
const XalanNode theNode 
) [static]

Static conversion function.

Returns:
The number value of the node
virtual void XObject::ProcessXObjectTypeCallback ( XObjectTypeCallback theCallbackObject) [pure virtual]

Process a callback request for preferred type information.

Parameters:
theCallbackObjectobject to call back

Implemented in XBoolean, XNodeSetBase, XNull, XNumberBase, XStringBase, XToken, XUnknown, and XResultTreeFrag.

virtual void XObject::ProcessXObjectTypeCallback ( XObjectTypeCallback theCallbackObject) const [pure virtual]

Process a callback request for preferred type information.

Parameters:
theCallbackObjectobject to call back

Implemented in XBoolean, XNodeSetBase, XNull, XNumberBase, XStringBase, XToken, XUnknown, and XResultTreeFrag.

virtual void XObject::referenced ( ) [protected, virtual]

Implements XalanReferenceCountedObject.

Reimplemented in XToken.

virtual const XalanDocumentFragment& XObject::rtree ( ) const [virtual]

Cast result object to a result tree fragment.

Returns:
result tree fragment

Reimplemented in XNodeSetBase, XStringBase, and XResultTreeFrag.

void XObject::setFactory ( XObjectFactory theFactory)
virtual void XObject::str ( XalanDOMString theBuffer) const [virtual]

Append the string value directly a string.

Parameters:
theBufferThe buffer for the data

Reimplemented in XNodeSetBase, XNumber, XToken, XTokenNumberAdapter, XTokenStringAdapter, and XResultTreeFrag.

virtual const XalanDOMString& XObject::str ( ) const [virtual]
virtual void XObject::str ( FormatterListener formatterListener,
MemberFunctionPtr  function 
) const [pure virtual]

Send the string value to a FormatterListener instance.

Parameters:
formatterListenerThe FormatterListener instance
functionA pointer to the member function of FormatterListener to call

Implemented in XBoolean, XNodeSetBase, XNull, XNumber, XNumberBase, XString, XStringAdapter, XStringBase, XStringCached, XStringReference, XToken, XTokenNumberAdapter, XTokenStringAdapter, XUnknown, and XResultTreeFrag.

static void XObject::string ( double  theNumber,
FormatterListener formatterListener,
MemberFunctionPtr  function 
) [static]
static void XObject::string ( const XalanNode theNode,
XalanDOMString theString 
) [static]

Static conversion function.

Returns:
The string value of the node
static void XObject::string ( double  theNumber,
XalanDOMString theString 
) [static]

Static conversion function.

Returns:
The string value of the number
static const XalanDOMString& XObject::string ( bool  theBool) [static]

Static conversion function.

Returns:
The string value of the number
static void XObject::string ( bool  theBool,
FormatterListener formatterListener,
MemberFunctionPtr  function 
) [static]
static void XObject::string ( const NodeRefListBase theNodeList,
FormatterListener formatterListener,
MemberFunctionPtr  function 
) [static]
static void XObject::string ( const XalanNode theNode,
FormatterListener formatterListener,
MemberFunctionPtr  function 
) [static]
static void XObject::string ( const NodeRefListBase theNodeList,
XalanDOMString theString 
) [static]

Static conversion function.

Returns:
The string value of the node list
virtual double XObject::stringLength ( ) const [pure virtual]

Get the length of the string value of the instance.

Returns:
The length of the string value

Implemented in XBoolean, XNodeSetBase, XNull, XNumber, XNumberBase, XString, XStringAdapter, XStringBase, XStringCached, XStringReference, XToken, XTokenNumberAdapter, XTokenStringAdapter, XUnknown, and XResultTreeFrag.

static void XObject::terminate ( ) [static]

Perform static shut down.

See class XPathInit.

Reimplemented in XNull, and XUnknown.


Friends And Related Function Documentation

friend class XObjectFactory [friend]
friend class XObjectPtr [friend]

Member Data Documentation

const XalanDOMString& XObject::s_booleanString [static, protected]
const XalanDOMString XObject::s_emptyString [static, protected]
const XalanDOMString& XObject::s_falseString [static, protected]
const XalanDOMString& XObject::s_nodesetString [static, protected]
const XalanDOMString& XObject::s_numberString [static, protected]
const XalanDOMString& XObject::s_stringString [static, protected]
const XalanDOMString& XObject::s_trueString [static, protected]

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

Interpreting class diagrams

Doxygen and GraphViz are used to generate this API documentation from the Xalan-C header files.

dot

Xalan-C++ XSLT Processor Version 1.10
Copyright © 1999-2004 The Apache Software Foundation. All Rights Reserved.

Apache Logo