public class EvioEvent extends EvioBank
EvioEvent
class, for clarity.Modifier and Type | Field and Description |
---|---|
static java.lang.String |
ELEMENT_NAME
The XML record tag for an event.
|
Constructor and Description |
---|
EvioEvent()
Explicit null constructor for evio event.
|
EvioEvent(BankHeader bankHeader)
Constructor using a provided BankHeader.
|
EvioEvent(int tag,
DataType dataType,
int num)
This is a general constructor to use for an EvioEvent.
|
Modifier and Type | Method and Description |
---|---|
java.lang.Object |
clone()
Deep clone of BaseStructure does most of the work.
|
java.lang.String |
getDictionaryXML()
Get the XML dictionary associated with this event if there is one.
|
int |
getEventNumber()
This returns a number [1..] indicating which event this was in the event file from which
it was read.
|
javax.swing.tree.DefaultTreeModel |
getTreeModel()
Get the tree model representing this event.
|
java.lang.String |
getXMLElementName()
Get the element name for the bank for writing to XML.
|
boolean |
hasDictionaryXML()
Is there an XML dictionary associated with this event?
|
void |
insert(BaseStructure child,
BaseStructure parent)
Inserts a child structure into the event's JTree.
|
void |
setDictionaryXML(java.lang.String dictionaryXML)
Set the XML dictionary associated with this event.
|
void |
setEventNumber(int eventNumber)
This sets a number [1..] indicating which event this was in the event file from which
it was read.
|
java.lang.String |
toString()
Obtain a string representation of the event.
|
void |
toXML(javax.xml.stream.XMLStreamWriter xmlWriter)
Write this event structure out as an XML record.
|
getAttachment, getStructureType, setAttachment
appendByteData, appendByteData, appendCompositeData, appendDoubleData, appendDoubleData, appendFloatData, appendFloatData, appendIntData, appendIntData, appendLongData, appendLongData, appendShortData, appendShortData, appendStringData, children, getAllowsChildren, getByteData, getByteOrder, getChildAt, getChildCount, getChildren, getCompositeData, getDescription, getDoubleData, getFloatData, getHeader, getIndex, getIntData, getLongData, getMatchingStructures, getNumberDataItems, getParent, getRawBytes, getShortData, getStringData, getTotalBytes, insert, insert, isContainer, isLeaf, isSwap, remove, remove, removeFromParent, setAllHeaderLengths, setAllHeaderLengthsSemiOrig, setByteData, setByteData, setByteOrder, setCompositeData, setDoubleData, setDoubleData, setFloatData, setFloatData, setIntData, setIntData, setLongData, setLongData, setParent, setRawBytes, setShortData, setShortData, setStringData, setUserObject, stringsToRawBytes, stringsToRawSize, toXML, transform, unpackRawBytesToStrings, unpackRawBytesToStrings, vistAllStructures, vistAllStructures, write
public static final java.lang.String ELEMENT_NAME
public EvioEvent()
public EvioEvent(BankHeader bankHeader)
bankHeader
- the header to use.BankHeader
public EvioEvent(int tag, DataType dataType, int num)
tag
- the tag for the event header (which is just a 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 clone()
public boolean hasDictionaryXML()
true
if there is an XML dictionary associated with this event,
else false
public java.lang.String getDictionaryXML()
public void setDictionaryXML(java.lang.String dictionaryXML)
dictionaryXML
- the XML dictionary associated with this event.public java.lang.String toString()
toString
in class BaseStructure
public javax.swing.tree.DefaultTreeModel getTreeModel()
public void insert(BaseStructure child, BaseStructure parent)
child
- the child structure being added to the tree.parent
- the parent structure of the new child.public int getEventNumber()
public void setEventNumber(int eventNumber)
eventNumber
- a number [1..] indicating which event this was in the event file from which
it was read.public void toXML(javax.xml.stream.XMLStreamWriter xmlWriter)
public java.lang.String getXMLElementName()
getXMLElementName
in class EvioBank