zeus::IXMLNode Class Reference

#include <IXMLNode.hpp>

Inheritance diagram for zeus::IXMLNode:

zeus::IZUnknown zeus::IXSDNode

List of all members.

Public Member Functions

virtual Retval MQUALIFIER getNodeName (IString &rName) const =0
virtual Uint MQUALIFIER getNodeType () const =0
virtual Retval MQUALIFIER getNodeValue (IString &rValue) const =0
virtual Retval MQUALIFIER getAttributeValue (const IString &rName, IString &rValue) const =0
virtual Retval MQUALIFIER getAttributeValueInt (const IString &rName, Int &rValue) const =0
virtual Retval MQUALIFIER getAttributeValueUint (const IString &rName, Uint &rValue) const =0
virtual Retval MQUALIFIER getAttributeValueBool (const IString &rName, bool &rValue) const =0
virtual Retval MQUALIFIER getAttributeValueFloat (const IString &rName, Float &rValue) const =0
virtual Retval MQUALIFIER getNodeList (IXMLNodeList *&rpList) const =0
virtual void MQUALIFIER resetNodeIterator (const IString *pName=NULL) const =0
virtual Retval MQUALIFIER getNextNode (IXMLNode *&rpNode) const =0
virtual bool MQUALIFIER hasChildren () const =0
virtual Retval MQUALIFIER appendNode (IXMLNode &rNewNode)=0
virtual Retval MQUALIFIER createNewChildNode (Uint uiType, const IString &rName, const IString *pUri, IXMLNode *&rpNode)=0
virtual Retval MQUALIFIER createElementChildNodeBySchema (const IString &rName, IXMLNode &rSchemaNode, IXMLNode *&rpNode, IXMLNode **ppRightSibling=NULL)=0
virtual Retval MQUALIFIER setNodeValue (const IString &rData)=0
virtual Retval MQUALIFIER setAttributeValue (const IString &rName, const IString &rValue)=0
virtual Retval MQUALIFIER removeMe ()=0
virtual Uint MQUALIFIER getImplClass () const =0
virtual void MQUALIFIER resetAttributeIterator () const =0
virtual Retval MQUALIFIER getNextAttribute (IString &rName, IString &rValue) const =0
virtual Retval MQUALIFIER getParentNode (IXMLNode *&rpParent) const =0
virtual Retval MQUALIFIER getNextSibling (IXMLNode *&rpParent, bool bOnlyElements=true) const =0
virtual Retval MQUALIFIER selectNodes (const IString &rQuery, IXPathResults *&rpResults) const =0
virtual Retval MQUALIFIER clone (bool bRecurs, IXMLNode *&rpNode) const =0
virtual Retval MQUALIFIER insertNode (IXMLNode &rNode, IXMLNode *pBeforeNode)=0
virtual Retval MQUALIFIER serializeNode (IString &rStream) const =0
virtual Retval MQUALIFIER getImplPtr (void **pImpl) const =0
virtual void MQUALIFIER setImplPtr (void *pImpl)=0
virtual Retval MQUALIFIER selectNode (const IString &rQuery, IXMLNode *&rpResult) const =0
virtual Retval MQUALIFIER getChildNode (const IString &rName, IXMLNode *&rpChildNode) const =0
virtual Retval MQUALIFIER removeAttribute (const IString &rName)=0
virtual Retval MQUALIFIER getText (IString &rText) const =0
virtual Retval MQUALIFIER setText (const IString &rText)=0

Detailed Description

Das Interface IXMLNode definiert die Schnittstelle zu einem Node des DOM Trees

Member Function Documentation

virtual Retval MQUALIFIER zeus::IXMLNode::getNodeName ( IString &  rName  )  const [pure virtual]

Den Namen des Nodes ermitteln

Parameters:
rName : Rckgabeparameter des Nodenamens
Return values:
RET_NOERROR : Fehlerfreie Rckgabe
RET_REQUEST_FAILED : Fehler beim Zurckgeben aufgetreten

virtual Uint MQUALIFIER zeus::IXMLNode::getNodeType (  )  const [pure virtual]

Den Typ des Nodes ermitteln. Der Typ wird Implementationsunabh�gig zurckgegeben (Define).

Return values:
TYPE_NODE_CDATA_SECTION 1
TYPE_NODE_COMMENT 2
TYPE_NODE_DOCUMENT 3
TYPE_NODE_DOCUMENT_FRAGMENT 4
TYPE_NODE_TEXT 5
TYPE_NODE_DOCUMENT_TYPE 6
TYPE_NODE_ELEMENT 7
TYPE_NODE_ENTITY 8
TYPE_NODE_ENTITY_REFERENCE 9
TYPE_NODE_NOTATION 10
TYPE_NODE_PROCESSING_INSTRUCTION 11
TYPE_NODE_ATTRIBUTE 12
TYPE_NODE_DECL 13

virtual Retval MQUALIFIER zeus::IXMLNode::getNodeValue ( IString &  rValue  )  const [pure virtual]

Den Nodewert ermitteln.

Parameters:
rValue : Rckgabeparameter des Nodewerts
Return values:
RET_NOERROR : Fehlerfreie Rckgabe
RET_REQUEST_FAILED : Fehler beim Zurckgeben aufgetreten

virtual Retval MQUALIFIER zeus::IXMLNode::getAttributeValue ( const IString &  rName,
IString &  rValue 
) const [pure virtual]

Mit dieser Methode kann einfach der Wert eines Attributs des Nodes abgefragt werden.

Parameters:
rName : Name des Attributs
rValue : Rueckgabewert des Attributs
Return values:
RET_NOERROR : Fehlerfreie Rckgabe
RET_REQUEST_FAILED : Fehler beim Zurckgeben aufgetreten

virtual Retval MQUALIFIER zeus::IXMLNode::getAttributeValueInt ( const IString &  rName,
Int &  rValue 
) const [pure virtual]

Ein Attribut als Int lesen.

Parameters:
rName [IN] : Name des Attributs.
rValue [OUT]: Gelesener Wert.
Return values:
: Fehlercode.

virtual Retval MQUALIFIER zeus::IXMLNode::getAttributeValueUint ( const IString &  rName,
Uint &  rValue 
) const [pure virtual]

Ein Attribut als Uint lesen.

Parameters:
rName [IN] : Name des Attributs.
rValue [OUT]: Gelesener Wert.
Return values:
: Fehlercode.

virtual Retval MQUALIFIER zeus::IXMLNode::getAttributeValueBool ( const IString &  rName,
bool &  rValue 
) const [pure virtual]

Ein Attribut als bool lesen.

Parameters:
rName [IN] : Name des Attributs.
rValue [OUT]: Gelesener Wert.
Return values:
: Fehlercode.

virtual Retval MQUALIFIER zeus::IXMLNode::getAttributeValueFloat ( const IString &  rName,
Float &  rValue 
) const [pure virtual]

Ein Attribut als Float lesen.

Parameters:
rName [IN] : Name des Attributs.
rValue [OUT]: Gelesener Wert.
Return values:
: Fehlercode.

virtual Retval MQUALIFIER zeus::IXMLNode::getNodeList ( IXMLNodeList *&  rpList  )  const [pure virtual]

Diese Methode gibt alle SubNodes eines Nodes in einer IXMLNodeList zurck.

Parameters:
rpList : Rckgabeparameter der Nodeliste
Return values:
RET_NOERROR : Fehlerfreie Rckgabe
RET_REQUEST_FAILED : Fehler beim Zurckgeben aufgetreten

virtual void MQUALIFIER zeus::IXMLNode::resetNodeIterator ( const IString *  pName = NULL  )  const [pure virtual]

Diese Funktion erlaubt es nach einem gestimmten NodeNamen in der NodeListe eines Nodes zu suchen.
Wird im Parameter NodeNamen ein leerer String bergeben wird einfach der erste Node der Liste zurckgegeben.

Parameters:
pName : Name des Nodes nach dem gesucht werden soll

virtual Retval MQUALIFIER zeus::IXMLNode::getNextNode ( IXMLNode *&  rpNode  )  const [pure virtual]

Diese Funktion sollte erst aufgerufen werden, wenn zuvor einmal die
Funktion getFirstNode aufgerufen wurde. Denn diese Funktion gibt den
n�hsten Node der dem Namen des Parameters NodeName entspricht.
Diese Funktion kann nun mehrmals hintereinander aufgerufen werden, bis kein entsprechender Node mehr gefunden wird.

Parameters:
rpNode : Rckgabeparameter des XMLNodes
Return values:
RET_NOERROR : Fehlerfreie Rckgabe
RET_REQUEST_FAILED : Fehler beim Zurckgeben aufgetreten

virtual bool MQUALIFIER zeus::IXMLNode::hasChildren (  )  const [pure virtual]

Mit dieser Methode kann einfach ermittelt werden, ob ein Node noch SubNodes besitzt.

Return values:
true : ja der Node besitzt noch SubNodes
false,: nein der Node besitzt keine SubNodes

virtual Retval MQUALIFIER zeus::IXMLNode::appendNode ( IXMLNode &  rNewNode  )  [pure virtual]

Mit dieser Funtkion kann ein neuer SubNode hinzugefgt werden.

Parameters:
rNewNode : Zeiger auf ein IXMLNode Interface
Return values:
RET_NOERROR : Node erfolgreich hinzugefgt
RET_REQUEST_FAILED : Node kann nicht hinzugefgt werden

virtual Retval MQUALIFIER zeus::IXMLNode::createNewChildNode ( Uint  uiType,
const IString &  rName,
const IString *  pUri,
IXMLNode *&  rpNode 
) [pure virtual]

Mit dieser Funktion wird ein neuer SubNode erzeugt. Dieser Node ist auch automatisch in der NodeList aufgenommen.

Parameters:
uiType : bestimmt die Art des Nodes
rName : Namen des neuen Nodes
pUri : namespaceURI parameter der als prefix fr den
Nodenamen dient. Wird ein leerer String bergeben,
wird der Default namespaceURI verwendet.
rpNode : Rueckgabeparameter des XMLNodes
Return values:
RET_NOERROR : Fehlerfreie Rueckgabe
RET_REQUEST_FAILED : Fehler beim Zurueckgeben aufgetreten

virtual Retval MQUALIFIER zeus::IXMLNode::createElementChildNodeBySchema ( const IString &  rName,
IXMLNode &  rSchemaNode,
IXMLNode *&  rpNode,
IXMLNode **  ppRightSibling = NULL 
) [pure virtual]

Mit dieser Funktion wird ein neuer SubNode erzeugt. Dieser Node ist auch automatisch in der NodeList aufgenommen.

Parameters:
rName : Namen des neuen Nodes
rSchemaNode,: Node, der die Schemainformationen (xsd:complexType) für den zu erstellenden Knoten beinhaltet.
rpNode : Rueckgabeparameter des XMLNodes
ppRightSibling : XML-Node rechts vom eingefügten Knoten
Return values:
RET_NOERROR : Fehlerfreie Rueckgabe
RET_INVALID_PARAMETER : rSchemaNode ist nicht ein gültiger XSD-Node
RET_INVALID_TYPE : Typdefinition wurde nicht vorhanden
RET_ABORT : Knoten kann nicht eingefügt werden, da die maximale Anzahl erreicht wurde
RET_REQUEST_FAILED : Fehler beim Zurueckgeben aufgetreten

virtual Retval MQUALIFIER zeus::IXMLNode::setNodeValue ( const IString &  rData  )  [pure virtual]

Setzen eines neuen Nodewerts

Parameters:
rData : neuer Wert des Nodes
Return values:
RET_NOERROR : Wert wurde ge�dert
RET_REQUEST_FAILED : Wert konnte nicht ge�dert werden

virtual Retval MQUALIFIER zeus::IXMLNode::setAttributeValue ( const IString &  rName,
const IString &  rValue 
) [pure virtual]

Setzen eines Attributwerts

Parameters:
rName : Name des Attributes
rValue : neuer Wert fr das Attribute
Return values:
RET_NOERROR : Wert wurde ge�dert
RET_REQUEST_FAILED : Wert kann nicht ver�dert werden

virtual Retval MQUALIFIER zeus::IXMLNode::removeMe (  )  [pure virtual]

Entfernt den Node aus der XMLNodeList des ParentNodes

Return values:
RET_NOERROR : Knoten wurde entfernt
RET_REQUEST_FAILED : Knoten konnte nicht entfernt werden

virtual Uint MQUALIFIER zeus::IXMLNode::getImplClass (  )  const [pure virtual]

Mit dieser Methode kann ermittelt werden, welche Parserimplementation fr das Interface verwendet wurde.

Return values:
IMPCLASSNAME_STDOMNODE_XERCESC 

virtual void MQUALIFIER zeus::IXMLNode::resetAttributeIterator (  )  const [pure virtual]

This methods resets the attribute iterator. The next call of getNextAttribute() will return the first attribute

virtual Retval MQUALIFIER zeus::IXMLNode::getNextAttribute ( IString &  rName,
IString &  rValue 
) const [pure virtual]

Mit dieser Methode wird das naechste Attribut zurueckgegben

Parameters:
rName : Referenz auf den Attributnamen
rValue : Referenz auf den Wert des Attributs
Return values:
RET_NOERROR : Attribut gefunden
RET_REQUEST_FAILED : kein Attribut gefunden

virtual Retval MQUALIFIER zeus::IXMLNode::getParentNode ( IXMLNode *&  rpParent  )  const [pure virtual]

Ermittelt den Parent des DOMNodes

Parameters:
rpParent : Parentknoten
Return values:
RET_NOERROR : Parent zurckgegeben
RET_REQUEST_FAILED : kein Parent gefunden

virtual Retval MQUALIFIER zeus::IXMLNode::getNextSibling ( IXMLNode *&  rpParent,
bool  bOnlyElements = true 
) const [pure virtual]

Ermittelt den rechten Sibling des DOMNodes

Parameters:
rpParent : Siblingknoten
bOnlyElements : Is this flag set, only ElementNodes are considered
Return values:
RET_NOERROR : Sibling zurckgegeben
RET_REQUEST_FAILED : kein Sibling gefunden

virtual Retval MQUALIFIER zeus::IXMLNode::selectNodes ( const IString &  rQuery,
IXPathResults *&  rpResults 
) const [pure virtual]

Suchen einer Menge von Knoten nach dem XPfad-Query

Parameters:
rQuery : XPfad des gesuchten Knoten
rpResults : Rckgabeparameter des Knotenmenge
Return values:
RET_REQUEST_FAILED : Keine Knoten gefunden
RET_NOERROR : Fehlerfreie �ergabe

virtual Retval MQUALIFIER zeus::IXMLNode::clone ( bool  bRecurs,
IXMLNode *&  rpNode 
) const [pure virtual]

Ein Knoten klonen. Es entsteht ein extaktes Abbild des Knotens

Parameters:
bRecurs : Rekursives Klonen
rpNode : Rckgabeparameter des Knotens
Return values:
RET_REQUEST_FAILED : Kann Knoten nicht klonen
RET_NOERROR : Fehlerfreie �ergabe

virtual Retval MQUALIFIER zeus::IXMLNode::insertNode ( IXMLNode &  rNode,
IXMLNode *  pBeforeNode 
) [pure virtual]

Ein Child-Knoten einfgen.

Parameters:
rNode : Knoten welcher eingefgt werden soll
pBeforeNode : Vor diesem Knoten einfgen
Return values:
RET_REQUEST_FAILED : Kann Knoten nicht eingefgt werden
RET_NOERROR : Fehlerfreies Einfgen

virtual Retval MQUALIFIER zeus::IXMLNode::serializeNode ( IString &  rStream  )  const [pure virtual]

serializes the node

Parameters:
rStream : Return parameter of the stream
Return values:
RET_REQUEST_FAILED : Could not serialize the node
RET_NOERROR : Serializing was successful

virtual Retval MQUALIFIER zeus::IXMLNode::getImplPtr ( void **  pImpl  )  const [pure virtual]

This method returns the implementation pointer of a concrete xml node. Do not use this method outside of the XML_Service module

virtual void MQUALIFIER zeus::IXMLNode::setImplPtr ( void *  pImpl  )  [pure virtual]

This method sets the implementation pointer of a concrete xml node. Do not use this method outside of the XML_Service module

virtual Retval MQUALIFIER zeus::IXMLNode::selectNode ( const IString &  rQuery,
IXMLNode *&  rpResult 
) const [pure virtual]

Suchen einer Menge von Knoten nach dem XPfad-Query

Parameters:
rQuery : XPfad des gesuchten Knoten
rpResults : Rckgabeparameter des Knotenmenge
Return values:
RET_REQUEST_FAILED : Keine Knoten gefunden
RET_NOERROR : Fehlerfreie �ergabe

virtual Retval MQUALIFIER zeus::IXMLNode::getChildNode ( const IString &  rName,
IXMLNode *&  rpChildNode 
) const [pure virtual]

Suchen des ersten Child-Knotens mit entsprechendem Namen

Parameters:
rName : Namen des gesuchten Knoten
rpChildNode : Rckgabeparameter des Child-Knotens
Return values:
RET_REQUEST_FAILED : Kein Knoten gefunden
RET_INVALID_DATA : Name ist ein Leernamen.
RET_NOERROR : Fehlerfreie Rckgabe

virtual Retval MQUALIFIER zeus::IXMLNode::removeAttribute ( const IString &  rName  )  [pure virtual]

This method removes an attribute from this node.

Parameters:
rName : Name of the attribute
Return values:
RET_NOERROR : Attribute removed
RET_REQUEST_FAILED : Could not find such an attribute

virtual Retval MQUALIFIER zeus::IXMLNode::getText ( IString &  rText  )  const [pure virtual]

returns the text child node. If the node is not an element this method will fail.

Parameters:
rText : return parameter
Return values:
RET_NOERROR : text returned
RET_REQUEST_FAILED : node is not an element

virtual Retval MQUALIFIER zeus::IXMLNode::setText ( const IString &  rText  )  [pure virtual]

sets the text child node. If the node is not an element this method will fail. If there exists a text node already, this will simply overwrite its content.

Parameters:
rText : Text to set
Return values:
RET_NOERROR : text set
RET_REQUEST_FAILED : node is not an element

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

Written by Benjamin Hadorn http://www.xatlantis.ch.
Last change made on Wed Oct 28 21:42:34 2009