org.jlab.coda.jevio

Class EvioBank

java.lang.Object

org.jlab.coda.jevio.BaseStructure

org.jlab.coda.jevio.EvioBank

All Implemented Interfaces:

java.lang.Cloneable, javax.swing.tree.MutableTreeNode, javax.swing.tree.TreeNode, IEvioStructure, IEvioWriter

Direct Known Subclasses:

EvioEvent

public class EvioBank
extends BaseStructure
implements java.lang.Cloneable

This holds a CODA Bank structure. Mostly it has a header (a BankHeader) and the raw data stored as an byte array.

Author:

heddle

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.Object	attachment For general convenience, allow an object to be attached to an evio bank.
static java.lang.String	ELEMENT_NAME The XML record tag for a segment.

Fields inherited from class org.jlab.coda.jevio.BaseStructure

badStringFormat, byteOrder, charData, children, compositeData, doubleData, floatData, header, intData, isLeaf, lengthsUpToDate, longData, numberDataItems, rawBytes, shortData, stringData, stringEnd, stringsList, xmlContentAttributeName, xmlElementName, xmlIndent

Constructor Summary

Constructors

Constructor and Description
EvioBank() Null constructor for a bank.
EvioBank(BankHeader bankHeader) Constructor using a provided BankHeader
EvioBank(int tag, DataType dataType, int num) This is the general constructor to use for a Bank.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone() Deep clone of BaseStructure does all of the work for us.
java.lang.Object	getAttachment() Get the attached object.
StructureType	getStructureType() This implements the abstract method from BaseStructure.
java.lang.String	getXMLElementName() Get the element name for the bank for writing to XML.
void	setAttachment(java.lang.Object attachment) Set the attached object.
(package private) byte[]	toArray() Write myself out as a byte array of evio format data in the byte order given by BaseStructure.getByteOrder().
void	toXML(javax.xml.stream.XMLStreamWriter xmlWriter) Write this bank structure out as an XML record.
void	toXML(javax.xml.stream.XMLStreamWriter xmlWriter, boolean hex) Write this bank structure out as an XML record.

Methods inherited from class org.jlab.coda.jevio.BaseStructure

appendByteData, appendByteData, appendCompositeData, appendDoubleData, appendDoubleData, appendFloatData, appendFloatData, appendIntData, appendIntData, appendLongData, appendLongData, appendShortData, appendShortData, appendStringData, appendStringData, children, childrenToXML, commonXMLClose, commonXMLDataWrite, commonXMLStart, dataLength, decreaseXmlIndent, getAllowsChildren, getByteData, getByteOrder, getChildAt, getChildCount, getChildren, getChildrenList, getCompositeData, getDescription, getDoubleData, getFloatData, getHeader, getIndex, getIntData, getLongData, getMatchingStructures, getNumberDataItems, getParent, getRawBytes, getShortData, getStringData, getTotalBytes, increaseXmlIndent, insert, insert, isContainer, isLeaf, isSwap, lengthsUpToDate, lengthsUpToDate, remove, remove, removeFromParent, setAllHeaderLengths, setByteData, setByteData, setByteOrder, setCompositeData, setDoubleData, setDoubleData, setFloatData, setFloatData, setIntData, setIntData, setLongData, setLongData, setParent, setRawBytes, setShortData, setShortData, setStringData, setUserObject, setXmlIndent, setXmlNames, stringsToRawBytes, stringsToRawSize, toString, toXML, toXML, transform, unpackRawBytesToStrings, unpackRawBytesToStrings, unpackRawBytesToStrings, visitAllStructures, visitAllStructures, write

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

ELEMENT_NAME

public static final java.lang.String ELEMENT_NAME

The XML record tag for a segment.

See Also:

Constant Field Values

attachment

protected transient java.lang.Object attachment

For general convenience, allow an object to be attached to an evio bank.

Constructor Detail

EvioBank

public EvioBank()

Null constructor for a bank.

EvioBank

public EvioBank(BankHeader bankHeader)

Constructor using a provided BankHeader

Parameters:

bankHeader - the header to use.

See Also:

BankHeader

EvioBank

public EvioBank(int tag,
                DataType dataType,
                int num)

This is the general constructor to use for a Bank.

Parameters:

tag - the tag for the bank header.

dataType - the (enum) data type for the content of the bank.

num - sometimes, but not necessarily, an ordinal enumeration.

Method Detail

getAttachment

public java.lang.Object getAttachment()

Get the attached object.

Returns:

the attached object

setAttachment

public void setAttachment(java.lang.Object attachment)

Set the attached object.

Parameters:

attachment - object to attach to this bank

getStructureType

public StructureType getStructureType()

This implements the abstract method from BaseStructure. It is a convenience method use instead of "instanceof" to see what type of structure we have. Note: this returns the type of this structure, not the type of data this structure holds.

Specified by:

getStructureType in interface IEvioStructure

Specified by:

getStructureType in class BaseStructure

Returns:

the StructureType of this structure, which is a StructureType.BANK.

See Also:

StructureType

toXML

public void toXML(javax.xml.stream.XMLStreamWriter xmlWriter)

Write this bank structure out as an XML record. Integers written in decimal.

Specified by:

toXML in class BaseStructure

Parameters:

xmlWriter - the writer used to write the events.

toXML

public void toXML(javax.xml.stream.XMLStreamWriter xmlWriter,
                  boolean hex)

Write this bank structure out as an XML record.

Specified by:

toXML in class BaseStructure

Parameters:

xmlWriter - the writer used to write the events.

hex - if true, ints get displayed in hexadecimal

getXMLElementName

public java.lang.String getXMLElementName()

Get the element name for the bank for writing to XML.

Specified by:

getXMLElementName in class BaseStructure

Returns:

the element name for the structure for writing to XML.

toArray

byte[] toArray()

Write myself out as a byte array of evio format data in the byte order given by BaseStructure.getByteOrder(). This method is much more efficient than using BaseStructure.write(java.nio.ByteBuffer).

However, be warned that this method is only useful when a bank has just been read from a file or buffer. Once the user adds data or children to the bank, this method does NOT produce correct results.

Returns:

byte array containing evio format data of this bank in currently set byte order

clone

public java.lang.Object clone()

Deep clone of BaseStructure does all of the work for us.

Overrides:

clone in class BaseStructure