BxBinxParser.h

// ##################################################################
// Binx
// $Id: BxBinxParser_8h-source.html,v 1.1.1.1 2006/04/19 14:19:02 edikt2 Exp $
//
// Header for BxBinxParser
// ##################################################################
/*

//  edikt::BinX
//  www.edikt.org
//  support@edikt.org

// Copyright (c) 2004 The University of Edinburgh.

*/

#ifndef __BxBinxParser__
#define __BxBinxParser__

#include "BxDataset.h"
#include "BxBinaryFile.h"
#include "BxDataObjects.h"

class BxBinxFile;

/*
 * - Base class for BinX parsers: BxBinxDomParser and BxBinxSaxParser.
 * TODO: change this comment
 *
 * The constructor of BxBinxParser creates an instance of BxDataset which is
 * not deleted by the destructor, but left to the caller.
 * The caller should grab this data object by calling getDataset() method
 * and release it at the end of its life cycle.
 *
 * <BR><B>Since:</B>  BinX version 1.1.
 *
 * \internal
 * History:
 * 23/09/03   Created to replace original BxBinxFile which is a sole parser.
 */
class DECLSPEC BxBinxParser : public BxObject
{
public:
    BxBinxParser();
    virtual ~BxBinxParser();

    virtual char* className() const { return "BxBinxParser"; }
    BxDataset* getDataset() const { return datasetRoot_; }
    BxBinaryFile* getBinaryFile() { return bfile_; }

    virtual bool parse(const char*) { return false; } //Implemented in derived class

protected:
    void toUpperCase(char* s);
    void extractFilePath(const char* binxFile);

    void setBinaryFile(BxBinaryFile* bfile);
    void createBinaryFile(const char* filename);

    BxDataObjects& getDefinitions() { return definitions_; }
    const char* getPath() const { return path_; }

private:
    void dropDatasetFile()
    {
        datasetRoot_ = NULL; //used by BxBinxFile::parseBinxFile
        bfile_ = NULL;       //after taking over these pointers, so the destructor won't delete
    }
    //member variables
    //will be passed to the caller BxBinxFile
    BxDataset*  datasetRoot_;   //the BinX document dataset object, describing the content of the binary data file
    BxBinaryFile* bfile_;    //pointer to the open binary data file

    //these are local variables, released by destructor
    BxDataObjects  definitions_;   //the BinX document definitions secdtion, defining abstract data types
    char* path_;   //path of the BinX xml file, also used as the path for the binary data file

    friend class BxBinxFile;
};

#endif

---