## Xalan-C++ API Documentation

### The Xalan C++ XSLT Processor Version 1.9

Main Page | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members | Related Pages

# XNodeSetBase Class Reference

Class to hold XPath return types. More...

Inheritance diagram for XNodeSetBase:

[legend]
Collaboration diagram for XNodeSetBase:

[legend]
List of all members.

## Public Types

- typedef NodeRefListBase::size_type size_type

## Public Member Functions

- virtual ~XNodeSetBase ()
- MemoryManagerType & getMemoryManager () const
- virtual const XalanDOMString & getTypeString () const
    Given a request type, return the equivalent string.
- virtual double num () const
    Cast result object to a number.
- virtual bool boolean () const
    Cast result object to a boolean.
- virtual const XalanDOMString & str () const
    Cast result object to a string.
- virtual void str (FormatterListener &formatterListener, MemberFunctionPtr function) const
    Send the string value to a FormatterListener instance.
- virtual void str (XalanDOMString &theBuffer) const
    Append the string value directly a string.
- virtual double stringLength () const
    Get the length of the string value of the instance..
- virtual const XalanDocumentFragment & rtree () const
    Cast result object to a result tree fragment.
- virtual const NodeRefListBase & nodeset () const=0
    Cast result object to a nodelist.
- virtual void ProcessXObjectTypeCallback (XObjectTypeCallback &theCallbackObject)
    Process a callback request for preferred type information.
- virtual void ProcessXObjectTypeCallback (XObjectTypeCallback &theCallbackObject) const
    Process a callback request for preferred type information.
- virtual XalanNode * item (size_type index) const=0
- virtual size_type getLength () const=0

## Protected Member Functions

- XNodeSetBase (MemoryManagerType &theManager)
    Create an XNodeSetBase.
- XNodeSetBase (const XNodeSetBase &source, MemoryManagerType &theManager)
    Create an XNodeSetBase from another.
- void clearCachedValues ()

## Detailed Description

Class to hold XPath return types.

## Member Typedef Documentation

typedef NodeRefListBase::size_type XNodeSetBase::size_type

## Constructor & Destructor Documentation

virtual XNodeSetBase::~XNodeSetBase | ( |  | ) | `[virtual]`

XNodeSetBase::XNodeSetBase | ( | MemoryManagerType & | theManager | ) | `[protected]`

| Create an XNodeSetBase.

XNodeSetBase::XNodeSetBase | ( | const XNodeSetBase & | source,
|  | MemoryManagerType & | theManager
| ) | `[protected]`

Create an XNodeSetBase from another.

Parameters:

  source | object to copy

## Member Function Documentation

virtual bool XNodeSetBase::boolean | ( |  | ) | const`[virtual]`

Cast result object to a boolean.

Returns:
  boolean value

Reimplemented from XObject.

void XNodeSetBase::clearCachedValues | ( |  | ) | `[protected]`

virtual size_type XNodeSetBase::getLength | ( |  | ) | const`[pure virtual]`

| Implemented in XNodeSet, and XNodeSetNodeProxy.

MemoryManagerType& XNodeSetBase::getMemoryManager | ( |  | ) | const

virtual const XalanDOMString& XNodeSetBase::getTypeString | ( |  | ) | const`[virtual]`

Given a request type, return the equivalent string.

For diagnostic purposes.

Returns:
  string for type

Implements XObject.

virtual XalanNode* XNodeSetBase::item | ( | size_type | index | ) | const`[pure virtual]`

| Implemented in XNodeSet, and XNodeSetNodeProxy.

virtual const NodeRefListBase& XNodeSetBase::nodeset | ( |  | ) | const`[pure virtual]`

Cast result object to a nodelist.

Returns:
  node list

Reimplemented from XObject.

Implemented in XNodeSet, and XNodeSetNodeProxy.

virtual double XNodeSetBase::num | ( |  | ) | const`[virtual]`

Cast result object to a number.

Returns:
  numeric value

Reimplemented from XObject.

virtual void XNodeSetBase::ProcessXObjectTypeCallback | ( | XObjectTypeCallback & | theCallbackObject | ) | const`[virtual]`

Process a callback request for preferred type information.

Parameters:

  theCallbackObject | object to call back

Implements XObject.

virtual void XNodeSetBase::ProcessXObjectTypeCallback | ( | XObjectTypeCallback & | theCallbackObject | ) | `[virtual]`

Process a callback request for preferred type information.

Parameters:

  theCallbackObject | object to call back

Implements XObject.

virtual const XalanDocumentFragment& XNodeSetBase::rtree | ( |  | ) | const`[virtual]`

Cast result object to a result tree fragment.

Returns:
  result tree fragment

Reimplemented from XObject.

virtual void XNodeSetBase::str | ( | XalanDOMString & | theBuffer | ) | const`[virtual]`

Append the string value directly a string.

Parameters:

  theBuffer | The buffer for the data

Reimplemented from XObject.

virtual void XNodeSetBase::str | ( | FormatterListener & | formatterListener,
|  | MemberFunctionPtr | function
| ) | const`[virtual]`

Send the string value to a FormatterListener instance.

Parameters:

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

Implements XObject.

virtual const XalanDOMString& XNodeSetBase::str | ( |  | ) | const`[virtual]`

Cast result object to a string.

Returns:
  string value

Reimplemented from XObject.

virtual double XNodeSetBase::stringLength | ( |  | ) | const`[virtual]`

Get the length of the string value of the instance..

Returns:
  The length of the string value

Implements XObject.

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

- XNodeSetBase.hpp

Interpreting class diagrams

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

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