DSIGTransformXPath Class Reference
[Main Signature API]

#include <DSIGTransformXPath.hpp>

Inheritance diagram for DSIGTransformXPath:

[legend]Collaboration diagram for DSIGTransformXPath:

[legend]List of all members.

---

Detailed Description

Transform holder for XPath transforms.

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

See also:

TXFMXPath

DSIGTransform

Public Member Functions
Constructors and Destructors
	DSIGTransformXPath (const XSECEnv *env, XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *node)
	Contructor used for existing XML signatures.
	DSIGTransformXPath (const XSECEnv *env)
	Contructor used for new signatures.
virtual	~DSIGTransformXPath ()
	Destructor.
Interface Methods
virtual transformType	getTransformType ()
	Determine the transform type.
virtual void	appendTransformer (TXFMChain *input)
	Create the XPath 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.
XPath specific methods
void	setExpression (const char *expr)
	Set the XPath expression.
const char *	getExpression (void)
	Get the XPath expression.
void	setNamespace (const char *prefix, const char *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 char *prefix)
	Delete a namespace to the list to be used.

---

Constructor & Destructor Documentation

DSIGTransformXPath::DSIGTransformXPath (  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

DSIGTransformXPath::DSIGTransformXPath (  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 DSIGTransformXPath::~DSIGTransformXPath (   )  [virtual]

Destructor. Destroy the DSIGSignature elements. Does not destroy any associated DOM Nodes

---

Member Function Documentation

virtual void DSIGTransformXPath::appendTransformer (  TXFMChain *  input  )  [virtual]

Create the XPath 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* DSIGTransformXPath::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.

void DSIGTransformXPath::deleteNamespace (  const char *  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 char* DSIGTransformXPath::getExpression (  void   )

Get the XPath expression. Returns a character buffer with the expression inside it. Note: Do not delete the returned pointer - it is owned by the object. Returns: The expression

XERCES_CPP_NAMESPACE_QUALIFIER DOMNamedNodeMap* DSIGTransformXPath::getNamespaces (  void   )  [inline]

Get the list of namespaces. Returns the DOMNamedNodeMap of the attributes of the XPath transform node. This should only contain namespaces. Returns: A pointer to the NamedNodeMap

virtual transformType DSIGTransformXPath::getTransformType (   )  [virtual]

Determine the transform type. Used to determine what the type of the transform is. Implements DSIGTransform.

virtual void DSIGTransformXPath::load (  void   )  [virtual]

Load a DOM structure. Load the expression and Namespaces. Implements DSIGTransform.

void DSIGTransformXPath::setExpression (  const char *  expr  )

Set the XPath expression. Takes the provided string and uses it to set the expression in the Signature and DOM structures. If an expression already exists, it is overwritten. Parameters: expr  The expression to set

void DSIGTransformXPath::setNamespace (  const char *  prefix, const char *  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

---

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

• DSIGTransformXPath.hpp

---