dataset_base

Version 1.20 07jun05


Introduction

This package defines the base Dataset class, some concrete implementations and other associated components.

The dataset system is described at http://www.usatlas.bnl.gov/~dladams/dataset


Dependencies

Dependencies are described in the CMT requirements file.


Status

Version.
Change log.


Components

The components here are listed in dependency order. Each component depends only on those listed above it. The test associated with each component is a main program that returns zero if the component is working properly.

Some components also have test headers. These are included in the test source and may be included in tests of other components. They should not be included in any non-test sources.

ContentBlock (header, source, test)
Describes a block of content using a dataset type, a name, a list of content ID's and an optional event ID list.

Content (header, source, test)
Describes the content of a dataset as a list of content blocks.

Location (header, source, test)
Location holds the data location for a dataset. For now it only includes a list of logical files.

Dataset (header, source, test header, test)
This is the abstract base class for all datasets. It defines an interface where a dataset has an identity, parent dataset, content, location and lock status. It provides methods for checking validity and the existence of data and for cloning and returning an XML representation.

DatasetRepository (header, source, test)
DatasetRepository makes use of GenericRepository to provides means to insert a dataset and later retrieve it by ID.

DatasetCreator (header, source, test header, test)
DatasetCreator provides a central point for constructing dataset objects from XML descriptions (class XmlElement). Each Dataset subclass defines a creator function and registers it and a name with the DatasetCreator. The latter calls that function when it receives a request to create a dataset from an xml element with that name.

GenericDataset (header, source, test)
GenericDataset provides transient and persistent (i.e. XML) data to describe datasets in a generic manner. There are protected methods that subclasses may call to change this data. Most or all concrte datasets inherit from this base and do not change the XML representation.

TextDataset (header, source, test)
TextDataset carries text. The XML description carrries the text itself rather than a file holding the text.

SingleFileDataset (header, source, test)
Concrete dataset with implicit content and a sigle file for location.

SimpleCompoundDataset (header, source, test)
Compound dataset with composite content and location.

VirtualEventDataset (header, source, test)
Virtual dataset with explicit event content.

EventMergeDataset (header, source, test)
Compound dataset with explicit event content.

Binaries

make_file_dataset (source, test)
Main program to creat a dataset from a file.

make_text_dataset (source, test)
Main program to create a TextDataset.

dataset_text (source, test)
Main program to list and extract text objects in a dataset.


dladams@bnl.gov