Xalan-C++ API Documentation

The Xalan C++ XSL Transformer Version 1.1

Main Page Class Hierarchy Alphabetical List Compound List File List Compound Members File Members

XNodeSet Class Reference

Class to hold XPath return types. More...

#include <XNodeSet.hpp>

Inheritance diagram for XNodeSet

[legend]Collaboration diagram for XNodeSet:

[legend]List of all members.

Public Types

typedef XPathExecutionContext::BorrowReturnMutableNodeRefList BorrowReturnMutableNodeRefList

Public Methods

XNodeSet (BorrowReturnMutableNodeRefList& value)
Create an XNodeSet from a node list. More...
XNodeSet ( const XNodeSet& source, bool deepClone = false)
Create an XNodeSet from another. More...
virtual ~XNodeSet ()
virtual XNodeSet* clone (void* theAddress = 0) const
Clone the instance. More...
virtual XalanDOMString getTypeString () const
Given a request type, return the equivalent string. More...
virtual double num () const
Cast result object to a number. More...
virtual bool boolean () const
Cast result object to a boolean. More...
virtual const XalanDOMString& str () const
Cast result object to a string. More...
virtual const ResultTreeFragBase& rtree (XPathExecutionContext& executionContext) const
Cast result object to a result tree fragment. More...
virtual const NodeRefListBase& nodeset () const
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...
void release ()
Release the node set held by the instance.
void set (BorrowReturnMutableNodeRefList& value)
Change the value of an XNodeSet. More...

Detailed Description

Class to hold XPath return types.

Member Typedef Documentation

typedef XPathExecutionContext::BorrowReturnMutableNodeRefList XNodeSet::BorrowReturnMutableNodeRefList

Constructor & Destructor Documentation

XNodeSet::XNodeSet ( BorrowReturnMutableNodeRefList & value )

Create an XNodeSet from a node list.

Parameters:

value Pointer to source node list. The XNodeSet will adopt the pointer.

XNodeSet::XNodeSet ( const XNodeSet & source,

bool deepClone = false )

Create an XNodeSet from another.

Parameters:

source object to copy

deepClone true to copy all children on nodeset nodes

virtual XNodeSet::~XNodeSet ( ) [virtual]

Member Function Documentation

virtual void XNodeSet::ProcessXObjectTypeCallback ( XObjectTypeCallback & theCallbackObject ) const [virtual]

Process a callback request for preferred type information.

Parameters:

theCallbackObject object to call back

Reimplemented from XObject.

virtual void XNodeSet::ProcessXObjectTypeCallback ( XObjectTypeCallback & theCallbackObject ) [virtual]

Process a callback request for preferred type information.

Parameters:

theCallbackObject object to call back

Reimplemented from XObject.

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

Cast result object to a boolean.

Returns:
boolean value

Reimplemented from XObject.

virtual XNodeSet* XNodeSet::clone ( void * theAddress = 0 ) const [virtual]

Clone the instance.

Parameters:

If theAddress is not null, the XObject will clone itself into that address.

Returns:
a clone of the instance.

Reimplemented from XObject.
Reimplemented in XSpan.

virtual XalanDOMString XNodeSet::getTypeString ( ) const [virtual]

Given a request type, return the equivalent string.
For diagnostic purposes.

Returns:
string for type

Reimplemented from XObject.

virtual const NodeRefListBase& XNodeSet::nodeset ( ) const [virtual]

Cast result object to a nodelist.

Returns:
node list

Reimplemented from XObject.

virtual double XNodeSet::num ( ) const [virtual]

Cast result object to a number.

Returns:
numeric value

Reimplemented from XObject.

void XNodeSet::release ( )

Release the node set held by the instance.

virtual const ResultTreeFragBase& XNodeSet::rtree ( XPathExecutionContext & executionContext ) const [virtual]

Cast result object to a result tree fragment.

Parameters:

executionContext the current execution context

Returns:
result tree fragment

Reimplemented from XObject.

void XNodeSet::set ( BorrowReturnMutableNodeRefList & value )

Change the value of an XNodeSet.

Parameters:

theValue The new value.

virtual const XalanDOMString& XNodeSet::str ( ) const [virtual]

Cast result object to a string.

Returns:
string value

Reimplemented from XObject.

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

XNodeSet.hpp

Interpreting class diagrams

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