Main Page   Modules   Class Hierarchy   Compound List   File List   Compound Members   File Members   Related Pages  

TXFMBase Class Reference
[Internal Classes]

Base class for transformers. More...

#include <TXFMBase.hpp>

Inheritance diagram for TXFMBase:

Inheritance graph
[legend]
Collaboration diagram for TXFMBase:

Collaboration graph
[legend]
List of all members.

Public Types

enum  ioType {
  NONE = 1,
  BYTE_STREAM = 2,
  DOM_NODES = 3
}
enum  nodeType {
  DOM_NODE_NONE = 1,
  DOM_NODE_DOCUMENT = 2,
  DOM_NODE_DOCUMENT_FRAGMENT = 3,
  DOM_NODE_DOCUMENT_NODE = 4,
  DOM_NODE_XPATH_NODESET = 5
}

Public Methods

 TXFMBase (DOMDocument *doc)
virtual ~TXFMBase ()
virtual void setInput (TXFMBase *newInput)=0
virtual ioType getInputType (void)=0
virtual ioType getOutputType (void)=0
virtual nodeType getNodeType (void)=0
virtual bool nameSpacesExpanded (void)
virtual void expandNameSpaces (void)
void deleteExpandedNameSpaces (void)
virtual void stripComments (void)
virtual void activateComments (void)
virtual bool getCommentsStatus (void)
virtual unsigned int readBytes (XMLByte *const toFill, const unsigned int maxToFill)=0
virtual DOMDocument * getDocument ()=0
virtual DOMNode * getFragmentNode ()=0
virtual const XMLCh * getFragmentId ()=0
virtual XSECXPathNodeListgetXPathNodeList ()

Protected Attributes

TXFMBase * input
bool keepComments
XSECNameSpaceExpandermp_nse
DOMDocument * mp_expansionDoc
XSECXPathNodeList m_XPathMap

Friends

class TXFMChain

Detailed Description

Base class for transformers.

Transformers are internal classes within the xml-security-c library that actually perform the transformations.

Users interface with the library should use the DSIGTransform classes, which define the DOM nodes and allow users to manipulate the actual transform defined.


Member Enumeration Documentation

enum TXFMBase::ioType
 

Enumeration values:
NONE 
BYTE_STREAM 
DOM_NODES 

enum TXFMBase::nodeType
 

Enumeration values:
DOM_NODE_NONE 
DOM_NODE_DOCUMENT 
DOM_NODE_DOCUMENT_FRAGMENT 
DOM_NODE_DOCUMENT_NODE 
DOM_NODE_XPATH_NODESET 


Constructor & Destructor Documentation

TXFMBase::TXFMBase DOMDocument *    doc [inline]
 

virtual TXFMBase::~TXFMBase   [virtual]
 


Member Function Documentation

virtual void TXFMBase::activateComments void    [virtual]
 

Reimplemented in TXFMC14n.

void TXFMBase::deleteExpandedNameSpaces void   
 

virtual void TXFMBase::expandNameSpaces void    [virtual]
 

Reimplemented in TXFMParser, and TXFMXSL.

virtual bool TXFMBase::getCommentsStatus void    [inline, virtual]
 

virtual DOMDocument* TXFMBase::getDocument   [pure virtual]
 

Implemented in TXFMBase64, TXFMC14n, TXFMDocObject, TXFMEnvelope, TXFMMD5, TXFMOutputFile, TXFMParser, TXFMSB, TXFMSHA1, TXFMURL, TXFMXPath, and TXFMXSL.

virtual const XMLCh* TXFMBase::getFragmentId   [pure virtual]
 

Implemented in TXFMBase64, TXFMC14n, TXFMDocObject, TXFMEnvelope, TXFMMD5, TXFMOutputFile, TXFMParser, TXFMSB, TXFMSHA1, TXFMURL, TXFMXPath, and TXFMXSL.

virtual DOMNode* TXFMBase::getFragmentNode   [pure virtual]
 

Implemented in TXFMBase64, TXFMC14n, TXFMDocObject, TXFMEnvelope, TXFMMD5, TXFMOutputFile, TXFMParser, TXFMSB, TXFMSHA1, TXFMURL, TXFMXPath, and TXFMXSL.

virtual ioType TXFMBase::getInputType void    [pure virtual]
 

Implemented in TXFMBase64, TXFMC14n, TXFMDocObject, TXFMEnvelope, TXFMMD5, TXFMOutputFile, TXFMParser, TXFMSB, TXFMSHA1, TXFMURL, TXFMXPath, and TXFMXSL.

virtual nodeType TXFMBase::getNodeType void    [pure virtual]
 

Implemented in TXFMBase64, TXFMC14n, TXFMDocObject, TXFMEnvelope, TXFMMD5, TXFMOutputFile, TXFMParser, TXFMSB, TXFMSHA1, TXFMURL, TXFMXPath, and TXFMXSL.

virtual ioType TXFMBase::getOutputType void    [pure virtual]
 

Implemented in TXFMBase64, TXFMC14n, TXFMDocObject, TXFMEnvelope, TXFMMD5, TXFMOutputFile, TXFMParser, TXFMSB, TXFMSHA1, TXFMURL, TXFMXPath, and TXFMXSL.

virtual XSECXPathNodeList& TXFMBase::getXPathNodeList   [inline, virtual]
 

Reimplemented in TXFMEnvelope, and TXFMXPath.

virtual bool TXFMBase::nameSpacesExpanded void    [virtual]
 

Reimplemented in TXFMParser, and TXFMXSL.

virtual unsigned int TXFMBase::readBytes XMLByte *const    toFill,
const unsigned int    maxToFill
[pure virtual]
 

Implemented in TXFMBase64, TXFMC14n, TXFMDocObject, TXFMEnvelope, TXFMMD5, TXFMOutputFile, TXFMParser, TXFMSB, TXFMSHA1, TXFMURL, TXFMXPath, and TXFMXSL.

virtual void TXFMBase::setInput TXFMBase *    newInput [pure virtual]
 

Implemented in TXFMBase64, TXFMC14n, TXFMDocObject, TXFMEnvelope, TXFMMD5, TXFMOutputFile, TXFMParser, TXFMSB, TXFMSHA1, TXFMURL, TXFMXPath, and TXFMXSL.

virtual void TXFMBase::stripComments void    [inline, virtual]
 


Friends And Related Function Documentation

friend class TXFMChain [friend]
 


Member Data Documentation

TXFMBase* TXFMBase::input [protected]
 

bool TXFMBase::keepComments [protected]
 

XSECXPathNodeList TXFMBase::m_XPathMap [protected]
 

DOMDocument* TXFMBase::mp_expansionDoc [protected]
 

XSECNameSpaceExpander* TXFMBase::mp_nse [protected]
 


The documentation for this class was generated from the following file:
Generated on Thu May 8 20:17:32 2003 for XML-Security-C by doxygen1.2.15