public class EvioBank extends BaseStructure implements java.lang.Cloneable
BankHeader
) and the raw data stored as an
byte array.Modifier and Type | Field and Description |
---|---|
static java.lang.String |
ELEMENT_NAME
The XML record tag for a segment.
|
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.
|
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.
|
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.
|
appendByteData, appendByteData, appendCompositeData, appendDoubleData, appendDoubleData, appendFloatData, appendFloatData, appendIntData, appendIntData, appendLongData, appendLongData, appendShortData, appendShortData, appendStringData, appendStringData, children, getAllowsChildren, getByteData, getByteOrder, getChildAt, getChildCount, getChildren, getChildrenList, getCompositeData, getDescription, getDoubleData, getFloatData, getHeader, getIndex, getIntData, getLongData, getMatchingStructures, getNumberDataItems, getParent, getRawBytes, getShortData, getStringData, getTotalBytes, insert, insert, isContainer, isLeaf, isSwap, remove, remove, removeFromParent, setAllHeaderLengths, setByteData, setByteData, setByteOrder, setCompositeData, setDoubleData, setDoubleData, setFloatData, setFloatData, setIntData, setIntData, setLongData, setLongData, setParent, setRawBytes, setShortData, setShortData, setStringData, setUserObject, stringsToRawBytes, stringsToRawSize, toString, toXML, toXML, transform, unpackRawBytesToStrings, unpackRawBytesToStrings, unpackRawBytesToStrings, vistAllStructures, vistAllStructures, write
public static final java.lang.String ELEMENT_NAME
public EvioBank()
public EvioBank(BankHeader bankHeader)
bankHeader
- the header to use.BankHeader
public EvioBank(int tag, DataType dataType, int num)
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.public java.lang.Object getAttachment()
public void setAttachment(java.lang.Object attachment)
attachment
- object to attach to this bankpublic StructureType getStructureType()
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.getStructureType
in interface IEvioStructure
getStructureType
in class BaseStructure
StructureType
of this structure, which is a StructureType.BANK.StructureType
public void toXML(javax.xml.stream.XMLStreamWriter xmlWriter)
toXML
in class BaseStructure
xmlWriter
- the writer used to write the events.public void toXML(javax.xml.stream.XMLStreamWriter xmlWriter, boolean hex)
toXML
in class BaseStructure
xmlWriter
- the writer used to write the events.hex
- if true, ints get displayed in hexadecimalpublic java.lang.String getXMLElementName()
getXMLElementName
in class BaseStructure
public java.lang.Object clone()
clone
in class BaseStructure