Package org.jlab.coda.jevio

Interface Summary

Interface	Description
EvioNodeSource	This interface is used for a compact reader to class to get EvioNode objects when parsing evio data.
IBlockHeader	Make a common interface for different versions of the BlockHeader.
IEvioCompactReader	This is an interface for a compact reader of evio format files and buffers.
IEvioFilter	This interface allows applications to create filters so that they only recieve certain structures when events are being processed.
IEvioListener	In SAX like behavior, implementors will listen for structures encountered when an event is parsed.
IEvioProgressListener	Interface used for listening for progress.
IEvioReader	This interface is used to abstract various file and buffer reading functions.
IEvioStructure	This interface is implemented by classes representing the basic evio structures: banks, segments, and tagsegments.
IEvioWriter	This is implemented by objects that will be writing themselves to en evio file.
INameProvider	This interface must be implemented by dictionary readers.

Class Summary

Class	Description
BankHeader	This the header for an evio bank structure (EvioBank).
BaseStructure	This is the base class for all evio structures: Banks, Segments, and TagSegments.
BaseStructureHeader	This the header for the base structure (BaseStructure).
BlockHeaderV2	This holds an evio block header, also known as a physical record header.
BlockHeaderV4	This holds an evio block header, also known as a physical record header.
BlockNode	This class is used to store relevant info about an evio block along with its position in a buffer.
ByteDataTransformer	This utility class contains methods for transforming a raw byte array into arrays of other types and vice versa as well as other handy methods.
CompactEventBuilder	This class is used for creating events and their substructures while minimizing use of Java objects.
CompositeData	This is the class defining the composite data type.
CompositeData.Data	This class is used to provide all data when constructing a CompositeData object.
CompositeData.LV
Environment	This is a utility class employing a singleton to obtain environment information, such as user name, home directory, OS name, etc.
EventBuilder	This class is used for creating and manipulating events.
EventParser	Creates an object that controls the parsing of events.
EventWriter	An EventWriter object is used for writing events to a file or to a byte buffer.
EventWriterUnsync	An EventWriter object is used for writing events to a file or to a byte buffer.
EvioBank	This holds a CODA Bank structure.
EvioByteArrayOutputStream	This class is a slightly modified copy of java's ByteArrayOutputStream.
EvioCompactReader	This class is used to read an evio version 4 formatted file or buffer and extract specific evio containers (bank, seg, or tagseg) with actual data in them given a tag/num pair.
EvioCompactReaderUnsyncV4	This class is used to read an evio format version 4 formatted file or buffer and extract specific evio containers (bank, seg, or tagseg) with actual data in them given a tag/num pair.
EvioCompactReaderUnsyncV6	This class is used to read an evio format version 6 formatted file or buffer.
EvioCompactReaderV4	This class is used to read an evio format version 4 formatted file or buffer and extract specific evio containers (bank, seg, or tagseg) with actual data in them given a tag/num pair.
EvioCompactReaderV6	This class is used to read an evio format version 6 formatted file or buffer.
EvioCompactStructureHandler	This class is used to read the bytes of just an evio structure (NOT a full evio version 4 formatted file or buffer).
EvioDictionaryEntry	Class to facilitate use of Evio XML dictionary entry data as a key or value in a hash table.
EvioEvent	An event is really just the outer, primary bank.
EvioNode	This class is used to store relevant info about an evio container (bank, segment, or tag segment), without having to de-serialize it into many objects and arrays.
EvioNodePool	Array-based pool of EvioNode objects.
EvioReader	This is a class of interest to the user.
EvioReaderUnsyncV4	This is a class of interest to the user.
EvioReaderUnsyncV6	This class is used to read an evio version 6 format file or buffer.
EvioReaderV4	This is a class of interest to the user.
EvioReaderV6	This class is used to read an evio version 6 format file or buffer.
EvioSegment	This holds a CODA Segment structure.
EvioTagSegment	This holds a CODA TagSegment structure.
EvioXMLDictionary	This was developed to read the xml dictionary that Maurizio uses for GEMC.
MappedMemoryHandler	This is a class designed to handle access of evio version 4 format files with size greater than 2.1 GBytes.
NameProvider	This class maintains the single global NameProvider.
NameProviderFactory	A Factory class for generating an appropriate INameProvider.
SegmentHeader	This the the header for an evio segment structure (EvioSegment).
StructureFinder	This is a set of convenient static methods used to find lists of structures within an event, bank, segment, or tagsegment that match certain criteria.
StructureTransformer	This class contains methods to transform structures from one type to another, for example changing an EvioSegment into an EvioBank.
TagSegmentHeader	This the the header for an evio tag segment structure (EvioTagSegment).
Utilities	This class contains generally useful methods.

Enum Summary

Enum	Description
DataType	This an enum used to convert data type numerical values to a more meaningful name.
EvioDictionaryEntryType	Each dictionary entry may have different values of tag, tagEnd, and num specified.
ReadStatus	This enum denotes the status of a read.
StructureType	This an enum used to convert structure type numerical values to a more meaningful name.
WriteStatus	This enum denotes the status of a write. SUCCESS indicates a successful write.

Exception Summary

Exception	Description
EvioException	This is a general exception used to indicate a problem in the Jevio package.