BxContainer.h

// ##################################################################
// Binx
// $Id: BxContainer_8h-source.html,v 1.1.1.1 2006/04/19 14:19:02 edikt2 Exp $
//
// Header for BxContainer class
/*
    History
        Created 03/06/2003 as BxEnvironment for multiple BxBinxFile
            not implemented, prepared for XPath query module
        Modified 23/09/2003 as BxContainer, not implemented yet
*/
// ##################################################################
/*

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

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

*/

#ifndef __BxContainer__
#define __BxContainer__

#include "BxDataObject.h"
#include "BxBinxFile.h"

/*
 * Class aggregating multiple BinX datasets(not in BinX version 1.0).
 * This class is a preliminary design and it is not fully implemented.
 * Developers are advised not to use this class
 * as significant design changes are anticipated.
 *
 * <BR>A BinX data source consists of:
 * <OL>
 * <li>A BinX document file, represented by a BxBinxFile object</li>
 * <li>An external binary data file, represented by a BxBinaryFile object</li>
 * </OL>
 * The BinX document references at least one external binary data file.
 * A binary data file reference is represented in the BxBinxFile object
 * by storing a link to the BxBinxFile object.
 * A BxContainer object stores a list of BinX data sources,
 * so that operations can be performed over a set of data sources.
 *
 * <BR>At most one instance of the class BxContainer
 * should be created during an execution.
 * This class implements a search method to select a
 * particular data source in the set of data sources,
 * and to invoke a query operation on the selected data source.
 *
 * <BR>A BxContainer object can be created explicitly
 * and BinX data sources can be added incrementally.
 * If an application uses only one data source,
 * but that data source contains multiple references to external binary data files,
 * then a BxContainer object is implicitly created to manage the multiple
 * exernal binary data files referenced from a single BinX document file.
 * <BR><B>Since:</B> Future release to be determined.
 */
class DECLSPEC BxContainer : public BxObject
{
    BxBinxFile** binxfiles_;   //array of BxBinxFile objects
    int elementCount_;  //number of elements in the above array
public:
    BxContainer();
    virtual ~BxContainer();

    virtual char* className() const { return "BxContainer"; } //Returns the null-terminated string "BxContainer".
    void addBinxFile(BxBinxFile *);
    BxBinxFile * getBinxFile(int index); //get pointer by index
    BxBinxFile * getBinxFile(const char * xref);
    BxDataObject * getDataObject(const char * xref, const char * xpath);
};

#endif

 

---