A B C D E F G I M N O P R S T V W

A

accept(StructureType, BaseStructureHeader) - Method in interface org.jlab.coda.jevio.IEvioFilter
 
addChild(BaseStructure, BaseStructure) - Method in class org.jlab.coda.jevio.EventBuilder
Add a child to a parent structure.
addEvioListener(IEvioListener) - Method in class org.jlab.coda.jevio.ByteParser
Add an Evio listener.
addEvioListener(IEvioListener) - Method in class org.jlab.coda.jevio.EventParser
Add an Evio listener.
appendByteData(byte[]) - Method in class org.jlab.coda.jevio.BaseStructure
Appends byte data to the structure.
appendByteData(BaseStructure, byte[]) - Method in class org.jlab.coda.jevio.EventBuilder
Appends byte data to the structure.
appendCharData(char[]) - Method in class org.jlab.coda.jevio.BaseStructure
Appends char data to the structure (as ascii).
appendCharData(BaseStructure, char[]) - Method in class org.jlab.coda.jevio.EventBuilder
Appends char data to the structure.
appendDoubleData(double[]) - Method in class org.jlab.coda.jevio.BaseStructure
Appends double data to the structure.
appendDoubleData(BaseStructure, double[]) - Method in class org.jlab.coda.jevio.EventBuilder
Appends double data to the structure.
appendFloatData(float[]) - Method in class org.jlab.coda.jevio.BaseStructure
Appends float data to the structure.
appendFloatData(BaseStructure, float[]) - Method in class org.jlab.coda.jevio.EventBuilder
Appends float data to the structure.
appendIntData(int[]) - Method in class org.jlab.coda.jevio.BaseStructure
Appends int data to the structure.
appendIntData(BaseStructure, int[]) - Method in class org.jlab.coda.jevio.EventBuilder
Appends int data to the structure.
appendLongData(long[]) - Method in class org.jlab.coda.jevio.BaseStructure
Appends long data to the structure.
appendLongData(BaseStructure, long[]) - Method in class org.jlab.coda.jevio.EventBuilder
Appends long data to the structure.
appendShortData(short[]) - Method in class org.jlab.coda.jevio.BaseStructure
Appends short data to the structure.
appendShortData(BaseStructure, short[]) - Method in class org.jlab.coda.jevio.EventBuilder
Appends short data to the structure.

B

BankHeader - Class in org.jlab.coda.jevio
This the header for an evio bank structure (EvioBank).
BankHeader() - Constructor for class org.jlab.coda.jevio.BankHeader
Null constructor.
BankHeader(int, DataType, int) - Constructor for class org.jlab.coda.jevio.BankHeader
Constructor
BankHeader(int, int, int) - Constructor for class org.jlab.coda.jevio.BankHeader
Constructor
BaseStructure - Class in org.jlab.coda.jevio
This is the base class for all evio structures: Banks, Segments, and TagSegments.
BaseStructure(BaseStructureHeader) - Constructor for class org.jlab.coda.jevio.BaseStructure
Constructor using a provided header
BaseStructureHeader - Class in org.jlab.coda.jevio
This the header for the base structure (BaseStructure).
BaseStructureHeader() - Constructor for class org.jlab.coda.jevio.BaseStructureHeader
Null constructor.
BaseStructureHeader(int, DataType) - Constructor for class org.jlab.coda.jevio.BaseStructureHeader
Constructor
BaseStructureHeader(int, int) - Constructor for class org.jlab.coda.jevio.BaseStructureHeader
Constructor
BaseStructureHeader(int, DataType, int) - Constructor for class org.jlab.coda.jevio.BaseStructureHeader
Constructor
BaseStructureHeader(int, int, int) - Constructor for class org.jlab.coda.jevio.BaseStructureHeader
Constructor
BlockHeader - Class in org.jlab.coda.jevio
This holds a evio block header, also known as a physical record header.
BlockHeader() - Constructor for class org.jlab.coda.jevio.BlockHeader
Null constructor initializes all fields to zero.
BlockHeader(int, int) - Constructor for class org.jlab.coda.jevio.BlockHeader
Creates a BlockHeader for evio version 2 format.
BlockHeader(int, int, int) - Constructor for class org.jlab.coda.jevio.BlockHeader
Creates a BlockHeader.
ByteDataTransformer - Class in org.jlab.coda.jevio
This utility class contains methods for transforming a raw byte array into arrays of other types such as int and double.
ByteDataTransformer() - Constructor for class org.jlab.coda.jevio.ByteDataTransformer
 
ByteParser - Class in org.jlab.coda.jevio
This class controls the creating of an event by the parsing of a byte array.
ByteParser() - Constructor for class org.jlab.coda.jevio.ByteParser
No-arg constructor.
bytesRemaining(int) - Method in class org.jlab.coda.jevio.BlockHeader
Gives the bytes remaining in this block (physical record) given a buffer position.
byteValue(Integer) - Method in class org.jlab.coda.jevio.BaseStructureHeader
Convenience method to return the byte value of an integer.

C

children() - Method in class org.jlab.coda.jevio.BaseStructure
Get an enumeration of all the children of this structure.
clearData(BaseStructure) - Method in class org.jlab.coda.jevio.EventBuilder
This clears all the data fields in a structure, but not the parent or the children.
close() - Method in class org.jlab.coda.jevio.EventWriter
Close the underlying data output stream, and with it the file.
close() - Method in class org.jlab.coda.jevio.EvioFile
This is equivalent to closing the file.
compareEventFiles(File, File) - Static method in class org.jlab.coda.jevio.EvioFile
Method used for diagnostics.
compareTo(EvioDictionaryEntry) - Method in class org.jlab.coda.jevio.EvioDictionaryEntry
We sort so that the entries with the most number of ancestors match.
completed(int, int) - Method in interface org.jlab.coda.jevio.IEvioProgressListener
Something is listenening for progress, e.g.
createNameProvider(File) - Static method in class org.jlab.coda.jevio.NameProviderFactory
Creates a NameProvider based on the file name.
createNameProvider(String) - Static method in class org.jlab.coda.jevio.NameProviderFactory
Creates a NameProvider based on the file name.

D

DataType - Enum in org.jlab.coda.jevio
This an enum used to convert data type numerical values to a more meaningful name.
Demo - Class in org.jlab.coda.jevio
Used for demoing the JEvio library.
Demo() - Constructor for class org.jlab.coda.jevio.Demo
 

E

ELEMENT_NAME - Static variable in class org.jlab.coda.jevio.EvioBank
The XML record tag for a segment.
ELEMENT_NAME - Static variable in class org.jlab.coda.jevio.EvioEvent
The XML record tag for an event.
ELEMENT_NAME - Static variable in class org.jlab.coda.jevio.EvioSegment
The XML record tag for a segment.
ELEMENT_NAME - Static variable in class org.jlab.coda.jevio.EvioTagSegment
The XML record tag for a tag segment.
Environment - Class in org.jlab.coda.jevio
This is a utility class employing a singleton to obtain environment information, such as user name, home directory, OS name, etc.
EventBuilder - Class in org.jlab.coda.jevio
This class is used for creating and manipulating events.
EventBuilder(int, DataType, int) - Constructor for class org.jlab.coda.jevio.EventBuilder
This is the constructor to use for an EventBuilder object that will operate on a new, empty event.
EventBuilder(EvioEvent) - Constructor for class org.jlab.coda.jevio.EventBuilder
This is the constructor to use when you want to manipulate an existing event.
EventParser - Class in org.jlab.coda.jevio
Uses the singleton pattern to create an object that controls the parsing of events.
EventParser() - Constructor for class org.jlab.coda.jevio.EventParser
 
EventWriter - Class in org.jlab.coda.jevio
An EventWriter object is used for writing events to a file.
EventWriter(File) - Constructor for class org.jlab.coda.jevio.EventWriter
Creates an event writer for writing to a file.
EventWriter(String) - Constructor for class org.jlab.coda.jevio.EventWriter
Creates an event writer for writing to a file.
EventWriter(File, int) - Constructor for class org.jlab.coda.jevio.EventWriter
Create an EventWriter for writing events to a file.
EventWriter(File, int, boolean) - Constructor for class org.jlab.coda.jevio.EventWriter
Create an EventWriter for writing events to a file.
EvioBank - Class in org.jlab.coda.jevio
This holds a CODA Bank structure.
EvioBank() - Constructor for class org.jlab.coda.jevio.EvioBank
Null constructor for a bank.
EvioBank(BankHeader) - Constructor for class org.jlab.coda.jevio.EvioBank
Constructor using a provided BankHeader
EvioBank(int, DataType, int) - Constructor for class org.jlab.coda.jevio.EvioBank
This is the general constructor to use for a Bank.
EvioBank(int, int, int) - Constructor for class org.jlab.coda.jevio.EvioBank
This is the general constructor to use for a Bank.
EvioDictionaryEntry - Class in org.jlab.coda.jevio
An entry into the evio dictionary.
EvioDictionaryEntry(String, String, String) - Constructor for class org.jlab.coda.jevio.EvioDictionaryEntry
Constructor.
EvioEvent - Class in org.jlab.coda.jevio
An event is really just the outer, primary bank.
EvioEvent() - Constructor for class org.jlab.coda.jevio.EvioEvent
Explicit null constructor for evio event.
EvioEvent(BankHeader) - Constructor for class org.jlab.coda.jevio.EvioEvent
Constructor using a provided BankHeader
EvioEvent(int, DataType, int) - Constructor for class org.jlab.coda.jevio.EvioEvent
This is a general constructor to use for an EvioEvent.
EvioEvent(int, int, int) - Constructor for class org.jlab.coda.jevio.EvioEvent
This is a general constructor to use for an EvioEvent.
EvioException - Exception in org.jlab.coda.jevio
This is a general exception used to indicate a problem in the Jevio package.
EvioException(String) - Constructor for exception org.jlab.coda.jevio.EvioException
Create an EVIO Exception indicating an error specific to the EVIO system.
EvioException(String, Throwable) - Constructor for exception org.jlab.coda.jevio.EvioException
Create an EVIO Exception with the specified message and cause.
EvioException(Throwable) - Constructor for exception org.jlab.coda.jevio.EvioException
Create an EVIO Exception with the specified cause.
EvioFile - Class in org.jlab.coda.jevio
This is the a class of interest to the user.
EvioFile(File) - Constructor for class org.jlab.coda.jevio.EvioFile
Creates an event file for reading.
EvioFile(String) - Constructor for class org.jlab.coda.jevio.EvioFile
Creates an event file.
EvioFile.ReadStatus - Enum in org.jlab.coda.jevio
This enum denotes the status of a read.
EvioFile.WriteStatus - Enum in org.jlab.coda.jevio
This enum denotes the status of a write.
SUCCESS indicates a successful write.
EvioFileTest - Class in org.jlab.coda.jevio
A set of static functions that test evio files.
EvioFileTest() - Constructor for class org.jlab.coda.jevio.EvioFileTest
 
EvioFileTest.TestResult - Enum in org.jlab.coda.jevio
This enum is used for file testing.
EvioSegment - Class in org.jlab.coda.jevio
This holds a CODA Segment structure.
EvioSegment() - Constructor for class org.jlab.coda.jevio.EvioSegment
Null constructor creates an empty SegmentHeader.
EvioSegment(SegmentHeader) - Constructor for class org.jlab.coda.jevio.EvioSegment
Constructor using a provided SegmentHeader
EvioSegment(int, DataType) - Constructor for class org.jlab.coda.jevio.EvioSegment
This is the general constructor to use for a Segment.
EvioSegment(int, int) - Constructor for class org.jlab.coda.jevio.EvioSegment
This is the general constructor to use for a Segment.
EvioTagSegment - Class in org.jlab.coda.jevio
This holds a CODA TagSegment structure.
EvioTagSegment() - Constructor for class org.jlab.coda.jevio.EvioTagSegment
Null constructor creates an empty TagSegmentHeader.
EvioTagSegment(TagSegmentHeader) - Constructor for class org.jlab.coda.jevio.EvioTagSegment
Constructor using a provided TagSegmentHeader
EvioTagSegment(int, DataType) - Constructor for class org.jlab.coda.jevio.EvioTagSegment
This is the general constructor to use for a TagSegment.
EvioTagSegment(int, int) - Constructor for class org.jlab.coda.jevio.EvioTagSegment
This is the general constructor to use for a TagSegment.
EvioXMLDictionary - Class in org.jlab.coda.jevio
This was developed to read the xml dictionary that Maurizio uses for GEMC.
EvioXMLDictionary(File) - Constructor for class org.jlab.coda.jevio.EvioXMLDictionary
Create an EvioXMLDictionary.
EvioXMLDictionary(String) - Constructor for class org.jlab.coda.jevio.EvioXMLDictionary
Create an EvioXMLDictionary.
EvioXMLDictionary(Document) - Constructor for class org.jlab.coda.jevio.EvioXMLDictionary
Create an EvioXMLDictionary.

F

fileSize() - Method in class org.jlab.coda.jevio.EvioFile
Obtain the file size using the memory mapped buffer's capacity, which should be the same.
firstEventStartingPosition() - Method in class org.jlab.coda.jevio.BlockHeader
Determines where the start of the first event (logical record) in this block (physical record) is located (in bytes).

G

getAllowsChildren() - Method in class org.jlab.coda.jevio.BaseStructure
Checks whether children are allowed.
getAsDoubleArray(byte[], ByteOrder) - Static method in class org.jlab.coda.jevio.ByteDataTransformer
Converts a byte array into a double array.
getAsFloatArray(byte[], ByteOrder) - Static method in class org.jlab.coda.jevio.ByteDataTransformer
Converts a byte array into a float array.
getAsIntArray(byte[], ByteOrder) - Static method in class org.jlab.coda.jevio.ByteDataTransformer
Converts a byte array into an int array.
getAsLongArray(byte[], ByteOrder) - Static method in class org.jlab.coda.jevio.ByteDataTransformer
Converts a byte array into a long array.
getAsShortArray(byte[], ByteOrder) - Static method in class org.jlab.coda.jevio.ByteDataTransformer
Converts a byte array into an short array.
getBufferStartingPosition() - Method in class org.jlab.coda.jevio.BlockHeader
Get the starting position in the buffer (in bytes) from which this header was read--if that happened.
This is not part of the block header proper.
getByteData() - Method in class org.jlab.coda.jevio.BaseStructure
This is a method from the IEvioStructure Interface.
getByteData() - Method in interface org.jlab.coda.jevio.IEvioStructure
Gets the raw data as an byte array, if the type as indicated by the header is appropriate.
getByteOrder() - Method in class org.jlab.coda.jevio.BaseStructure
What is the byte order of this data?
getChildAt(int) - Method in class org.jlab.coda.jevio.BaseStructure
Obtain the child at the given index.
getChildCount() - Method in class org.jlab.coda.jevio.BaseStructure
Get the count of the number of children.
getChildren() - Method in class org.jlab.coda.jevio.BaseStructure
Get the children of this structure.
getClassPath() - Method in class org.jlab.coda.jevio.Environment
Get the current class path.
getCurrentBlockHeader() - Method in class org.jlab.coda.jevio.EvioFile
This returns the current (active) block (physical record) header.
getCurrentWorkingDirectory() - Method in class org.jlab.coda.jevio.Environment
Get the current working directory.
getDataType() - Method in class org.jlab.coda.jevio.BaseStructureHeader
Get the data type for the structure.
getDataType(int) - Static method in enum org.jlab.coda.jevio.DataType
Obtain the enum from the value.
getDataTypeEnum() - Method in class org.jlab.coda.jevio.BaseStructureHeader
Returns the data type for data stored in this structure as a DataType enum.
getDataTypeName() - Method in class org.jlab.coda.jevio.BaseStructureHeader
Returns the data type as a string.
getDescription() - Method in class org.jlab.coda.jevio.BaseStructure
Get the description from the name provider (dictionary), if there is one.
getDescription() - Method in class org.jlab.coda.jevio.EvioDictionaryEntry
Get the nice, hopefully descriptive name for this entry.
getDescription() - Method in interface org.jlab.coda.jevio.IEvioStructure
Get the description from the name provider (dictionary), if there is one.
getDoubleData() - Method in class org.jlab.coda.jevio.BaseStructure
This is a method from the IEvioStructure Interface.
getDoubleData() - Method in interface org.jlab.coda.jevio.IEvioStructure
Gets the raw data as a double array, if the type as indicated by the header is appropriate.
getEnd() - Method in class org.jlab.coda.jevio.BlockHeader
Get the ending position of the block (physical record.) This is the number of valid words (header + data) in the block (physical record.) This is normally the same as the block size, except for the last block (physical record) in the file.
NOTE: for evio files, even if end < size (blocksize) for the last block (physical record), the data behind it will be padded with zeroes so that the file size is an integer multiple of the block size.
getEvent() - Method in class org.jlab.coda.jevio.EventBuilder
Get the underlying event.
getEventCount() - Method in class org.jlab.coda.jevio.BlockHeader
Get the number of events completely contained in the block.
getEventCount() - Method in class org.jlab.coda.jevio.EvioFile
This is the number of events in the file.
getEventNumber() - Method in class org.jlab.coda.jevio.EvioEvent
This returns a number [1..] indicating which event this was in the event file from which it was read.
getFloatData() - Method in class org.jlab.coda.jevio.BaseStructure
This is a method from the IEvioStructure Interface.
getFloatData() - Method in interface org.jlab.coda.jevio.IEvioStructure
Gets the raw data as a float array, if the type as indicated by the header is appropriate.
getHeader() - Method in class org.jlab.coda.jevio.BaseStructure
This is a method from the IEvioStructure Interface.
getHeader() - Method in interface org.jlab.coda.jevio.IEvioStructure
Returns the header for this structure
getHeaderLength() - Method in class org.jlab.coda.jevio.BankHeader
Get the length of the EvioBank's header in ints.
getHeaderLength() - Method in class org.jlab.coda.jevio.BaseStructureHeader
Get the length of the structure's header in ints.
getHeaderLength() - Method in class org.jlab.coda.jevio.BlockHeader
Get the block header length, in ints.
getHeaderLength() - Method in class org.jlab.coda.jevio.SegmentHeader
Get the length of the EvioSegment's header in ints.
getHeaderLength() - Method in class org.jlab.coda.jevio.TagSegmentHeader
Get the length of the EvioTagSegment's header in ints.
getHomeDirectory() - Method in class org.jlab.coda.jevio.Environment
Get the user's home directory.
getHostName() - Method in class org.jlab.coda.jevio.Environment
Get the host name.
getIndex(TreeNode) - Method in class org.jlab.coda.jevio.BaseStructure
Get the index of a node.
getInstance() - Static method in class org.jlab.coda.jevio.Environment
Accessor for the singleton.
getInstance() - Static method in class org.jlab.coda.jevio.EventParser
Returns the singleton EventParser object.
getIntData() - Method in class org.jlab.coda.jevio.BaseStructure
This is a method from the IEvioStructure Interface.
getIntData() - Method in interface org.jlab.coda.jevio.IEvioStructure
Gets the raw data as an integer array, if the type as indicated by the header is appropriate.
getLength() - Method in class org.jlab.coda.jevio.BaseStructureHeader
Get the length of the structure in ints, not counting the length word.
getLongData() - Method in class org.jlab.coda.jevio.BaseStructure
This is a method from the IEvioStructure Interface.
getLongData() - Method in interface org.jlab.coda.jevio.IEvioStructure
Gets the raw data as a long array, if the type as indicated by the header is appropriate.
getMagicNumber() - Method in class org.jlab.coda.jevio.BlockHeader
Get the magic number the block (physical record) header which should be 0xc0da0100.
getMappedByteBuffer() - Method in class org.jlab.coda.jevio.EvioFile
Get the memory mapped buffer corresponding to the event file.
getMatchingBanks(EvioEvent, int, int) - Static method in class org.jlab.coda.jevio.StructureFinder
Collect all the banks in an event that match a provided tag and number in their header.
getMatchingNonBanks(EvioEvent, int) - Static method in class org.jlab.coda.jevio.StructureFinder
Collect all the non-banks (i.e., Segments and TagSegments) in an event that match a provided tag in their header.
getMatchingStructures(IEvioFilter) - Method in class org.jlab.coda.jevio.EvioEvent
Visit all the descendant structures, and collect those that pass a filter.
getMatchingStructures(EvioEvent, IEvioFilter) - Static method in class org.jlab.coda.jevio.StructureFinder
Collect all the structures in an event that pass a filter.
getMatchingStructures(EvioEvent, int) - Static method in class org.jlab.coda.jevio.StructureFinder
Collect all the structures in an event that match a provided tag in their header.
getName(int) - Static method in enum org.jlab.coda.jevio.DataType
Obtain the name from the value.
getName(BaseStructure) - Method in class org.jlab.coda.jevio.EvioXMLDictionary
Returns the pretty name of some evio structure.
getName(BaseStructure) - Method in interface org.jlab.coda.jevio.INameProvider
Returns the pretty name of some evio structure.
getName(BaseStructure) - Static method in class org.jlab.coda.jevio.NameProvider
Returns the pretty name of some evio structure.
getName(int) - Static method in enum org.jlab.coda.jevio.StructureType
Obtain the name from the value.
getNumber() - Method in class org.jlab.coda.jevio.BaseStructureHeader
Get the number.
getNumber() - Method in class org.jlab.coda.jevio.BlockHeader
Get the block number for this block (physical record).
getOsName() - Method in class org.jlab.coda.jevio.Environment
Get the operating system name.
getParent() - Method in class org.jlab.coda.jevio.BaseStructure
Get the parent of this structure.
getRawBytes() - Method in class org.jlab.coda.jevio.BaseStructure
Get the raw data of the structure.
getReserved1() - Method in class org.jlab.coda.jevio.BlockHeader
Get the first reserved word in the block (physical record) header.
getShortData() - Method in class org.jlab.coda.jevio.BaseStructure
This is a method from the IEvioStructure Interface.
getShortData() - Method in interface org.jlab.coda.jevio.IEvioStructure
Gets the raw data as a short array, if the type as indicated by the header is appropriate.
getSize() - Method in class org.jlab.coda.jevio.BlockHeader
Get the size of the block (physical record).
getStart() - Method in class org.jlab.coda.jevio.BlockHeader
Get the starting position of the block (physical record.).
getStringData() - Method in class org.jlab.coda.jevio.BaseStructure
This is a method from the IEvioStructure Interface.
getStringData() - Method in interface org.jlab.coda.jevio.IEvioStructure
Gets the raw data as a String, if the type as indicated by the header is appropriate.
getStructureType() - Method in class org.jlab.coda.jevio.BaseStructure
A convenience method use instead of "instanceof" to see what type of structure we have.
getStructureType() - Method in class org.jlab.coda.jevio.EvioBank
This implements the abstract method from BaseStructure.
getStructureType() - Method in class org.jlab.coda.jevio.EvioSegment
This implements the abstract method from BaseStructure.
getStructureType() - Method in class org.jlab.coda.jevio.EvioTagSegment
This implements the abstract method from BaseStructure.
getStructureType() - Method in interface org.jlab.coda.jevio.IEvioStructure
Return the StructureType for this structure.
getStructureType(int) - Static method in enum org.jlab.coda.jevio.StructureType
Obtain the enum from the value.
getTag() - Method in class org.jlab.coda.jevio.BaseStructureHeader
Get the structure tag.
getTempDirectory() - Method in class org.jlab.coda.jevio.Environment
Get the temp directory.
getTotalBytes() - Method in class org.jlab.coda.jevio.BaseStructure
Get the length of this structure in bytes, including the header.
getTreeModel() - Method in class org.jlab.coda.jevio.EvioEvent
Get the tree model representing this event.
getUserName() - Method in class org.jlab.coda.jevio.Environment
Get the user name.
getValue() - Method in enum org.jlab.coda.jevio.DataType
Get the enum's value.
getValue() - Method in enum org.jlab.coda.jevio.StructureType
Get the enum's value.
getVersion() - Method in class org.jlab.coda.jevio.BlockHeader
Get the evio version of the block (physical record) header.
getXMLElementName() - Method in class org.jlab.coda.jevio.BaseStructure
Get the element name for the structure for writing to XML.
getXMLElementName() - Method in class org.jlab.coda.jevio.EvioBank
Get the element name for the bank for writing to XML.
getXMLElementName() - Method in class org.jlab.coda.jevio.EvioEvent
Get the element name for the bank for writing to XML.
getXMLElementName() - Method in class org.jlab.coda.jevio.EvioSegment
Get the element name for the bank for writing to XML.
getXMLElementName() - Method in class org.jlab.coda.jevio.EvioTagSegment
Get the element name for the bank for writing to XML.
gotoEventNumber(int) - Method in class org.jlab.coda.jevio.EvioFile
Go to a specific event in the file.
gotStructure(EvioEvent, IEvioStructure) - Method in class org.jlab.coda.jevio.Demo
This IEvioListener has received a structure as the result of an event being parsed.
gotStructure(EvioEvent, IEvioStructure) - Method in interface org.jlab.coda.jevio.IEvioListener
Called when a structure is read while parsing an event.

I

IEvioFilter - Interface in org.jlab.coda.jevio
This interface allows applications to create filters so that they only recieve certain structures when events are being processed.
IEvioListener - Interface in org.jlab.coda.jevio
In SAX like behavior, implementors will listen for structures encountered when an event is parsed.
IEvioProgressListener - Interface in org.jlab.coda.jevio
 
IEvioStructure - Interface in org.jlab.coda.jevio
This interface is implemented by classes representing the basic evio structures: banks, segments, and tagsegments.
IEvioWriter - Interface in org.jlab.coda.jevio
This is implemented by objects that will be writing themselve's to en evio file.
INameProvider - Interface in org.jlab.coda.jevio
This interface must be implemented by dictionary readers.
insert(MutableTreeNode, int) - Method in class org.jlab.coda.jevio.BaseStructure
Add a child at the given index.
insert(MutableTreeNode) - Method in class org.jlab.coda.jevio.BaseStructure
Convenience method to add a child at the end of the child list.
insert(BaseStructure, BaseStructure) - Method in class org.jlab.coda.jevio.EvioEvent
Inserts a child structure into the event's JTree.
intToBytes(int, byte[], int) - Static method in class org.jlab.coda.jevio.ByteDataTransformer
Copies an integer value into 4 bytes of a byte array.
isContainer() - Method in class org.jlab.coda.jevio.BaseStructure
Checks whether this structure is a container, i.e.
isLeaf() - Method in class org.jlab.coda.jevio.BaseStructure
Checks whether this is a leaf.
isNotificationActive() - Method in class org.jlab.coda.jevio.ByteParser
Get the flag determining whether notification of listeners is active.
isNotificationActive() - Method in class org.jlab.coda.jevio.EventParser
Get the flag determining whether notification of listeners is active.
isStructure() - Method in enum org.jlab.coda.jevio.DataType
Convenience routine to see if "this" data type is a structure (a container.)
isSwap() - Method in class org.jlab.coda.jevio.BaseStructure
Is a byte swap required? Since this is java, code is big endian.

M

MAGIC_NUMBER - Static variable in class org.jlab.coda.jevio.BlockHeader
The magic number, should be the value of magicNumber.
main(String[]) - Static method in class org.jlab.coda.jevio.Demo
Main program for testing
main(String[]) - Static method in class org.jlab.coda.jevio.Environment
Main program used for testing only.
main(String[]) - Static method in class org.jlab.coda.jevio.EventBuilder
Main program for testing.
main(String[]) - Static method in class org.jlab.coda.jevio.EventWriter
Main program for testing.
main(String[]) - Static method in class org.jlab.coda.jevio.EvioFile
For testing only
main(String[]) - Static method in class org.jlab.coda.jevio.Test
Run as a stand-alone application.
match(BaseStructure) - Method in class org.jlab.coda.jevio.EvioDictionaryEntry
Checks if a structure matches this dictionary entry.
MAX_BLOCK_SIZE - Static variable in class org.jlab.coda.jevio.BlockHeader
The maximum block size in 32 bit ints in this (version 2) implementation of evio.

N

NameProvider - Class in org.jlab.coda.jevio
This class maintains the single global NameProvider.
NameProviderFactory - Class in org.jlab.coda.jevio
A Factory class for generating an appropriate INameProvider.
NameProviderFactory() - Constructor for class org.jlab.coda.jevio.NameProviderFactory
 
nextBufferStartingPosition() - Method in class org.jlab.coda.jevio.BlockHeader
Determines where the start of the next block (physical record) header in some buffer is located (in bytes).
nextEvent() - Method in class org.jlab.coda.jevio.EvioFile
Get the next event in the file.
NO_NAME_STRING - Static variable in class org.jlab.coda.jevio.NameProvider
A string used to indicate that no name can be determined.

O

org.jlab.coda.jevio - package org.jlab.coda.jevio
 

P

parseEvent(byte[], ByteOrder) - Method in class org.jlab.coda.jevio.ByteParser
This is the workhorse method for parsing the byte array.
parseEvent(ByteBuffer) - Method in class org.jlab.coda.jevio.ByteParser
This is the workhorse method for parsing the byte buffer.
parseEvent(EvioEvent) - Method in class org.jlab.coda.jevio.EventParser
This is the workhorse method for parsing the event.
parseEvent(EvioEvent) - Method in class org.jlab.coda.jevio.EvioFile
This will parse an event, SAX-like.
parseEventsTest(EvioFile, int) - Static method in class org.jlab.coda.jevio.EvioFileTest
Tests whether we can parse events from the file.
parseNextEvent() - Method in class org.jlab.coda.jevio.EvioFile
This is the workhorse method.
position() - Method in class org.jlab.coda.jevio.EvioFile
This is equivalent to obtaining the current position in the file.
position(int) - Method in class org.jlab.coda.jevio.EvioFile
This is equivalent to setting the current position in the file.

R

readAllBlockHeadersTest(EvioFile) - Static method in class org.jlab.coda.jevio.EvioFileTest
Tests whether we can look through the file and find all the block headers.
readAllEventsTest(EvioFile) - Static method in class org.jlab.coda.jevio.EvioFileTest
Tests whether we can look through the file read all the events.
readEvent(DataInputStream, ByteOrder) - Method in class org.jlab.coda.jevio.ByteParser
This is a method for reading data over a DataInputStream and parsing it into an EvioEvent.
remove(int) - Method in class org.jlab.coda.jevio.BaseStructure
Removes the child at index from the receiver.
remove(MutableTreeNode) - Method in class org.jlab.coda.jevio.BaseStructure
Removes the child.
remove(BaseStructure) - Method in class org.jlab.coda.jevio.EventBuilder
This removes a structure (and all its descendants) from the tree.
removeEvioListener(IEvioListener) - Method in class org.jlab.coda.jevio.ByteParser
Remove an Evio listener.
removeEvioListener(IEvioListener) - Method in class org.jlab.coda.jevio.EventParser
Remove an Evio listener.
removeFromParent() - Method in class org.jlab.coda.jevio.BaseStructure
Remove this node from its parent.
rewind() - Method in class org.jlab.coda.jevio.EvioFile
The equivalent of rewinding the file.
run() - Method in class org.jlab.coda.jevio.Test
This method is executed as a thread.

S

SegmentHeader - Class in org.jlab.coda.jevio
This the the header for an evio segment structure (EvioSegment).
SegmentHeader() - Constructor for class org.jlab.coda.jevio.SegmentHeader
Null constructor.
SegmentHeader(int, DataType) - Constructor for class org.jlab.coda.jevio.SegmentHeader
Constructor.
SegmentHeader(int, int) - Constructor for class org.jlab.coda.jevio.SegmentHeader
Constructor.
setAllHeaderLengths() - Method in class org.jlab.coda.jevio.BaseStructure
Compute the and set length of all header fields for this structure and all its descendants.
setAllHeaderLengths() - Method in class org.jlab.coda.jevio.EventBuilder
This goes through the event recursively, and makes sure all the length fields in the headers are properly set.
setBufferStartingPosition(int) - Method in class org.jlab.coda.jevio.BlockHeader
Set the starting position in the buffer (in bytes) from which this header was read--if that happened.
This is not part of the block header proper.
setByteOrder(ByteOrder) - Method in class org.jlab.coda.jevio.BaseStructure
Set the byte order of this data.
setDataType(int) - Method in class org.jlab.coda.jevio.BaseStructureHeader
Set the numeric data type for the structure.
setEnd(int) - Method in class org.jlab.coda.jevio.BlockHeader
Set the ending position of the block (physical record.) This is the number of valid words (header + data) in the block (physical record.) This is normally the same as the block size, except for the last block (physical record) in the file.
setEvent(EvioEvent) - Method in class org.jlab.coda.jevio.EventBuilder
Set the underlying event.
setEventCount(int) - Method in class org.jlab.coda.jevio.BlockHeader
Set the number of events completely contained in the block.
setEventNumber(int) - Method in class org.jlab.coda.jevio.EvioEvent
This sets a number [1..] indicating which event this was in the event file from which it was read.
setEvioFilter(IEvioFilter) - Method in class org.jlab.coda.jevio.ByteParser
Set the global filter used for filtering structures.
setEvioFilter(IEvioFilter) - Method in class org.jlab.coda.jevio.EventParser
Set the global filter used for filtering structures.
setHeaderLength(int) - Method in class org.jlab.coda.jevio.BlockHeader
Set the block header length, in ints.
setLength(int) - Method in class org.jlab.coda.jevio.BaseStructureHeader
Set the length of the structure in ints, not counting the length word.
setMagicNumber(int) - Method in class org.jlab.coda.jevio.BlockHeader
Sets the value of magicNumber.
setNotificationActive(boolean) - Method in class org.jlab.coda.jevio.ByteParser
Set the flag determining whether notification of listeners is active.
setNotificationActive(boolean) - Method in class org.jlab.coda.jevio.EventParser
Set the flag determining whether notification of listeners is active.
setNumber(int) - Method in class org.jlab.coda.jevio.BaseStructureHeader
Set the number.
setNumber(int) - Method in class org.jlab.coda.jevio.BlockHeader
Set the block number for this block (physical record).
setParent(MutableTreeNode) - Method in class org.jlab.coda.jevio.BaseStructure
Set the parent for this node.
setProvider(INameProvider) - Static method in class org.jlab.coda.jevio.NameProvider
Sets the one global (singleton) name provider.
setRawBytes(byte[]) - Method in class org.jlab.coda.jevio.BaseStructure
Set the data for the structure.
setReserved1(int) - Method in class org.jlab.coda.jevio.BlockHeader
Sets the value of reserved 1.
setSize(int) - Method in class org.jlab.coda.jevio.BlockHeader
Set the size of the block (physical record).
setStart(int) - Method in class org.jlab.coda.jevio.BlockHeader
Set the starting position of the block (physical record.).
setTag(int) - Method in class org.jlab.coda.jevio.BaseStructureHeader
Set the structure tag.
setUserObject(Object) - Method in class org.jlab.coda.jevio.BaseStructure
This method is not relevant for this implementation.
setVersion(int) - Method in class org.jlab.coda.jevio.BlockHeader
Sets the evio version.
shortValue(Integer) - Method in class org.jlab.coda.jevio.BaseStructureHeader
Convenience method to return the short value of an integer.
StructureFinder - Class in org.jlab.coda.jevio
This is a set of convenient static methods used to find lists of structures within an event that match certain criteria.
StructureFinder() - Constructor for class org.jlab.coda.jevio.StructureFinder
 
StructureType - Enum in org.jlab.coda.jevio
This an enum used to convert structure type numerical values to a more meaningful name.
swap(ByteBuffer, ByteBuffer) - Static method in class org.jlab.coda.jevio.ByteDataTransformer
Swaps evio format data (event or bank) contained in a ByteBuffer.

T

TagSegmentHeader - Class in org.jlab.coda.jevio
This the the header for an evio tag segment structure (EvioTagSegment).
TagSegmentHeader() - Constructor for class org.jlab.coda.jevio.TagSegmentHeader
Null constructor.
TagSegmentHeader(int, DataType) - Constructor for class org.jlab.coda.jevio.TagSegmentHeader
Constructor.
TagSegmentHeader(int, int) - Constructor for class org.jlab.coda.jevio.TagSegmentHeader
Constructor.
Test - Class in org.jlab.coda.jevio
This is an example class which creates a cMsg message producer of evio events.
toString() - Method in class org.jlab.coda.jevio.BankHeader
Obtain a string representation of the bank header.
toString() - Method in class org.jlab.coda.jevio.BaseStructure
Obtain a string representation of the structure.
toString() - Method in class org.jlab.coda.jevio.BaseStructureHeader
Obtain a string representation of the structure header.
toString() - Method in class org.jlab.coda.jevio.BlockHeader
Obtain a string representation of the block (physical record) header.
toString() - Method in class org.jlab.coda.jevio.Environment
Convert to a string for diagnostics
toString() - Method in class org.jlab.coda.jevio.EvioDictionaryEntry
Get a string representation of this entry.
toString() - Method in class org.jlab.coda.jevio.EvioEvent
Create a string representation of the event.
toString() - Method in class org.jlab.coda.jevio.EvioXMLDictionary
Get a string representation of the dictionary.
toString() - Method in class org.jlab.coda.jevio.SegmentHeader
Obtain a string representation of the bank header.
toString() - Method in class org.jlab.coda.jevio.TagSegmentHeader
Obtain a string representation of the bank header.
totalBlockCount(EvioFile) - Static method in class org.jlab.coda.jevio.EvioFileTest
Get a total count of the number of physical records.
toXML(XMLStreamWriter) - Method in class org.jlab.coda.jevio.BaseStructure
This is a method that must be filled in by subclasses.
toXML(XMLStreamWriter) - Method in class org.jlab.coda.jevio.EvioBank
Write this bank structure out as an XML record.
toXML(XMLStreamWriter) - Method in class org.jlab.coda.jevio.EvioEvent
Write this event structure out as an XML record.
toXML(XMLStreamWriter) - Method in class org.jlab.coda.jevio.EvioSegment
Write this segment structure out as an XML record.
toXML(XMLStreamWriter) - Method in class org.jlab.coda.jevio.EvioTagSegment
Write this tag segment structure out as an XML record.
toXMLFile(String) - Method in class org.jlab.coda.jevio.EvioFile
Rewrite the entire file to XML.
toXMLFile(String, IEvioProgressListener) - Method in class org.jlab.coda.jevio.EvioFile
Rewrite the entire file to XML.

V

valueOf(String) - Static method in enum org.jlab.coda.jevio.DataType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.jlab.coda.jevio.EvioFile.ReadStatus
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.jlab.coda.jevio.EvioFile.WriteStatus
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.jlab.coda.jevio.EvioFileTest.TestResult
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.jlab.coda.jevio.StructureType
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.jlab.coda.jevio.DataType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.jlab.coda.jevio.EvioFile.ReadStatus
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.jlab.coda.jevio.EvioFile.WriteStatus
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.jlab.coda.jevio.EvioFileTest.TestResult
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.jlab.coda.jevio.StructureType
Returns an array containing the constants of this enum type, in the order they are declared.
vistAllStructures(IEvioListener) - Method in class org.jlab.coda.jevio.EvioEvent
Visit all the structures in this event (including the event itself--which is considered its own descendant).
vistAllStructures(IEvioListener, IEvioFilter) - Method in class org.jlab.coda.jevio.EvioEvent
Visit all the structures in this event (including the event itself--which is considered its own descendant) in a depth first manner.

W

write(ByteBuffer) - Method in class org.jlab.coda.jevio.BankHeader
Write myself out a byte buffer.
write(ByteBuffer) - Method in class org.jlab.coda.jevio.BaseStructure
Write myself out a byte buffer.
write(ByteBuffer) - Method in class org.jlab.coda.jevio.BlockHeader
Write myself out a byte buffer.
write(ByteBuffer) - Method in interface org.jlab.coda.jevio.IEvioWriter
Write myself out a byte buffer.
write(ByteBuffer) - Method in class org.jlab.coda.jevio.SegmentHeader
Write myself out a byte buffer.
write(ByteBuffer) - Method in class org.jlab.coda.jevio.TagSegmentHeader
Write myself out a byte buffer.
writeEvent(EvioBank, int) - Method in class org.jlab.coda.jevio.EventWriter
Write a to the file.
writeEvent(EvioBank) - Method in class org.jlab.coda.jevio.EventWriter
Write a bank to the file in evio version 2 format.

A B C D E F G I M N O P R S T V W