Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.11


Classes | Public Types | Public Member Functions | Protected Member Functions | Friends

XObjectFactory Class Reference

This class handles the creation of XObjects and manages their lifetime. More...

#include <XObjectFactory.hpp>

Inherited by XObjectFactoryDefault.

List of all members.

Classes

Public Types

Public Member Functions

Protected Member Functions

Friends


Detailed Description

This class handles the creation of XObjects and manages their lifetime.

Definition at line 53 of file XObjectFactory.hpp.


Member Typedef Documentation

Definition at line 57 of file XObjectFactory.hpp.

Definition at line 59 of file XObjectFactory.hpp.

Definition at line 58 of file XObjectFactory.hpp.


Constructor & Destructor Documentation

XObjectFactory::XObjectFactory ( MemoryManager &  theManager  ) 
virtual XObjectFactory::~XObjectFactory (  )  [virtual]

Member Function Documentation

virtual const XObjectPtr XObjectFactory::createBoolean ( bool  theValue  )  [pure virtual]

Create a boolean XObject from a boolean value.

Parameters:
theValue value used to create object
Returns:
pointer to new object

Implemented in XObjectFactoryDefault.

virtual const XObjectPtr XObjectFactory::createNodeSet ( BorrowReturnMutableNodeRefList theValue  )  [pure virtual]

Create a node set XObject from a node list.

Parameters:
theValue value used to create object. theValue will be owned by the new XObject.
Returns:
pointer to new object

Implemented in XObjectFactoryDefault.

virtual const XObjectPtr XObjectFactory::createNodeSet ( XalanNode theValue  )  [pure virtual]

Create a node set XObject from a node.

Parameters:
theNOde value used to create object.
Returns:
pointer to new object

Implemented in XObjectFactoryDefault.

virtual const XObjectPtr XObjectFactory::createNumber ( const XToken theValue  )  [pure virtual]

Create a numeric XObject from an XToken.

The XToken instance must be inexistence for the lifetime of the object.

Parameters:
theValue value used to create object
Returns:
pointer to new object

Implemented in XObjectFactoryDefault.

virtual const XObjectPtr XObjectFactory::createNumber ( double  theValue  )  [pure virtual]

Create a numeric XObject from a number.

Parameters:
theValue value used to create object
Returns:
pointer to new object

Implemented in XObjectFactoryDefault.

virtual const XObjectPtr XObjectFactory::createString ( const XalanDOMString theValue  )  [pure virtual]

Create a string XObject from a string.

Parameters:
theValue value used to create object
Returns:
pointer to new object

Implemented in XObjectFactoryDefault.

virtual const XObjectPtr XObjectFactory::createString ( const XalanDOMChar *  theValue  )  [pure virtual]

Create a string XObject from a null-terminated array of characters.

Parameters:
theValue a pointer to the array
Returns:
pointer to new object

Implemented in XObjectFactoryDefault.

virtual const XObjectPtr XObjectFactory::createString ( const XalanDOMChar *  theValue,
XalanSize_t  theLength 
) [pure virtual]

Create a string XObject from an array of characters.

Parameters:
theValue a pointer to the array theLength the length of the array
Returns:
pointer to new object

Implemented in XObjectFactoryDefault.

virtual const XObjectPtr XObjectFactory::createString ( const XToken theValue  )  [pure virtual]

Create a string XObject from an XToken.

The XToken instance must be inexistence for the lifetime of the object.

Parameters:
theValue value used to create object
Returns:
pointer to new object

Implemented in XObjectFactoryDefault.

virtual const XObjectPtr XObjectFactory::createString ( GetCachedString theValue  )  [pure virtual]

Create a string XObject from a cached XalanDOMString,.

Parameters:
theValue value used to create object
Returns:
pointer to new object

Implemented in XObjectFactoryDefault.

virtual const XObjectPtr XObjectFactory::createStringAdapter ( const XObjectPtr theValue,
XPathExecutionContext theExecutionContext 
) [pure virtual]

Create a string XObject that will adapt another XObject to behave like a string.

The XObject holds a reference to the other XObject.

Parameters:
theValue value used to create object theExecutionContext The current execution context
Returns:
pointer to new object

Implemented in XObjectFactoryDefault.

virtual const XObjectPtr XObjectFactory::createStringReference ( const XalanDOMString theValue  )  [pure virtual]

Create a string XObject from a string.

The XObject will hold a reference to the supplied string, so the string must be in scope for the lifetime of the instance

Parameters:
theValue value used to create object
Returns:
pointer to new object

Implemented in XObjectFactoryDefault.

virtual const XObjectPtr XObjectFactory::createUnknown ( const XalanDOMString theValue  )  [pure virtual]

Create an "unknown" XObject from a string.

Parameters:
theValue value used to create object
Returns:
pointer to new object

Implemented in XObjectFactoryDefault.

void XObjectFactory::deleteObject ( const XObject theXObject  )  const [inline, protected]

Delete a FactoryObject instance.

Parameters:
theXObject the XObject instance to delete.

Definition at line 300 of file XObjectFactory.hpp.

virtual bool XObjectFactory::doReturnObject ( XObject theXObject,
bool  fInReset = false 
) [protected, pure virtual]

Return an XObject to the factory.

Parameters:
theXObject XObject to be returned
fInReset true when called during reset().

Implemented in XObjectFactoryDefault.

MemoryManager& XObjectFactory::getMemoryManager (  )  [inline]

Reimplemented in XObjectFactoryDefault.

Definition at line 69 of file XObjectFactory.hpp.

XObject::eObjectType XObjectFactory::getRealType ( const XObject theXObject  )  const [inline, protected]

Return the actual implementation type of an XObject.

Parameters:
theXObject the XObject

Definition at line 289 of file XObjectFactory.hpp.

virtual void XObjectFactory::holdReference ( XObjectPtr  theValue  )  [pure virtual]

Hold a reference to an XObject instance until the factory is reset.

This is needed in a very few cases when the object lifetime needs to extend after the execution of an XPath expression.

Parameters:
theValue The XObjectPtr instance.

Implemented in XObjectFactoryDefault.

virtual void XObjectFactory::reset (  )  [pure virtual]

Reset the instance.

This invalidates all existing instances created with this XObjectFactory.

Implemented in XObjectFactoryDefault.

bool XObjectFactory::returnObject ( XObject theXObject  )  [inline]

Return an XObject to the factory.

Parameters:
theXObject The XObject to be returned
Returns:
true if the object belongs to the factory, false if not.

Definition at line 81 of file XObjectFactory.hpp.


Friends And Related Function Documentation

friend struct DeleteXObjectFunctor [friend]

Definition at line 279 of file XObjectFactory.hpp.


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.

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

Apache Logo