ossimXmlNode Class Reference

#include <ossimXmlNode.h>

Inheritance diagram for ossimXmlNode:

Public Types
typedef std::vector< ossimRefPtr< ossimXmlNode > >	ChildListType
typedef std::vector< ossimRefPtr< ossimXmlAttribute > >	AttributeListType

Public Member Functions
	ossimXmlNode (istream &xml_stream, ossimXmlNode *parent=0)
	ossimXmlNode ()
	ossimXmlNode (const ossimXmlNode &src)
virtual ossimObject *	dup () const
void	duplicateAttributes (ossimXmlNode::AttributeListType result) const
void	duplicateChildren (ossimXmlNode::ChildListType &result) const
bool	read (std::istream &in)
void	findChildNodes (const ossimString &rel_xpath, ossimXmlNode::ChildListType &nodelist) const
const ossimRefPtr< ossimXmlNode > &	findFirstNode (const ossimString &rel_xpath) const
ossimRefPtr< ossimXmlNode >	findFirstNode (const ossimString &rel_xpath)
ossimRefPtr< ossimXmlAttribute >	findAttribute (const ossimString &name)
const ossimRefPtr< ossimXmlAttribute >	findAttribute (const ossimString &name) const
void	setTag (const ossimString &tag)
ossimString const &	getTag () const
const ossimXmlNode *	getParentNode () const
ossimXmlNode *	getParentNode ()
void	setParent (ossimXmlNode *parent)
const ossimXmlNode::ChildListType &	getChildNodes () const
ossimXmlNode::ChildListType &	getChildNodes ()
const ossimXmlNode::AttributeListType &	getAttributes () const
bool	getAttributeValue (ossimString &value, const ossimString &name) const
ossimString	getAttributeValue (const ossimString &name) const
bool	getChildTextValue (ossimString &value, const ossimString &relPath) const
ossimString	getChildTextValue (const ossimString &relPath) const
void	addAttribute (ossimRefPtr< ossimXmlAttribute > attribute)
void	addAttribute (const ossimString &name, const ossimString &value)
bool	setAttribute (const ossimString &name, const ossimString &value, bool addIfNotPresentFlag=false)
ossimRefPtr< ossimXmlNode >	addNode (const ossimString &relPath, const ossimString &text="")
ossimRefPtr< ossimXmlNode >	addOrSetNode (const ossimString &relPath, const ossimString &text="")
void	addChildNode (ossimRefPtr< ossimXmlNode > node)
ossimRefPtr< ossimXmlNode >	addChildNode (const ossimString &tagName, const ossimString &text="")
void	addChildren (ossimXmlNode::ChildListType &children)
void	setChildren (ossimXmlNode::ChildListType &children)
void	addAttributes (ossimXmlNode::AttributeListType &children)
void	setAttributes (ossimXmlNode::AttributeListType &children)
void	setText (const ossimString &text)
const ossimString &	getText () const
bool	cdataFlag () const
void	setCDataFlag (bool value)
ossimRefPtr< ossimXmlNode >	removeChild (ossimRefPtr< ossimXmlNode > node)
ossimRefPtr< ossimXmlNode >	removeChild (const ossimString &tag)
void	clear ()
void	clearChildren ()
void	clearAttributes ()
void	toKwl (ossimKeywordlist &kwl, const ossimString &prefix="") const
void	fromKwl (const ossimKeywordlist &kwlToConvert)
Public Member Functions inherited from ossimObject
	ossimObject ()
virtual	~ossimObject ()
virtual ossimString	getShortName () const
virtual ossimString	getLongName () const
virtual ossimString	getDescription () const
virtual ossimString	getClassName () const
virtual RTTItypeid	getType () const
virtual bool	canCastTo (ossimObject *obj) const
virtual bool	canCastTo (const RTTItypeid &id) const
virtual bool	canCastTo (const ossimString &parentClassName) const
virtual bool	saveState (ossimKeywordlist &kwl, const char *prefix=0) const
virtual bool	loadState (const ossimKeywordlist &kwl, const char *prefix=0)
virtual std::ostream &	print (std::ostream &out) const
	Generic print method. More...
virtual bool	isEqualTo (const ossimObject &obj, ossimCompareType compareType=OSSIM_COMPARE_FULL) const
virtual void	accept (ossimVisitor &visitor)
Public Member Functions inherited from ossimReferenced
	ossimReferenced ()
	ossimReferenced (const ossimReferenced &)
ossimReferenced &	operator= (const ossimReferenced &)
void	ref () const
	increment the reference count by one, indicating that this object has another pointer which is referencing it. More...
void	unref () const
	decrement the reference count by one, indicating that a pointer to this object is referencing it. More...
void	unref_nodelete () const
	decrement the reference count by one, indicating that a pointer to this object is referencing it. More...
int	referenceCount () const
Public Member Functions inherited from ossimErrorStatusInterface
	ossimErrorStatusInterface ()
virtual	~ossimErrorStatusInterface ()
virtual ossimErrorCode	getErrorStatus () const
virtual ossimString	getErrorStatusString () const
virtual void	setErrorStatus (ossimErrorCode error_status) const
virtual void	setErrorStatus () const
virtual void	clearErrorStatus () const
bool	hasError () const
virtual std::ostream &	print (std::ostream &out) const
	Outputs theErrorStatus as an ossimErrorCode and an ossimString. More...

Protected Member Functions
	~ossimXmlNode ()
bool	readTag (std::istream &in, ossimString &tag)
bool	readTextContent (std::istream &in)
bool	readEndTag (std::istream &in, ossimString &endTag)
void	skipCommentTag (std::istream &in)
bool	readCDataContent (std::istream &in)
Protected Member Functions inherited from ossimReferenced
virtual	~ossimReferenced ()

Protected Attributes
ossimString	theTag
ossimXmlNode *	theParentNode
vector< ossimRefPtr< ossimXmlNode > >	theChildNodes
vector< ossimRefPtr< ossimXmlAttribute > >	theAttributes
ossimString	theText
bool	theCDataFlag
Protected Attributes inherited from ossimErrorStatusInterface
ossimErrorCode	theErrorStatus

Friends
OSSIMDLLEXPORT friend ostream &	operator<< (ostream &os, const ossimXmlNode *xml_node)
OSSIMDLLEXPORT friend ostream &	operator<< (ostream &os, const ossimXmlNode &xml_node)

Detailed Description

Definition at line 26 of file ossimXmlNode.h.

Member Typedef Documentation

AttributeListType

typedef std::vector<ossimRefPtr<ossimXmlAttribute> > ossimXmlNode::AttributeListType

Definition at line 31 of file ossimXmlNode.h.

ChildListType

typedef std::vector<ossimRefPtr<ossimXmlNode> > ossimXmlNode::ChildListType

Definition at line 30 of file ossimXmlNode.h.

Constructor & Destructor Documentation

ossimXmlNode() [1/3]

ossimXmlNode::ossimXmlNode	(	istream &	xml_stream,
		ossimXmlNode *	parent = 0
	)

Definition at line 46 of file ossimXmlNode.cpp.

References read().

:
theParentNode (parent),
theCDataFlag(false)
{
   read(xml_stream);
}

ossimXmlNode() [2/3]

ossimXmlNode::ossimXmlNode

(

)

Definition at line 54 of file ossimXmlNode.cpp.

Referenced by addChildNode().

:theParentNode(0),
theCDataFlag(false)
{
}

ossimXmlNode() [3/3]

ossimXmlNode::ossimXmlNode

(

const ossimXmlNode &

src

)

Definition at line 60 of file ossimXmlNode.cpp.

References theAttributes, and theChildNodes.

:theTag(src.theTag),
theParentNode(0),
theText(src.theText),
theCDataFlag(src.theCDataFlag)
{
   ossim_uint32 idx = 0;
   for(idx = 0; idx < src.theChildNodes.size();++idx)
   {
      theChildNodes.push_back((ossimXmlNode*)(src.theChildNodes[idx]->dup()));
   }
   for(idx = 0; idx < src.theAttributes.size();++idx)
   {
      theAttributes.push_back((ossimXmlAttribute*)(src.theAttributes[idx]->dup()));
   }
}

~ossimXmlNode()

ossimXmlNode::~ossimXmlNode ( )

protected

Definition at line 77 of file ossimXmlNode.cpp.

{
}

Member Function Documentation

addAttribute() [1/2]

void ossimXmlNode::addAttribute

(

ossimRefPtr< ossimXmlAttribute >

attribute

)

Definition at line 755 of file ossimXmlNode.cpp.

References ossimRefPtr< T >::get(), and theAttributes.

Referenced by addAttributes(), ossimGmlSupportData::configureBounds(), ossimGmlSupportData::configureGmljp2V2(), ossimTieGptSet::exportAsGmlNode(), ossimXmlDocument::fromKwl(), ossimGmlSupportData::getGmljp2V1RootNode(), ossimGmlSupportData::getGmljp2V2RootNode(), ossimMultiBandHistogram::saveState(), ossimLocalTm::saveXml(), and setAttribute().

{
   theAttributes.push_back(attribute.get());
}

addAttribute() [2/2]

void ossimXmlNode::addAttribute	(	const ossimString &	name,
		const ossimString &	value
	)

Definition at line 760 of file ossimXmlNode.cpp.

References theAttributes.

{
   theAttributes.push_back(new ossimXmlAttribute(name, value));
}

addAttributes()

void ossimXmlNode::addAttributes

(

ossimXmlNode::AttributeListType &

children

)

Definition at line 923 of file ossimXmlNode.cpp.

References addAttribute().

Referenced by setAttributes().

{
   ossim_uint32 idx;
   
   for(idx = 0; idx < children.size(); ++idx)
   {
      addAttribute(children[idx].get());
   }
}

addChildNode() [1/2]

void ossimXmlNode::addChildNode

(

ossimRefPtr< ossimXmlNode >

node

)

Definition at line 848 of file ossimXmlNode.cpp.

References ossimRefPtr< T >::get(), removeChild(), theChildNodes, and theParentNode.

Referenced by addChildren(), ossimGmlSupportData::configureBounds(), ossimGmlSupportData::configureGmljp2V2(), ossimTieGptSet::exportAsGmlNode(), ossimTieGpt::exportAsGmlNode(), ossimKakaduJpipInfo::print(), ossimMultiBandHistogram::saveState(), ossimHistogram::saveState(), ossimLocalTm::saveXml(), and ossimContainerProperty::toXml().

{
   if(node->theParentNode)
   {
      node->theParentNode->removeChild(node);
   }
   node->theParentNode = this;
   theChildNodes.push_back(node.get());
}

addChildNode() [2/2]

ossimRefPtr< ossimXmlNode > ossimXmlNode::addChildNode	(	const ossimString &	tagName,
		const ossimString &	text = ""
	)

Definition at line 858 of file ossimXmlNode.cpp.

References ossimXmlNode(), setParent(), theChildNodes, theTag, and theText.

{
   ossimRefPtr<ossimXmlNode> node = new ossimXmlNode();
   node->setParent(this);
   node->theTag = tagName;
   node->theText = text;
   theChildNodes.push_back(node);
   
   return node;
}

addChildren()

void ossimXmlNode::addChildren

(

ossimXmlNode::ChildListType &

children

)

Definition at line 908 of file ossimXmlNode.cpp.

References addChildNode().

Referenced by setChildren().

{
   ossim_uint32 idx;
   for(idx = 0; idx < children.size(); ++idx)
   {
      addChildNode(children[idx].get());
   }
}

addNode()

ossimRefPtr< ossimXmlNode > ossimXmlNode::addNode	(	const ossimString &	relPath,
		const ossimString &	text = ""
	)

Definition at line 789 of file ossimXmlNode.cpp.

References ossimString::empty().

Referenced by addOrSetNode(), ossimTieGpt::exportAsGmlNode(), ossimXmlDocument::fromKwl(), and ossimKeywordlist::toXML().

{
   if (relPath.empty())
      return 0;
   
   //
   // First verify that this is not an absolute path:
   //
   if (relPath[static_cast<std::string::size_type>(0)] == XPATH_DELIM)
   {
      if(traceDebug())
      {
         ossimNotify(ossimNotifyLevel_WARN) << "WARNING: ossimXmlNode::addNode\n"
         << "Only relative XPaths can be searched from a node. "
         << "Returning null list...\n";
      }
      return 0;
   }
   
   //
   // Read the desired tag from the relative xpath
   //
   const std::string::size_type delim_pos = relPath.find(XPATH_DELIM);
   const ossimString desiredTag = relPath.substr(0,delim_pos);
   
   ossimRefPtr<ossimXmlNode> node = findFirstNode(desiredTag);
   
   if(!node.valid())
   {
      // No XPATH_DELIM character found, or XPATH_DELIM at the end of xpath
      if (delim_pos==std::string::npos || delim_pos == relPath.size()-1) 
      {
         node = addChildNode(desiredTag, text);
      }
      else
      {
         node = addChildNode(desiredTag, "");
      }
   }
   if (delim_pos != std::string::npos && delim_pos != relPath.size()-1) // XPATH_DELIM character found!
   {
      const ossimString subPath   = relPath.substr(delim_pos+1, std::string::npos);
      return node->addNode(subPath, text);
   }
   
   return node;
}

addOrSetNode()

ossimRefPtr< ossimXmlNode > ossimXmlNode::addOrSetNode	(	const ossimString &	relPath,
		const ossimString &	text = ""
	)

Definition at line 838 of file ossimXmlNode.cpp.

References addNode(), and setText().

{
   ossimRefPtr<ossimXmlNode> result = addNode(relPath, text);
   
   result->setText(text);
   
   return result;
}

cdataFlag()

bool ossimXmlNode::cdataFlag

(

)

const

Definition at line 662 of file ossimXmlNode.cpp.

References theCDataFlag.

Referenced by operator<<().

{
   return theCDataFlag;
}

clear()

void ossimXmlNode::clear

(

)

Definition at line 939 of file ossimXmlNode.cpp.

References theAttributes, theCDataFlag, theChildNodes, theTag, and theText.

{
   theChildNodes.clear();
   theAttributes.clear();
   theTag="";
   theText="";
   theCDataFlag=false;
}

clearAttributes()

void ossimXmlNode::clearAttributes

(

)

Definition at line 953 of file ossimXmlNode.cpp.

References theAttributes.

Referenced by setAttributes().

{
   theAttributes.clear();
}

clearChildren()

void ossimXmlNode::clearChildren

(

)

Definition at line 948 of file ossimXmlNode.cpp.

References theChildNodes.

Referenced by setChildren().

{
   theChildNodes.clear();
}

dup()

virtual ossimObject* ossimXmlNode::dup ( ) const

inlinevirtual

Reimplemented from ossimObject.

Definition at line 36 of file ossimXmlNode.h.

Referenced by duplicateAttributes(), and duplicateChildren().

   {
      return new ossimXmlNode(*this);
   }

duplicateAttributes()

void ossimXmlNode::duplicateAttributes

(

ossimXmlNode::AttributeListType

result

)

const

Definition at line 81 of file ossimXmlNode.cpp.

References dup(), and theAttributes.

{
   ossim_uint32 idx = 0;
   for(idx = 0; idx<theAttributes.size();++idx)
   {
      result.push_back((ossimXmlAttribute*)theAttributes[idx]->dup());
   }
    
}

duplicateChildren()

void ossimXmlNode::duplicateChildren

(

ossimXmlNode::ChildListType &

result

)

const

Definition at line 91 of file ossimXmlNode.cpp.

References dup(), and theChildNodes.

{
   ossim_uint32 idx = 0;
   for(idx = 0; idx<theChildNodes.size();++idx)
   {
      result.push_back((ossimXmlNode*)theChildNodes[idx]->dup());
   }
}

findAttribute() [1/2]

ossimRefPtr< ossimXmlAttribute > ossimXmlNode::findAttribute

(

const ossimString &

name

)

Definition at line 572 of file ossimXmlNode.cpp.

References theAttributes.

Referenced by getAttributeValue(), and setAttribute().

{
   ossim_uint32 idx = 0;
   
   for(idx = 0; idx < theAttributes.size();++idx)
   {
      if(theAttributes[idx]->getName() == name)
      {
         return theAttributes[idx];
      }
   }
   
   return 0;
}

findAttribute() [2/2]

const ossimRefPtr< ossimXmlAttribute > ossimXmlNode::findAttribute

(

const ossimString &

name

)

const

Definition at line 587 of file ossimXmlNode.cpp.

References theAttributes.

{
   ossim_uint32 idx = 0;
   
   for(idx = 0; idx < theAttributes.size();++idx)
   {
      if(theAttributes[idx]->getName() == name)
      {
         return theAttributes[idx];
      }
   }
   
   return 0;
}

findChildNodes()

void ossimXmlNode::findChildNodes	(	const ossimString &	rel_xpath,
		ossimXmlNode::ChildListType &	nodelist
	)		const

Definition at line 367 of file ossimXmlNode.cpp.

References ossimString::empty(), and theChildNodes.

Referenced by ossimGdalWriter::getGdalOptions(), ossimGdalWriter::getGdalPropertyNames(), ossimplugins::ossimTerraSarModel::getNoiseAtGivenNode(), ossimTieGptSet::importFromGmlNode(), and ossimplugins::ossimTerraSarProductDoc::initNoise().

{
   //***
   // Scan for trivial result (no children owned):
   //***
   if (theChildNodes.empty())
      return;
   
   if (xpath.empty())
      return;
   
   //---
   // First verify that this is not an absolute path:
   //---
   if (xpath[static_cast<std::string::size_type>(0)] == XPATH_DELIM)
   {
      if(traceDebug())
      {
         ossimNotify(ossimNotifyLevel_WARN)
            << "WARNING: ossimXmlNode::findChildNodes\n"
            << "Only relative XPaths can be searched from a node. "
            << "Returning null list...\n";
         }
      return;
   }
   
   //***
   // Read the desired tag from the relative xpath
   //***
   const std::string::size_type delim_pos = xpath.find(XPATH_DELIM);
   // TODO: need string_view
   const ossimString desired_tag = xpath.substr(0,delim_pos);
   
   //***
   // Loop over all child nodes for match:
   //***
   ossimXmlNode::ChildListType::const_iterator child_iter = theChildNodes.begin();
   ossimXmlNode::ChildListType::const_iterator child_end  = theChildNodes.end();


   // No XPATH_DELIM character found, or XPATH_DELIM at the end of xpath
   if (delim_pos==std::string::npos || delim_pos == xpath.size()-1) 
   {
      for ( ; child_iter != child_end ; ++ child_iter)
      {
         if ((*child_iter)->getTag() == desired_tag)
            //***
            // This was the final target node, simply append to the result:
            //***
            result.push_back(*child_iter);
      }
   }
   else
   {
      const ossimString sub_xpath   = xpath.substr(delim_pos+1, std::string::npos);
      for ( ; child_iter != child_end ; ++ child_iter)
      {
         if ((*child_iter)->getTag() == desired_tag)
            //***
            // This match identifies a possible tree to search given the
            // remaining xpath (sub_xpath). Query this child node to search
            // its tree for the remaining xpath:
            //***
            (*child_iter)->findChildNodes(sub_xpath, result);
      }
   }
}

findFirstNode() [1/2]

const ossimRefPtr< ossimXmlNode > & ossimXmlNode::findFirstNode

(

const ossimString &

rel_xpath

)

const

Definition at line 436 of file ossimXmlNode.cpp.

References ossimString::empty(), and theChildNodes.

Referenced by ossimplugins::ossim::findFirstNode(), getChildTextValue(), ossimTieGptSet::importFromGmlNode(), ossimTieGpt::importFromGmlNode(), ossimplugins::ossimRadarSat2Model::initSRGR(), ossimHistogram::loadState(), ossimLocalTm::loadXml(), ossimWmsGetMap::read(), ossimWmsGetCapabilities::read(), and ossimPpjFrameSensorFile::readStream().

{
   if(theChildNodes.size() < 1) return nullNode;
   if (xpath.empty())
      return nullNode;

   //
   // First verify that this is not an absolute path:
   //
   if (xpath[static_cast<std::string::size_type>(0)] == XPATH_DELIM)
   {
      if(traceDebug())
      {
         ossimNotify(ossimNotifyLevel_WARN)
            << "WARNING: ossimXmlNode::findFirstNode\n"
            << "Only relative XPaths can be searched from a node. "
            << "Returning null list...\n";
      }
      return nullNode;
   }

   //
   // Read the desired tag from the relative xpath
   //
   const std::string::size_type delim_pos = xpath.find(XPATH_DELIM);
   // TODO: need string_view
   const ossimString desired_tag = xpath.substr(0,delim_pos);

   //
   // Loop over all child nodes for match:
   //
   ossimXmlNode::ChildListType::const_iterator child_iter = theChildNodes.begin();
   ossimXmlNode::ChildListType::const_iterator child_end  = theChildNodes.end();

   // No XPATH_DELIM character found, or XPATH_DELIM at the end of xpath
   if (delim_pos==std::string::npos || delim_pos == xpath.size()-1) 
   {
      for ( ; child_iter != child_end ; ++ child_iter)
      {
         if ((*child_iter)->getTag() == desired_tag)
            return *child_iter;
      }
   }
   else
   {
      const ossimString sub_xpath   = xpath.substr(delim_pos+1, std::string::npos);
      for ( ; child_iter != child_end ; ++ child_iter)
      {
         if ((*child_iter)->getTag() == desired_tag)
         {
            //
            // This match identifies a possible tree to search given the
            // remaining xpath (sub_xpath). Query this child node to search
            // its tree for the remaining xpath:
            //
            const ossimRefPtr<ossimXmlNode>& result = (*child_iter)->findFirstNode(sub_xpath);
            if (result.get())
            {
               return result;
            }
         }
      }
   }

   return nullNode;
}

findFirstNode() [2/2]

ossimRefPtr< ossimXmlNode > ossimXmlNode::findFirstNode

(

const ossimString &

rel_xpath

)

Definition at line 503 of file ossimXmlNode.cpp.

References ossimString::empty(), and theChildNodes.

{
   if(theChildNodes.size() < 1) return 0;
   if (xpath.empty())
      return 0;

   //
   // First verify that this is not an absolute path:
   //
   if (xpath[static_cast<std::string::size_type>(0)] == XPATH_DELIM)
   {
      if(traceDebug())
      {
         ossimNotify(ossimNotifyLevel_WARN)
            << "WARNING: ossimXmlNode::findFirstNode\n"
            << "Only relative XPaths can be searched from a node. "
            << "Returning null list...\n";
      }
      return 0;
   }

   //
   // Read the desired tag from the relative xpath
   //
   const std::string::size_type delim_pos = xpath.find(XPATH_DELIM);
   // TODO: need string_view
   const ossimString desired_tag = xpath.substr(0,delim_pos);

   ossimRefPtr<ossimXmlNode> result = 0;

   //
   // Loop over all child nodes for match:
   //
   ossimXmlNode::ChildListType::iterator child_iter = theChildNodes.begin();
   ossimXmlNode::ChildListType::iterator child_end  = theChildNodes.end();

   // No XPATH_DELIM character found, or XPATH_DELIM at the end of xpath
   if (delim_pos==std::string::npos || delim_pos == xpath.size()-1) 
   {
      for ( ; child_iter != child_end ; ++ child_iter)
      {
         if ((*child_iter)->getTag() == desired_tag)
            return *child_iter;
      }
   }
   else
   {
      const ossimString sub_xpath   = xpath.substr(delim_pos+1, std::string::npos);
      for ( ; child_iter != child_end ; ++ child_iter)
      {
         if ((*child_iter)->getTag() == desired_tag)
         {
            //
            // This match identifies a possible tree to search given the
            // remaining xpath (sub_xpath). Query this child node to search
            // its tree for the remaining xpath:
            //
            ossimRefPtr<ossimXmlNode> result = (*child_iter)->findFirstNode(sub_xpath);
            if (result.get())
            {
               return result;
            }
         }
      }
   }

   return 0;
}

fromKwl()

void ossimXmlNode::fromKwl

(

const ossimKeywordlist &

kwlToConvert

)

getAttributes()

const ossimXmlNode::AttributeListType & ossimXmlNode::getAttributes

(

)

const

Definition at line 627 of file ossimXmlNode.cpp.

References theAttributes.

{
   return theAttributes;
}

getAttributeValue() [1/2]

bool ossimXmlNode::getAttributeValue	(	ossimString &	value,
		const ossimString &	name
	)		const

Definition at line 632 of file ossimXmlNode.cpp.

References findAttribute(), ossimXmlAttribute::getValue(), and ossimRefPtr< T >::valid().

Referenced by ossimplugins::ossimTerraSarProductDoc::initPlatformPosition(), ossimWmsGetMap::read(), ossimWmsGetCapabilities::read(), ossimWmsTimeExtent::read(), ossimWmsScaleHint::read(), ossimWmsBoundingBox::read(), and ossimWmsCapabilitiesDocument::read().

{
   ossimRefPtr<ossimXmlAttribute> attribute = findAttribute(name);
   
   if(attribute.valid())
   {
      value = attribute->getValue();
   }
   
   return attribute.valid();
}

getAttributeValue() [2/2]

ossimString ossimXmlNode::getAttributeValue ( const ossimString &  name ) const

inline

Definition at line 61 of file ossimXmlNode.h.

   {
      ossimString value;
      getAttributeValue(value, name);
      return value;
   }

getChildNodes() [1/2]

const ossimXmlNode::ChildListType & ossimXmlNode::getChildNodes

(

)

const

Definition at line 617 of file ossimXmlNode.cpp.

References theChildNodes.

Referenced by ossimXmlDocument::fromKwl(), ossimKmlSuperOverlayReader::getCoordinate(), ossimMultiBandHistogram::loadState(), ossimKmlSuperOverlayReader::open(), ossimTiffInfo::printGdalMetadata(), ossimWmsGetMap::read(), ossimWmsRequest::read(), ossimWmsStyle::read(), ossimWmsLayer::read(), ossimWmsCapability::read(), ossimWmsCapabilitiesDocument::read(), ossimPpjFrameSensorFile::readStream(), and ossimKeywordlist::toXML().

{
   return theChildNodes;
}

getChildNodes() [2/2]

ossimXmlNode::ChildListType & ossimXmlNode::getChildNodes

(

)

Definition at line 622 of file ossimXmlNode.cpp.

References theChildNodes.

{
   return theChildNodes;
}

getChildTextValue() [1/2]

bool ossimXmlNode::getChildTextValue	(	ossimString &	value,
		const ossimString &	relPath
	)		const

Definition at line 644 of file ossimXmlNode.cpp.

References findFirstNode(), getText(), and ossimRefPtr< T >::valid().

{
   ossimRefPtr<ossimXmlNode> node = findFirstNode(relPath);
   if(node.valid())
   {
      value = node->getText();
   }
   
   return node.valid();
}

getChildTextValue() [2/2]

ossimString ossimXmlNode::getChildTextValue ( const ossimString &  relPath ) const

inline

Definition at line 69 of file ossimXmlNode.h.

   {
      ossimString value;
      getChildTextValue(value, relPath);
      return value;
   }

getParentNode() [1/2]

const ossimXmlNode * ossimXmlNode::getParentNode

(

)

const

Definition at line 607 of file ossimXmlNode.cpp.

References theParentNode.

Referenced by ossimXmlDocument::fromKwl().

{
   return theParentNode;
}

getParentNode() [2/2]

ossimXmlNode * ossimXmlNode::getParentNode

(

)

Definition at line 612 of file ossimXmlNode.cpp.

References theParentNode.

{
   return theParentNode;
}

getTag()

ossimString const& ossimXmlNode::getTag ( ) const

inline

Definition at line 53 of file ossimXmlNode.h.

Referenced by ossimXmlDocument::fromKwl(), ossimWmsBoundingBox::read(), ossimPpjFrameSensorFile::readStream(), and toKwl().

{ return theTag; }

getText()

const ossimString& ossimXmlNode::getText ( ) const

inline

Definition at line 92 of file ossimXmlNode.h.

Referenced by ossimXmlDocument::fromKwl(), getChildTextValue(), ossimTieGptSet::importFromGmlNode(), ossimTieGpt::importFromGmlNode(), ossimplugins::ossimRadarSat2Model::initSRGR(), ossimHistogram::loadState(), ossimLocalTm::loadXml(), ossimWmsTimeExtent::read(), ossimPpjFrameSensorFile::readStream(), and toKwl().

{ return theText; }

read()

bool ossimXmlNode::read

(

std::istream &

in

)

Definition at line 126 of file ossimXmlNode.cpp.

Referenced by ossimXmlNode(), ossimKakaduJpipInfo::print(), and ossimTiffInfo::printGdalMetadata().

{
   if(traceDebug())
   {
      ossimNotify(ossimNotifyLevel_DEBUG)
         << "ossimXmlNode::read: entered ......\n";
   }
   char c;
   xmlskipws(in);
   if(in.fail())
   {
      if(traceDebug())
      {
         ossimNotify(ossimNotifyLevel_DEBUG)
            << "ossimXmlNode::read: leaving ......\n"<<__LINE__ << "\n";
      }
      return false;
   }
   if(in.peek() == '<')
   {
      in.ignore(1);
   }
   if(in.fail())
   {
      if(traceDebug())
      {
         ossimNotify(ossimNotifyLevel_DEBUG)
            << "ossimXmlNode::read: leaving ......\n"<<__LINE__ << "\n";
      }
      return false;
   }

   ossimString endTag;
   
   if(!readTag(in, theTag))
   {
      if(traceDebug())
      {
         ossimNotify(ossimNotifyLevel_DEBUG)
            << "ossimXmlNode::read: leaving ......\n"<<__LINE__ << "\n";
      }
      return false;
   }
   if(traceDebug())
   {
      ossimNotify(ossimNotifyLevel_DEBUG) << "theTag = " << theTag << "\n";
   }
   
   if((!in.fail())&&readEndTag(in, endTag))
   {
      if((endTag == "")||
         (endTag == theTag))
      {
         if(traceDebug())
         {
            ossimNotify(ossimNotifyLevel_DEBUG)
               << "ossimXmlNode::read: leaving ......\n"<<__LINE__ << "\n";
         }
         return true;
      }
      else
      {
         setErrorStatus();
         if(traceDebug())
         {
            ossimNotify(ossimNotifyLevel_DEBUG)
               << "ossimXmlNode::read: leaving ......\n"<<__LINE__ << "\n";
         }
         return false;
      }
   }
   // now parse attributes
   ossimRefPtr<ossimXmlAttribute> attribute = new ossimXmlAttribute;
   while(attribute->read(in))
   {
      theAttributes.push_back(new ossimXmlAttribute(*attribute));
   }
   // skip white space characters
   //
   xmlskipws(in);
   
   if(!in.fail()&&readEndTag(in, endTag))
   {
      if((endTag == "")||
         (endTag == theTag))
      {
         if(traceDebug())
         {
            ossimNotify(ossimNotifyLevel_DEBUG)
               << "ossimXmlNode::read: leaving ......\n"<<__LINE__ << "\n";
         }
         return true;
      }
      else
      {
         setErrorStatus();
         if(traceDebug())
         {
            ossimNotify(ossimNotifyLevel_DEBUG)
               << "ossimXmlNode::read: leaving ......\n"<<__LINE__ << "\n";
         }
         return false;
      }
   }
   c = in.peek();
   // make sure the attribute is closed
   //
   if(c != '>')
   {
      setErrorStatus();
      if(traceDebug())
      {
         ossimNotify(ossimNotifyLevel_DEBUG)
            << "ossimXmlNode::read: leaving ......\n"<<__LINE__ << "\n";
      }
      return false;
   }
   
   in.ignore(1);
   c = in.peek();
   
   // now do the text portion
   if(!readTextContent(in))
   {
      if(traceDebug())
      {
         ossimNotify(ossimNotifyLevel_DEBUG)
            << "ossimXmlNode::read: leaving ......\n"<<__LINE__ << "\n";
      }
      return false;
   }
   xmlskipws(in);
   c = in.peek();
   
   if(c != '<')
   {
      setErrorStatus();
      if(traceDebug())
      {
         ossimNotify(ossimNotifyLevel_DEBUG)
            << "ossimXmlNode::read: leaving ......\n"<<__LINE__ << "\n";
      }
      return false;
   }
   in.ignore(1);
   if(readEndTag(in, endTag))
   {
      if((endTag == "")||
         (endTag == theTag))
      {
         if(traceDebug())
         {
            ossimNotify(ossimNotifyLevel_DEBUG)
               << "ossimXmlNode::read: leaving ......\n"<<__LINE__ << "\n";
         }
         return true;
      }
      else
      {
         setErrorStatus();
         if(traceDebug())
         {
            ossimNotify(ossimNotifyLevel_DEBUG)
               << "ossimXmlNode::read: leaving ......\n"<<__LINE__ << "\n";
         }
         return false;
      }
   }
   c = in.peek();

   //---
   // now if it's not an endtag then it must be a tag starting the new child
   // node
   //---
   ossimRefPtr<ossimXmlNode> childNode;
   do
   {
      childNode = new ossimXmlNode;
      childNode->setParent(this);
      if(childNode->read(in))
      {
         theChildNodes.push_back(childNode);
      }
      else
      {
         setErrorStatus();
         if(traceDebug())
         {
            ossimNotify(ossimNotifyLevel_DEBUG)
               << "ossimXmlNode::read: leaving ......\n"<<__LINE__ << "\n";
         }
         return false;
      }
      xmlskipws(in);
      
      c = in.peek();
      if(c != '<')
      {
         setErrorStatus();
         if(traceDebug())
         {
            ossimNotify(ossimNotifyLevel_DEBUG)
               << "ossimXmlNode::read: leaving ......\n"<<__LINE__ << "\n";
         }
         return false;
      }
      in.ignore(1);
      if(readEndTag(in, endTag))
      {
         if((endTag == "")||
            (endTag == theTag))
         {
            if(traceDebug())
            {
               ossimNotify(ossimNotifyLevel_DEBUG)
                  << "ossimXmlNode::read: leaving ......\n"<<__LINE__ << "\n";
            }
            return true;
         }
         else
         {
            setErrorStatus();
            if(traceDebug())
            {
               ossimNotify(ossimNotifyLevel_DEBUG)
                  << "ossimXmlNode::read: leaving ......\n"<<__LINE__ << "\n";
            }
            return false;
         }
      }
   }while( !in.fail() );
   
   if(traceDebug())
   {
      ossimNotify(ossimNotifyLevel_DEBUG)
         << "ossimXmlNode::read: leaving ......\n";
   }
   return true;
}

readCDataContent()

bool ossimXmlNode::readCDataContent ( std::istream &  in )

protected

Definition at line 1039 of file ossimXmlNode.cpp.

{
   if(traceDebug())
   {
      ossimNotify(ossimNotifyLevel_DEBUG)
         << "ossimXmlNode::readCDataContent: entered ...\n";
   }   
   
   // Ignore up to "]]>"
   
   bool result = false;

   char c;

   while(!in.fail())
   {
      c = in.get();
      if ( c != ']' )
      {
         theText += c;
      }
      else // at "]"
      {
         c = in.get();
         if( c == ']' ) // at "]]"
         {
            c = in.get();
            if( c == '>' )
            {
               //in >> xmlskipws;
               result = true;
               break;
            }
         }
      }
   }

   if(traceDebug())
   {
      ossimNotify(ossimNotifyLevel_DEBUG)
         << "theText: " << theText
         << "\nexit status: " << (result?"true":"false")
         << "\nossimXmlNode::readCDataContent: leaving ...\n";
   }
   
   return result;
}

readEndTag()

bool ossimXmlNode::readEndTag ( std::istream &  in, ossimString &  endTag  )

protected

Definition at line 1362 of file ossimXmlNode.cpp.

References readTag(), skipCommentTag(), and theTag.

{
   bool result = false;
   char c = in.peek();
   endTag = "";
   
   if(theTag == "--")// this is a comment tag
   {
      skipCommentTag(in);
      endTag = "--";
      return (!in.fail());
   }
   // check end tag
   //
   if(c == '/')
   {
      in.ignore();
      readTag(in, endTag);
      if(in.fail()) return false;
      xmlskipws(in);
      c = in.peek();
      result = true;
   }
   else
   {
      return false;
   }
   if(c != '>')
   {
      setErrorStatus();
      return false;
   }
   else
   {
      in.ignore(1);
   }
   if(in.fail()) result = false;
   
   return result;
}

readTag()

bool ossimXmlNode::readTag ( std::istream &  in, ossimString &  tag  )

protected

Definition at line 994 of file ossimXmlNode.cpp.

Referenced by readEndTag().

{
   if(traceDebug())
   {
      ossimNotify(ossimNotifyLevel_DEBUG)
         << "ossimXmlNode::readTag: entered ......\n";
   }
   xmlskipws(in);
   
   tag.clear();
   int c = in.peek();
   
   // bool validTag = false;
   //    while(!validTag)
   {
      while( (c != ' ')&&
            (c != '\n')&&
            (c != '\t')&&
            (c != '\r')&&
            (c != '<')&&
            (c != '>')&&
            (c != '/')&&
            (!in.fail()))
      {
         tag += (char)c;
         in.ignore(1);
         c = in.peek();
         if(tag == "!--") // ignore comment tags
         {
            tag = "--";
            break;
         }
      }
   }
   
   if(traceDebug())
   {
      ossimNotify(ossimNotifyLevel_DEBUG)
         << "ossimXmlNode::readTag: leaving ......\n";
   }
  
   return (!tag.empty())&&(!in.fail());
}

readTextContent()

bool ossimXmlNode::readTextContent ( std::istream &  in )

protected

Definition at line 1239 of file ossimXmlNode.cpp.

{
   if(traceDebug())
   {
      ossimNotify(ossimNotifyLevel_DEBUG)
         << "ossimXmlNode::readTextContent: entered ...\n";
   }
   
   //---
   // Parse the text string.  Do it with no peeks, ignores, or putbacks as
   // those seem to have issues on Windows (vs9).
   //---
   bool result = false;

   theText = "";
   theCDataFlag = false;
   
   xmlskipws(in);

   if ( !in.fail() )
   {
      std::streampos initialPos = in.tellg();

      char c = in.get();
      
      if ( c != '<' )
      {
         do // Get the text up to the next '<'.
         {
            theText += c;
            c = in.get();
         } while ( (c != '<') && !in.fail() );
         
         in.unget(); // Put '<' back.
         result = !in.fail();
      }
      else // At "<" see if comment
      {
         c = in.get();

         if ( c != '!' )
         {
            in.seekg(initialPos);
            result = !in.fail();
         }
         else // at "<!"
         {
            c = in.get();
            if ( c == '-' )
            {
               // Comment section: <!-- some comment -->
               c = in.get();
               if ( c == '-' ) // at "<!--"
               {
                  // Strip comment
                  while( !in.fail() ) // continue until we see a --> pattern
                  {
                     c = in.get();
                     if(c == '-')
                     {
                        c = in.get();
                        if(c == '-')
                        {
                           c = in.get();
                           if(c == '>')
                           {
                              result = !in.fail();
                              break;
                           }
                        }
                     }
                  }
               }
            }
            else if ( c == '[' ) // at "<!["
            {
               // CDATA section: <![CDATA[something-here]]>
               c = in.get();
               if ( c == 'C') // at "<![C:"
               {
                  c = in.get();
                  if ( c == 'D' )// at "<![CD"
                  {
                     c = in.get();
                     if ( c == 'A' ) // at "<![CDA"
                     {
                        c = in.get();
                        if ( c == 'T' ) // at "<![CDAT"
                        {
                           c = in.get();
                           if ( c == 'A' ) // at "<![CDATA"
                           {
                              c = in.get();
                              if ( c == '[' ) // at "<!CDATA["
                              {
                                 if (readCDataContent(in))
                                 {
                                    theCDataFlag = true;
                                    result = true;
                                 }
                              }
                           }
                        }
                     }
                  }
               }
            }
         }
      }
   }

   if(traceDebug())
   {
      ossimNotify(ossimNotifyLevel_DEBUG)
         << "theText: " << theText
         << "\ntheCDataFlag: " << (theCDataFlag?"true":"false")
         << "\nexit status: " << (result?"true":"false")
         << "\nossimXmlNode::readTextContent: leaving ...\n";
   }
   
   return result;
}

removeChild() [1/2]

ossimRefPtr< ossimXmlNode > ossimXmlNode::removeChild

(

ossimRefPtr< ossimXmlNode >

node

)

Definition at line 870 of file ossimXmlNode.cpp.

References theChildNodes.

Referenced by addChildNode(), and ossimXmlDocument::fromKwl().

{
   ossimXmlNode::ChildListType::iterator iter = theChildNodes.begin();
   while(iter != theChildNodes.end())
   {
      
      if(node == iter->get())
      {
         ossimRefPtr<ossimXmlNode> temp = *iter;
         
         theChildNodes.erase(iter);
         
         return temp;
      }
      ++iter;
   }
   
   return 0;
}

removeChild() [2/2]

ossimRefPtr< ossimXmlNode > ossimXmlNode::removeChild

(

const ossimString &

tag

)

Definition at line 890 of file ossimXmlNode.cpp.

References theChildNodes.

{
   ossimXmlNode::ChildListType::iterator iter = theChildNodes.begin();
   while(iter != theChildNodes.end())
   {
      if(tag == iter->get()->theTag)
      {
         ossimRefPtr<ossimXmlNode> temp = *iter;
         
         theChildNodes.erase(iter);
         
         return temp;
      }
      ++iter;
   }
   
   return 0;
}

setAttribute()

bool ossimXmlNode::setAttribute	(	const ossimString &	name,
		const ossimString &	value,
		bool	addIfNotPresentFlag = false
	)

Definition at line 766 of file ossimXmlNode.cpp.

References addAttribute(), findAttribute(), ossimXmlAttribute::setValue(), and ossimRefPtr< T >::valid().

{
   bool result = false;
   ossimRefPtr<ossimXmlAttribute> attribute = findAttribute(name);
   if(attribute.valid())
   {
      attribute->setValue(value);
      result = true;
   }
   else
   {
      if(addIfNotPresentFlag)
      {
         addAttribute(name, value);
         result = true;
      }
   }
   
   return result;
}

setAttributes()

void ossimXmlNode::setAttributes

(

ossimXmlNode::AttributeListType &

children

)

Definition at line 933 of file ossimXmlNode.cpp.

References addAttributes(), and clearAttributes().

{
   clearAttributes();
   addAttributes(children);
}

setCDataFlag()

void ossimXmlNode::setCDataFlag

(

bool

value

)

Definition at line 667 of file ossimXmlNode.cpp.

References theCDataFlag.

Referenced by ossimKeywordlist::toXML().

{
   theCDataFlag = value;
}

setChildren()

void ossimXmlNode::setChildren

(

ossimXmlNode::ChildListType &

children

)

Definition at line 917 of file ossimXmlNode.cpp.

References addChildren(), and clearChildren().

{
   clearChildren();
   addChildren(children);
}

setParent()

void ossimXmlNode::setParent

(

ossimXmlNode *

parent

)

Definition at line 100 of file ossimXmlNode.cpp.

References theParentNode.

Referenced by addChildNode().

{
   theParentNode = parent;
}

setTag()

void ossimXmlNode::setTag

(

const ossimString &

tag

)

Definition at line 602 of file ossimXmlNode.cpp.

References theTag.

Referenced by ossimTieGptSet::exportAsGmlNode(), ossimTieGpt::exportAsGmlNode(), ossimXmlDocument::fromKwl(), ossimGmlSupportData::getGmljp2V1RootNode(), ossimGmlSupportData::getGmljp2V2RootNode(), ossimKakaduJpipInfo::print(), ossimMultiBandHistogram::saveState(), ossimHistogram::saveState(), ossimLocalTm::saveXml(), ossimContainerProperty::toXml(), ossimProperty::toXml(), and ossimKeywordlist::toXML().

{
   theTag = tag;
}

setText()

void ossimXmlNode::setText

(

const ossimString &

text

)

Definition at line 657 of file ossimXmlNode.cpp.

References theText.

Referenced by addOrSetNode(), ossimXmlDocument::fromKwl(), ossimHistogram::saveState(), and ossimProperty::toXml().

{
   theText = text;
}

skipCommentTag()

void ossimXmlNode::skipCommentTag ( std::istream &  in )

protected

Definition at line 105 of file ossimXmlNode.cpp.

Referenced by readEndTag().

{
   char c;
   while(!in.fail())
   {
      c = in.get();
      if(c == '-')
      {
         if(in.peek() == '-')
         {
            in.ignore();
            if(in.peek() == '>')
            {
               in.ignore();
               return;
            }
         }
      }
   }
}

toKwl()

void ossimXmlNode::toKwl	(	ossimKeywordlist &	kwl,
		const ossimString &	prefix = ""
	)		const

Definition at line 958 of file ossimXmlNode.cpp.

References ossimKeywordlist::add(), getTag(), getText(), theAttributes, and theChildNodes.

Referenced by ossimXmlDocument::toKwl().

{
   ossimString name = getTag();
   ossimString value = getText();
   
   ossimString copyPrefix = prefix;
   
   if(name != "")
   {
      copyPrefix += (name+".");
   }
   if(theChildNodes.size() < 1)
   {
      kwl.add(prefix+name,
              value,
              true);
   }

   ossimString attributePrefix = copyPrefix + "@";
   ossim_uint32 attributeIdx = 0;
   for(attributeIdx = 0; attributeIdx < theAttributes.size(); ++attributeIdx)
   {
      kwl.add(attributePrefix+theAttributes[attributeIdx]->getName(),
              theAttributes[attributeIdx]->getValue(), 
              true);
   }

   ossim_uint32 idx = 0;
   for(idx = 0; idx < theChildNodes.size();++idx)
   {
      theChildNodes[idx]->toKwl(kwl,
                                copyPrefix);
   }
}

Friends And Related Function Documentation

operator<< [1/2]

OSSIMDLLEXPORT friend ostream& operator<< ( ostream &  os, const ossimXmlNode *  xml_node  )

friend

Definition at line 680 of file ossimXmlNode.cpp.

{
   //
   // Determine the indentation level:
   //
   ossimString indent ("");
   const ossimXmlNode* parent = xml_node->theParentNode;
   while (parent)
   {
      indent += "   ";
      parent = parent->theParentNode;
   }
   
   //
   // Dump the tag opening:
   //
   os << "\n" << indent << "<" << xml_node->theTag;
   
   //
   // Dump any attributes:
   //
   if (xml_node->theAttributes.size())
   {
      ossimXmlNode::AttributeListType::const_iterator attr =
      xml_node->theAttributes.begin();
      while (attr != xml_node->theAttributes.end())
      {
         os << attr->get();
         attr++;
      }
   }
   
   if((xml_node->theChildNodes.size() == 0)&&
      (xml_node->theText == ""))
   {
      os << "/>";
   }
   else
   {
      os << ">";
      
      if(xml_node->cdataFlag())
      {
         os << "<![CDATA[" <<xml_node->theText <<  "]]>";
      }
      else
      {
         //
         // Dump any text:
         //
         os << xml_node->theText;
      }
      //
      // Dump any child nodes:
      //
      if (xml_node->theChildNodes.size())
      {
         ossimXmlNode::ChildListType::const_iterator nodes = xml_node->theChildNodes.begin();
         while (nodes != xml_node->theChildNodes.end())
         {
            os << (*nodes).get();
            nodes++;
         }
         os << "\n" << indent;
      }
      
      //
      // Dump the tag closing:
      // 
      os << "</" << xml_node->theTag << ">";
   }
   
   return os;
}

operator<< [2/2]

OSSIMDLLEXPORT friend ostream& operator<< ( ostream &  os, const ossimXmlNode &  xml_node  )

friend

Definition at line 672 of file ossimXmlNode.cpp.

{
   return operator <<(os, &xml_node);
}

Member Data Documentation

theAttributes

vector<ossimRefPtr<ossimXmlAttribute> > ossimXmlNode::theAttributes

protected

Definition at line 121 of file ossimXmlNode.h.

Referenced by addAttribute(), clear(), clearAttributes(), duplicateAttributes(), findAttribute(), getAttributes(), operator<<(), ossimXmlNode(), and toKwl().

theCDataFlag

bool ossimXmlNode::theCDataFlag

protected

Definition at line 123 of file ossimXmlNode.h.

Referenced by cdataFlag(), clear(), and setCDataFlag().

theChildNodes

vector<ossimRefPtr<ossimXmlNode> > ossimXmlNode::theChildNodes

protected

Definition at line 120 of file ossimXmlNode.h.

Referenced by addChildNode(), clear(), clearChildren(), duplicateChildren(), findChildNodes(), findFirstNode(), getChildNodes(), operator<<(), ossimXmlNode(), removeChild(), and toKwl().

theParentNode

ossimXmlNode* ossimXmlNode::theParentNode

protected

Definition at line 119 of file ossimXmlNode.h.

Referenced by addChildNode(), getParentNode(), operator<<(), and setParent().

theTag

ossimString ossimXmlNode::theTag

protected

Definition at line 118 of file ossimXmlNode.h.

Referenced by addChildNode(), clear(), operator<<(), readEndTag(), and setTag().

theText

ossimString ossimXmlNode::theText

protected

Definition at line 122 of file ossimXmlNode.h.

Referenced by addChildNode(), clear(), operator<<(), and setText().

---

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

• ossimXmlNode.h
• ossimXmlNode.cpp