Package com.bc.ceres.binio

The core binio API.

See: Description

Interface Summary

Interface	Description
CollectionData	A collection of elements.
CollectionType
CompoundData	A compound of members of any type.
CompoundMember
CompoundType
DataContext	The context provides the means to read from or write to a random access stream or file.
IOHandler	Provides the mechanism to read and write byte data at a specified position within a random access data file, stream or memory buffer.
MetadataAware
SequenceData	A sequence of elements of same type.
SequenceType
Type
VarSequenceType

Class Summary

Class	Description
DataFormat	A binary data format.
SimpleType
TypeBuilder	A utility class which fosters the construction of complex type defintions.

Exception Summary

Exception	Description
DataAccessException	A runtime exception which is used to signal an illegal data access throughout the API.

Package com.bc.ceres.binio Description

The core binio API.

binio is a low-level API used to read and write arbitrarily formetted binary files. It imposes the following programming model:

     // Static format declaration:
     CompoundType type = TypeBuilder.COMPOUND("dataset", ...);
     DataFormat format = new Format(type);

     // Reading/writing a file using the given format:
     DataContextImpl context = format.createContext(file);
     CompoundData compoundData = context.getData();
     // Here: Invoke methods on  compoundData ...
     context.dispose();
 

The TypeBuilder class to easily build complex types. Types can also be read from external plain text files using the TypeParser class.