org.jlab.coda.jevio

Class EvioSegment

java.lang.Object

org.jlab.coda.jevio.BaseStructure

org.jlab.coda.jevio.EvioSegment

All Implemented Interfaces:

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

public class EvioSegment
extends BaseStructure

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

Author:

heddle

Field Summary

Fields

Modifier and Type	Field and Description
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
EvioSegment() Null constructor creates an empty SegmentHeader.
EvioSegment(int tag, DataType dataType) This is the general constructor to use for a Segment.
EvioSegment(SegmentHeader segmentHeader) Constructor using a provided SegmentHeader

Method Summary

Modifier and Type	Method and Description
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	toXML(javax.xml.stream.XMLStreamWriter xmlWriter) Write this segment structure out as an XML record.
void	toXML(javax.xml.stream.XMLStreamWriter xmlWriter, boolean hex) Write this segment 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, clone, 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, vistAllStructures, vistAllStructures, 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

Constructor Detail

EvioSegment

public EvioSegment()

Null constructor creates an empty SegmentHeader.

See Also:

SegmentHeader

EvioSegment

public EvioSegment(SegmentHeader segmentHeader)

Constructor using a provided SegmentHeader

Parameters:

segmentHeader - the header to use.

See Also:

SegmentHeader

EvioSegment

public EvioSegment(int tag,
                   DataType dataType)

This is the general constructor to use for a Segment.

Parameters:

tag - the tag for the segment header.

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

Method Detail

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.SEGMENT.

See Also:

StructureType

toXML

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

Write this segment 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 segment 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.