Main Page | Modules | Class Hierarchy | Class List | Directories | File List | Class Members | File Members | Related Pages

DSIGTransformXPathFilter Class Reference
[Main Signature API]

#include <DSIGTransformXPathFilter.hpp>

Inheritance diagram for DSIGTransformXPathFilter:

Inheritance graph
[legend]
Collaboration diagram for DSIGTransformXPathFilter:

Collaboration graph
[legend]
List of all members.

Detailed Description

Transform holder for XPath Filter transforms.

The DSIGTransformXPath class is used to hold XPath <Transform> elements within a document.

See also:
TXFMXPath

DSIGTransform


Public Types

typedef std::vector< DSIGXPathFilterExpr * > exprVectorType
 Vector used to pass the actual expressions into the transformer.

Public Member Functions

Constructors and Destructors
 DSIGTransformXPathFilter (const XSECEnv *env, XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *node)
 Contructor used for existing XML signatures.
 DSIGTransformXPathFilter (const XSECEnv *env)
 Contructor used for new signatures.
virtual ~DSIGTransformXPathFilter ()
 Destructor.
Interface Methods
virtual transformType getTransformType ()
 Determine the transform type.
virtual void appendTransformer (TXFMChain *input)
 Create the XPath Filter Transformer class.
virtual XERCES_CPP_NAMESPACE_QUALIFIER
DOMElement * 
createBlankTransform (XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument *parentDoc)
 Construct blank XPath Transform element.
virtual void load (void)
 Load a DOM structure.
XPathFilter specific methods
DSIGXPathFilterExprappendFilter (xpathFilterType filterType, const XMLCh *filterExpr)
 Append a new filter to the transform.
unsigned int getExprNum (void)
 Retrieve number of expressions.
DSIGXPathFilterExprexpr (unsigned int n)
 Get expression.


Member Typedef Documentation

typedef std::vector<DSIGXPathFilterExpr *> DSIGTransformXPathFilter::exprVectorType
 

Vector used to pass the actual expressions into the transformer.


Constructor & Destructor Documentation

DSIGTransformXPathFilter::DSIGTransformXPathFilter const XSECEnv env,
XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *  node
 

Contructor used for existing XML signatures.

The Node structure already exists, so read the nodes in.

Parameters:
env The operating environment
node The DOM node (within doc) that is to be used as the base of the Transform.
See also:
load

DSIGTransformXPathFilter::DSIGTransformXPathFilter const XSECEnv env  ) 
 

Contructor used for new signatures.

The Node structure will have to be created.

Note:
DSIGTransform structures should only ever be created via calls to a DSIGTransformList object.
Parameters:
env The operating environment
See also:
createBlankTransform

virtual DSIGTransformXPathFilter::~DSIGTransformXPathFilter  )  [virtual]
 

Destructor.

Destroy the DSIGSignature elements.

Does not destroy any associated DOM Nodes


Member Function Documentation

DSIGXPathFilterExpr* DSIGTransformXPathFilter::appendFilter xpathFilterType  filterType,
const XMLCh *  filterExpr
 

Append a new filter to the transform.

Appends the indicated filter (of given type) to the list of filters in the transform.

Parameters:
filterType The type of this filter
filterExpr The XPath expression to use
Returns:
The filter expression

virtual void DSIGTransformXPathFilter::appendTransformer TXFMChain input  )  [virtual]
 

Create the XPath Filter Transformer class.

Create the transformer associated with this XPath transform. Will set the expression and Namespaces as appropriate

Returns:
The TXFMXPath transformer associated with this Transform

Implements DSIGTransform.

virtual XERCES_CPP_NAMESPACE_QUALIFIER DOMElement* DSIGTransformXPathFilter::createBlankTransform XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument *  parentDoc  )  [virtual]
 

Construct blank XPath Transform element.

Instruct the implementation to create the required transform and return the newly constructed DOMNode structure

Implements DSIGTransform.

DSIGXPathFilterExpr* DSIGTransformXPathFilter::expr unsigned int  n  ) 
 

Get expression.

Allows the caller to retrieve the specified expression from the XPath Filter object

Parameters:
n The index of the expression to retrieve
Returns:
The indicated expression

unsigned int DSIGTransformXPathFilter::getExprNum void   ) 
 

Retrieve number of expressions.

Allows callers to determine how many expressions there are in this filter

Returns:
The number of expressions

virtual transformType DSIGTransformXPathFilter::getTransformType  )  [virtual]
 

Determine the transform type.

Used to determine what the type of the transform is.

Implements DSIGTransform.

virtual void DSIGTransformXPathFilter::load void   )  [virtual]
 

Load a DOM structure.

Load the expression and Namespaces.

Implements DSIGTransform.


The documentation for this class was generated from the following file:
Generated on Sun Jan 28 19:45:19 2007 for XML-Security-C by  doxygen 1.4.2