ossimXmlDocument Class Reference

#include <ossimXmlDocument.h>

Inheritance diagram for ossimXmlDocument:

Public Member Functions
	ossimXmlDocument (const ossimFilename &xmlFileName="")
	ossimXmlDocument (const ossimXmlDocument &src)
virtual ossimObject *	dup () const
virtual	~ossimXmlDocument ()
bool	write (const ossimFilename &file)
bool	openFile (const ossimFilename &filename)
bool	read (std::istream &in)
void	findNodes (const ossimString &xpath, std::vector< ossimRefPtr< ossimXmlNode > > &nodelist) const
	Appends any matching nodes to the list supplied (should be empty): More...
void	initRoot (ossimRefPtr< ossimXmlNode > node)
ossimRefPtr< ossimXmlNode >	getRoot ()
const ossimRefPtr< ossimXmlNode >	getRoot () const
ossimRefPtr< ossimXmlNode >	removeRoot ()
void	fromKwl (const ossimKeywordlist &kwl)
void	toKwl (ossimKeywordlist &kwl, const ossimString &prefix="") const
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...

Private Member Functions
bool	readHeader (std::istream &in)

Private Attributes
ossimRefPtr< ossimXmlNode >	theRootNode
ossimString	theXmlHeader
ossimFilename	theFilename
bool	theStrictCheckFlag

Friends
OSSIMDLLEXPORT friend std::ostream &	operator<< (std::ostream &os, const ossimXmlDocument &xml_doc)

Additional Inherited Members
Protected Member Functions inherited from ossimReferenced
virtual	~ossimReferenced ()
Protected Attributes inherited from ossimErrorStatusInterface
ossimErrorCode	theErrorStatus

Detailed Description

Definition at line 24 of file ossimXmlDocument.h.

Constructor & Destructor Documentation

ossimXmlDocument() [1/2]

ossimXmlDocument::ossimXmlDocument

(

const ossimFilename &

xmlFileName = ""

)

Definition at line 49 of file ossimXmlDocument.cpp.

   :
   theRootNode  (0),
   theXmlHeader("<?xml version='1.0'?>"),
   theStrictCheckFlag(false)
{
   if(xmlFileName != "")
   {
      openFile(xmlFileName);
   }
}

ossimXmlDocument() [2/2]

ossimXmlDocument::ossimXmlDocument

(

const ossimXmlDocument &

src

)

Definition at line 61 of file ossimXmlDocument.cpp.

:ossimObject(src),
theRootNode(src.theRootNode.valid()?(ossimXmlNode*)src.theRootNode->dup():(ossimXmlNode*)0),
theXmlHeader(src.theXmlHeader),
theFilename(src.theFilename),
theStrictCheckFlag(src.theStrictCheckFlag)
{
   
}

~ossimXmlDocument()

ossimXmlDocument::~ossimXmlDocument ( )

virtual

Definition at line 71 of file ossimXmlDocument.cpp.

{
}

Member Function Documentation

dup()

virtual ossimObject* ossimXmlDocument::dup ( ) const

inlinevirtual

Reimplemented from ossimObject.

Definition at line 30 of file ossimXmlDocument.h.

   {
      return new ossimXmlDocument(*this);
   }

findNodes()

void ossimXmlDocument::findNodes	(	const ossimString &	xpath,
		std::vector< ossimRefPtr< ossimXmlNode > > &	nodelist
	)		const

Appends any matching nodes to the list supplied (should be empty):

Definition at line 172 of file ossimXmlDocument.cpp.

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

Referenced by ossimGmlSupportData::addLineSamps(), ossimGmlSupportData::addScale(), ossimGmlSupportData::addTie(), ossimFgdcFileWriter::find(), ossimplugins::ossimTerraSarProductDoc::getCommonPrf(), ossimplugins::ossimTerraSarProductDoc::getCommonRsf(), ossimplugins::ossimTerraSarProductDoc::getImageDataStrartWith(), ossimGmlSupportData::getImageGeometryFromRectifiedGrid(), ossimGmlSupportData::getImageGeometryFromSeonsorModel(), ossimFgdcXmlDoc::getImageSize(), ossimplugins::ossimTerraSarProductDoc::getNumberOfAzimuthLooks(), ossimplugins::ossimTerraSarProductDoc::getNumberOfRangeLooks(), ossimplugins::ossim::getPath(), ossimAuxXmlSupportData::getPath(), ossimXmpInfo::getPath(), ossimFgdcXmlDoc::getPath(), ossimplugins::ossimTerraSarModel::getPolLayerFromImageFile(), ossimplugins::ossimTerraSarModel::initCalibration(), ossimSpotDimapSupportData::initFramePoints(), ossimFormosatDimapSupportData::initFramePoints(), ossimAuxXmlSupportData::initializeProjection(), ossimSpotDimapSupportData::initImageId(), ossimFormosatDimapSupportData::initImageId(), ossimplugins::ossimRadarSat2Model::InitLut(), ossimSpotDimapSupportData::initMetadataVersion(), ossimFormosatDimapSupportData::initMetadataVersion(), ossimplugins::ossimTerraSarModel::initNoise(), ossimplugins::ossimTerraSarProductDoc::initNoise(), ossimplugins::ossimTerraSarProductDoc::initPlatformPosition(), ossimplugins::ossimRadarSat2Model::InitRefNoiseLevel(), ossimplugins::ossimTerraSarProductDoc::initSceneCoord(), ossimSpotDimapSupportData::initSceneSource(), ossimFormosatDimapSupportData::initSceneSource(), ossimplugins::ossimTerraSarModel::initSRGR(), ossimplugins::ossimRadarSat2Model::initSRGR(), ossimplugins::ossimTerraSarProductDoc::initTiePoints(), ossimNitfXmlDataContentDes::loadValueFromXml(), ossimplugins::ossimSpot6DimapSupportData::parseDatasetContent(), ossimplugins::ossimPleiadesDimapSupportData::parseDatasetContent(), ossimplugins::ossimSpot6DimapSupportData::parseGeometricData(), ossimplugins::ossimPleiadesDimapSupportData::parseGeometricData(), ossimplugins::ossimSpot6DimapSupportData::parseMetadataIdentificationDIMAPv2(), ossimplugins::ossimPleiadesDimapSupportData::parseMetadataIdentificationDIMAPv2(), ossimSpotDimapSupportData::parsePart1(), ossimFormosatDimapSupportData::parsePart1(), ossimFormosatDimapSupportData::parsePart2(), ossimSpotDimapSupportData::parsePart2(), ossimFormosatDimapSupportData::parsePart3(), ossimSpotDimapSupportData::parsePart3(), ossimFormosatDimapSupportData::parsePart4(), ossimSpotDimapSupportData::parsePart4(), ossimplugins::ossimSpot6DimapSupportData::parseRadiometricData(), ossimplugins::ossimPleiadesDimapSupportData::parseRadiometricData(), ossimplugins::ossimSpot6DimapSupportData::parseRasterData(), ossimplugins::ossimPleiadesDimapSupportData::parseRasterData(), ossimplugins::ossimSpot6DimapSupportData::parseRPCMetadata(), ossimplugins::ossimPleiadesDimapSupportData::parseRPCMetadata(), and ossimTiffInfo::printXmpMetadata().

{
   //
   // First verify the root node exists:
   //
   if (!theRootNode.valid())
   {
      if (traceDebug())
      {
         ossimNotify(ossimNotifyLevel_DEBUG)
            << "WARNING: ossimXmlDocument::findNodes,\n"
            << "No root node has been instantiated. Returning null "
            << "node list..." << endl;
      }
      return;
   }

   //
   // Make a copy to manipulate:
   //
   ossimString xpath (arg_xpath);
   if (xpath.empty())
      return;
   
   //
   // Check if absolute path:
   //
   if (xpath[static_cast<std::string::size_type>(0)] !=
       XPATH_DELIM[static_cast<std::string::size_type>(0)])
   {
      if (traceDebug())
      {
         ossimNotify(ossimNotifyLevel_DEBUG)
            << "WARNING: ossimXmlDocument::findNodes\n"
            << "Only absolute XPaths are supported. Returning null "
            << "node list..." << endl;
      }
      return;
   }

   //
   // Check that root tag matches path root:
   //
   ossimString rel_xpath (xpath.after(XPATH_DELIM));
   ossimString root_tag (rel_xpath);
   if (root_tag.contains(XPATH_DELIM))
       root_tag = rel_xpath.before(XPATH_DELIM);
   
   if (root_tag != theRootNode->getTag())
   {
      if (traceDebug())
      {
         ossimNotify(ossimNotifyLevel_DEBUG)
            << "WARNING: ossimXmlDocument::findNodes\n"
            << "XPath's root node <"<<root_tag<<"> does not match the "
            << "stored root node's tag <" << theRootNode->getTag() << ">. "
            << "Returning null node list..." << endl;
      }
      return;
   }

   //
   // If the root node was the requested node, return it alone:
   //
   rel_xpath = rel_xpath.after(XPATH_DELIM);
   if (rel_xpath.empty())
   {
      result.push_back(theRootNode);
      return;
   }
   
   //
   // Pass the node request on to the root node with the relative path:
   //
   theRootNode->findChildNodes(rel_xpath, result);
}

fromKwl()

void ossimXmlDocument::fromKwl

(

const ossimKeywordlist &

kwl

)

Definition at line 288 of file ossimXmlDocument.cpp.

References ossimXmlNode::addAttribute(), ossimXmlNode::addNode(), ossimString::contains(), ossimXmlNode::getChildNodes(), ossimKeywordlist::getMap(), ossimXmlNode::getParentNode(), ossimXmlNode::getTag(), ossimXmlNode::getText(), ossimXmlNode::removeChild(), ossimXmlNode::setTag(), ossimXmlNode::setText(), ossimString::substitute(), and theRootNode.

Referenced by ossimSubImageTool::execute(), and ossimInfo::outputXml().

{

   ossimKeywordlist kwl = kwlToConvert;
   theRootNode = 0;
   theRootNode = new ossimXmlNode;

   
   ossimString prefix = "";
   ossimKeywordlist::KeywordMap& map              = kwl.getMap();
   ossimKeywordlist::KeywordMap::iterator mapIter = map.begin();

   while(mapIter != map.end())
   {
      ossimString key = mapIter->first;
      key = key.substitute(".", "/", true);
      theRootNode->addNode(key, mapIter->second);
      ++mapIter;
   }

   // now collapse all keywordlist styles to the XML style
   //
   std::stack<ossimRefPtr<ossimXmlNode> > tempStack;
   tempStack.push(theRootNode);
   while(!tempStack.empty())
   {
      
      ossimRefPtr<ossimXmlNode> node = tempStack.top();
      tempStack.pop();
      vector<ossimRefPtr<ossimXmlNode> >& childNodes = node->getChildNodes();
      ossim_uint32 idx = 0;
      for(idx = 0; idx < childNodes.size(); ++idx)
      {
         tempStack.push(childNodes[idx]);
      }
      if(node->getChildNodes().size() > 0)
      {
         if(node->getTag()!="")
         {
            node->addAttribute("name", node->getTag());
         }
         node->setTag("object");
      }
      
      if(node->getTag() == "type")
      {
         if(node->getParentNode())
         {
            node->getParentNode()->removeChild("type");
            node->getParentNode()->addAttribute("type", node->getText());
         }
      }
      else if(node->getChildNodes().size() < 1)
      {
         if(node->getTag()!="")
         {
            node->addAttribute("name", node->getTag());
         }
         if(!node->getText().contains("\n"))
         {
            if(node->getText()!="")
            {
               node->addAttribute("value", node->getText());
               node->setText("");
            }
         }
         node->setTag("property");
      }
   }
}

getRoot() [1/2]

ossimRefPtr< ossimXmlNode > ossimXmlDocument::getRoot

(

)

Definition at line 268 of file ossimXmlDocument.cpp.

References theRootNode.

Referenced by ossimKmlSuperOverlayReader::open(), ossimKakaduJpipInfo::print(), ossimWmsCapabilitiesDocument::read(), and ossimPpjFrameSensorFile::readStream().

{
   return theRootNode;
}

getRoot() [2/2]

const ossimRefPtr< ossimXmlNode > ossimXmlDocument::getRoot

(

)

const

Definition at line 273 of file ossimXmlDocument.cpp.

References theRootNode.

{
   return theRootNode;
}

initRoot()

void ossimXmlDocument::initRoot

(

ossimRefPtr< ossimXmlNode >

node

)

Definition at line 263 of file ossimXmlDocument.cpp.

References theRootNode.

Referenced by ossimGmlSupportData::initialize(), and ossimKakaduJpipInfo::print().

{
   theRootNode = node;
}

openFile()

bool ossimXmlDocument::openFile

(

const ossimFilename &

filename

)

Definition at line 91 of file ossimXmlDocument.cpp.

References ossimString::c_str(), and theFilename.

Referenced by ossimplugins::ossimRadarSat2TiffReader::getInternalImageGeometry(), ossimplugins::ossimTerraSarTiffReader::getInternalImageGeometry(), ossimplugins::ossimRadarSat2Model::InitLut(), ossimplugins::ossimRadarSat2TiffReader::isRadarSat2ProductFile(), ossimplugins::ossimTerraSarTiffReader::isTerraSarProductFile(), ossimplugins::ossimRadarSat2TiffReader::open(), ossimplugins::ossimTerraSarTiffReader::open(), ossimplugins::ossimRadarSat2RPCModel::open(), ossimplugins::ossimTerraSarModel::open(), ossimplugins::ossimRadarSat2Model::open(), and ossimFgdcFileWriter::setTemplate().

{
   
   theFilename = filename;

   if(theFilename == "")
   {
      return false;
   }

   //
   // Open XML File:
   // Note: Opening text document binary to overcome an apparent windows bug.
   //
   ifstream xml_stream (filename.c_str(), ios::binary);
   if (!xml_stream)
   {
      if (traceDebug())
      {
         ossimNotify(ossimNotifyLevel_DEBUG)
            << "DEBUG: ossimXmlDocument::ossimXmlDocument\n"
            << "encountered opening file <" << filename << "> for "
            << "reading. Aborting..." << endl;
      }
      return false;
   }

   return read(xml_stream);
}

read()

bool ossimXmlDocument::read

(

std::istream &

in

)

Definition at line 121 of file ossimXmlDocument.cpp.

References ossimString::contains(), readHeader(), ossimErrorStatusInterface::setErrorStatus(), theStrictCheckFlag, and theXmlHeader.

Referenced by ossimXmpInfo::getDate(), ossimAuxXmlSupportData::getProjection(), ossimXmpInfo::getProjection(), ossimKmlSuperOverlayReader::getTopLevelKmlFileInfo(), ossimGmlSupportData::initialize(), ossimNitfXmlDataContentDes::parseStream(), ossimplugins::ossimSpot6DimapSupportData::parseXmlFile(), ossimplugins::ossimPleiadesDimapSupportData::parseXmlFile(), ossimKakaduJpipInfo::print(), ossimTiffInfo::printXmpMetadata(), ossimWmsCapabilitiesDocument::read(), and ossimPpjFrameSensorFile::readStream().

{
//   char buffer[BUFFER_MAX_LEN];
//   streampos file_pos;
//   bool readingHeader = true;
   bool startTagCharacterFound = false;
   char c = in.peek();

   // Initially we will do our own skipping to make sure we ar not binary.
   while(!in.bad() && (c != '<') && (c >= 0x20) && (c <= 0x7e))
   {
      in.ignore(1);
      c = in.peek();
   }

   if (in.bad() || (c!='<'))
   {
      setErrorStatus();
      return false;
   }
   startTagCharacterFound = true;

   if(readHeader(in))
   {
      if(theXmlHeader=="")
      {
         if(startTagCharacterFound)
         {
            theXmlHeader = "<?xml version='1.0'?>";
         }
      }
   }
   if((!theXmlHeader.contains("xml version")) && theStrictCheckFlag)
   {
      if (traceDebug())
      {
         ossimNotify(ossimNotifyLevel_DEBUG)
            << "FATAL: ossimXmlDocument::ossimXmlDocument"
            << "encountered parsing XML file <" << theFilename
            << ">. The file does not appear to be XML v1.0. \n"
            << "Header = \n" << theXmlHeader <<"\n"
            << endl;
      }
      setErrorStatus();
      return false;
   }
   theRootNode = new ossimXmlNode(in, 0);
   setErrorStatus(theRootNode->getErrorStatus());
   return (getErrorStatus()==ossimErrorCodes::OSSIM_OK);
}

readHeader()

bool ossimXmlDocument::readHeader ( std::istream &  in )

private

Definition at line 376 of file ossimXmlDocument.cpp.

References ossimString::clear(), and theXmlHeader.

Referenced by read().

{
   //---
   // Clear the existing header so we don't get double:
   // <?xml version='1.0'?><?xml version='1.0'?>
   //---
   theXmlHeader.clear();
   
   char c;
   in>>xmlskipws;

   while(in.peek() == '<')
   {
      std::stack<char> theLessThanStack;
      theLessThanStack.push('<');
      in.ignore(1);
      c = in.peek();
      // we will for now skip things like !DOCTYPE and any other things in the header of the document that start with <? or <!
      if((c == '?')||
         (c == '!'))
      {
         theXmlHeader += "<";
         theXmlHeader += (char)in.get();
         
         while(!theLessThanStack.empty()&&
               (!in.bad()))
         {
            if(in.peek() == '<')
            {
               theLessThanStack.push('<');
            }
            else if(in.peek() == '>')
            {
               theLessThanStack.pop();
            }
            theXmlHeader += (char)in.get();
         }
         if(!in.bad())
         {
            if(in.peek()=='\n'||
               in.peek()=='\r')
            {
               theXmlHeader += (char)in.get();
            }
         }
//          if(!in.bad())
//          {
//             theXmlHeader += (char)in.get();
//          }
         in>>xmlskipws;
      }
   }

   return (!in.bad());
}

removeRoot()

ossimRefPtr< ossimXmlNode > ossimXmlDocument::removeRoot

(

)

Definition at line 278 of file ossimXmlDocument.cpp.

References theRootNode.

{
   ossimRefPtr<ossimXmlNode> root = theRootNode;

   theRootNode = 0;

   return root;
}

toKwl()

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

Definition at line 359 of file ossimXmlDocument.cpp.

References theRootNode, ossimXmlNode::toKwl(), and ossimRefPtr< T >::valid().

Referenced by ossimKakaduJpipInfo::print().

{
   if(theRootNode.valid())
   {
      theRootNode->toKwl(kwl, prefix);
   }
//    const std::vector<ossimRefPtr<ossimXmlNode> >& children = theRootNode->getChildNodes();
   
//    ossim_uint32 idx = 0;
   
//    for(idx = 0; idx < children.size(); ++idx)
//    {
//       children[idx]->toKwl(kwl, prefix);
//    }
}

write()

bool ossimXmlDocument::write

(

const ossimFilename &

file

)

Definition at line 75 of file ossimXmlDocument.cpp.

References ossimString::c_str().

Referenced by ossimSubImageTool::execute(), and ossimInfo::outputXml().

{
   std::ofstream out(file.c_str());

   if(out)
   {
      out << *this << std::endl;
   }
   else
   {
      return false;
   }

   return true;
}

Friends And Related Function Documentation

operator<<

OSSIMDLLEXPORT friend std::ostream& operator<< ( std::ostream &  os, const ossimXmlDocument &  xml_doc  )

friend

Member Data Documentation

theFilename

ossimFilename ossimXmlDocument::theFilename

private

Definition at line 58 of file ossimXmlDocument.h.

Referenced by openFile().

theRootNode

ossimRefPtr<ossimXmlNode> ossimXmlDocument::theRootNode

private

Definition at line 56 of file ossimXmlDocument.h.

Referenced by findNodes(), fromKwl(), getRoot(), initRoot(), operator<<(), removeRoot(), and toKwl().

theStrictCheckFlag

bool ossimXmlDocument::theStrictCheckFlag

private

Definition at line 59 of file ossimXmlDocument.h.

Referenced by read().

theXmlHeader

ossimString ossimXmlDocument::theXmlHeader

private

Definition at line 57 of file ossimXmlDocument.h.

Referenced by operator<<(), read(), and readHeader().

---

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

• ossimXmlDocument.h
• ossimXmlDocument.cpp