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

DSIGXPathFilterExpr Class Reference
[Main Signature API]

#include <DSIGXPathFilterExpr.hpp>

Collaboration diagram for DSIGXPathFilterExpr:

Collaboration graph
[legend]
List of all members.

Detailed Description

Class used to hold (and manipulate) individual expressions in an XPathFilter transform.

See also:
TXFMXPathFilter

DSIGTransformXpathFilter


Public Member Functions

Constructors and Destructors
 DSIGXPathFilterExpr (const XSECEnv *env, XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *node)
 Constructor used for existing XML signatures.
 DSIGXPathFilterExpr (const XSECEnv *env)
 Builder constructor.
 ~DSIGXPathFilterExpr ()
 Destructor.
Set and get Information
void load (void)
 Read in existing structure.
xpathFilterType getFilterType (void)
 Get the filter type.
XERCES_CPP_NAMESPACE_QUALIFIER
DOMElement * 
setFilter (xpathFilterType filterType, const XMLCh *filterExpr)
 create from blank
const XMLCh * getFilter (void)
 Get the filter expression.
void setNamespace (const XMLCh *prefix, const XMLCh *value)
 Add a new namespace to the list to be used.
XERCES_CPP_NAMESPACE_QUALIFIER
DOMNamedNodeMap * 
getNamespaces (void)
 Get the list of namespaces.
void deleteNamespace (const XMLCh *prefix)
 Delete a namespace to the list to be used.

Friends

class TXFMXPathFilter


Constructor & Destructor Documentation

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

Constructor used for existing XML signatures.

Node already exists and is part of an existing XPathFilter tree

Parameters:
env The operating environment
node The node that will be used to read the expression in

DSIGXPathFilterExpr::DSIGXPathFilterExpr const XSECEnv env  ) 
 

Builder constructor.

Used to create the DOM structure and DSIGSignature elements

Parameters:
env The operating Environment

DSIGXPathFilterExpr::~DSIGXPathFilterExpr  ) 
 

Destructor.

Destroy the DSIGSignature elements.

Does not destroy any associated DOM Nodes


Member Function Documentation

void DSIGXPathFilterExpr::deleteNamespace const XMLCh *  prefix  ) 
 

Delete a namespace to the list to be used.

Delete a namespace from the XPath Element.

Parameters:
prefix NCName of the Namespace to delete
Exceptions:
XSECException if the NCName does not exist

const XMLCh* DSIGXPathFilterExpr::getFilter void   )  [inline]
 

Get the filter expression.

Returns an XMLCh string containing the filter expression

Returns:
The filter expression

xpathFilterType DSIGXPathFilterExpr::getFilterType void   ) 
 

Get the filter type.

Returns the type of this particular XPath filter

Returns:
The filter type of this expression

XERCES_CPP_NAMESPACE_QUALIFIER DOMNamedNodeMap* DSIGXPathFilterExpr::getNamespaces void   )  [inline]
 

Get the list of namespaces.

Returns the DOMNamedNodeMap of the attributes of the XPath transform node.

Note:
This will also contain the Filter attribute
Returns:
A pointer to the NamedNodeMap

void DSIGXPathFilterExpr::load void   ) 
 

Read in existing structure.

Reads DOM structure of the XPath expression

XERCES_CPP_NAMESPACE_QUALIFIER DOMElement* DSIGXPathFilterExpr::setFilter xpathFilterType  filterType,
const XMLCh *  filterExpr
 

create from blank

Given the filter type and XPath expression, setup the DOMNodes and variables to allow signing and validation

Parameters:
filterType Type of this filter to add
filterExpr The XPath expression

void DSIGXPathFilterExpr::setNamespace const XMLCh *  prefix,
const XMLCh *  value
 

Add a new namespace to the list to be used.

Add a new namespace to the XPath Element.

Parameters:
prefix NCName of the Namespace to set
value The string with the URI to set


Friends And Related Function Documentation

friend class TXFMXPathFilter [friend]
 


The documentation for this class was generated from the following file:
Generated on Sun Jul 3 17:41:50 2005 for XML-Security-C by  doxygen 1.4.2