BxBinxDomParser.h

/********************************************************************
 * Binx
 * $Id: BxBinxDomParser_8h-source.html,v 1.1.1.1 2006/04/19 14:19:02 edikt2 Exp $
 *
 * Class for parsing the BinX document using the DOM engine
 *
 *
 * edikt::BinX
 * www.edikt.org
 * support@edikt.org
 *
 * Copyright (c) 2005 The University of Edinburgh.
 *
 ********************************************************************/

#ifndef BXBINXDOMPARSER_H
#define BXBINXDOMPARSER_H

#include "BxDataset.h"
#include "BxUnion.h"
#include "BxBinaryFile.h"
#include "BxArray.h"
#include "BxArrayFixed.h"
#include "BxArrayVariable.h"
#include "BxArrayStreamed.h"
#include "BxBinxParser.h"
#include "BxDomParser.h"

class BxDomParser;
class BxDomNodeList;

/*
 * - Base class to manage objects from BinX XML document files.
 * This class invokes methods in the class BxDomParser to access the BinX document file
 * and to parse the XML statements contained in the document file.
 * When processing an existing BinX document file,
 * this class creates a set of relationed objects that record
 * the intermediate, parsed XML representation returned by the BxDomParser class.
 * Objects of type BxDataset, BxArray, and BxUnion are used to hold these parsed results.
 * <BR>
 * This class should also be used to create a new BinX document file.
 * A caller must create a empty BxBinxFile object,
 * create approriate objects to contain the memory-resident representation of
 * a BinX document specification, and then use the BxDomParser class
 * to save the entire specification in a BinX document file.
 * <BR>
 * More than one binary application data file may be associated with the dataset.
 * So this object maintains a list of binary file pointers which will be assigned
 * to the particular data elements in the dataset.
 *<BR>
 * When reading from a BinX file, create an instance of this class
 * and call the method parseBinxFile() to initialize the BxBinxFile object with
 * the schema definition from the document file,
 * and then invoke the method getDataset to obtain a pointer to the dataset.
 * <BR>
 * When writing a new BinX document file, create an instance of this class
 * and call BxDataSet::addDataObject() method to add a number of data objects 
 * describing the XMl schema elements to be added to the BinX document file.
 * After the specification has been constructed, use the BxBinxFileWriter class
 * to save the BinX document to a specified local file.
 * <BR>
 * The BxDomParser used by this class is a wrapper for a third party DOM parser.
 * The BxDomParser class implements the mapping between the implementation
 * data structures used by the third party DOM parser and the object structures
 * used by this class to represent the BinX XML document file.
 * This allows one DOM parser to be more easily replaced by another.
 * <BR><B>Since:</B>  BinX version 1.1.
 */
class DECLSPEC BxBinxDomParser : public BxBinxParser
{
public:
    BxBinxDomParser();
    virtual ~BxBinxDomParser();

    virtual char* className() const { return "BxBinxDomParser"; }
    virtual bool parse(const char* xmlFile);

protected:
    BxDomParser* dom_; //<holds the parsed DOM tree

private:
    void parseArrayDimensions(BxArray*, BxDomNodeList*);
    void parseDataAttributes(BxDomNodeList* , BxDataObject* );
    void parseDatasetAttributes(BxDomParser&);
    bool parseDefinitions(BxDomParser& bp);
    bool parseDataInstances(BxDomParser& bp);
    bool parseDefinedElements(BxDomNodeList*, const char*);
    bool parseUsedElements(BxDomNodeList*, BxDataset*, BxBinaryFile*);
    bool parseUnionElements(BxDomNodeList*, BxUnion*);
    bool parseArrayElements(BxArray*, BxDomNodeList*);
    BxDataObject* createPrimitiveDataObject(BxBinxTagNumber tagNum);
    BxDataset* createStruct(const char* typeName, BxByteOrder bo, BxDomNodeList* pNode);
    BxUnion* createUnion(const char* typeName, BxByteOrder bo, BxDomNodeList* pNode);
    BxArray* createArray(BxBinxTagNumber tag, const char* typeName, BxByteOrder bo, BxDomNodeList* pNode);
};

#endif

---