org.jlab.coda.jevio

Class EvioDictionaryEntry

java.lang.Object

org.jlab.coda.jevio.EvioDictionaryEntry

public class EvioDictionaryEntry
extends java.lang.Object

Class to facilitate use of Evio XML dictionary entry data as a key or value in a hash table. Objects can only be instantiated by classes in this package. (8/17/15).

Author:

timmer.

Constructor Summary

Constructors

Constructor and Description
EvioDictionaryEntry(java.lang.Integer tag) Constructor.
EvioDictionaryEntry(java.lang.Integer tag, java.lang.Integer num) Constructor.
EvioDictionaryEntry(java.lang.Integer tag, java.lang.Integer num, java.lang.Integer tagEnd, java.lang.String type) Constructor.
EvioDictionaryEntry(java.lang.Integer tag, java.lang.Integer num, java.lang.Integer tagEnd, java.lang.String type, java.lang.String description, java.lang.String format) Constructor containing actual implementation.
EvioDictionaryEntry(java.lang.Integer tag, java.lang.Integer num, java.lang.Integer tagEnd, java.lang.String type, java.lang.String description, java.lang.String format, EvioDictionaryEntry parentEntry) Constructor containing actual implementation.
EvioDictionaryEntry(java.lang.Integer tag, java.lang.Integer num, java.lang.String type) Constructor.
EvioDictionaryEntry(java.lang.Integer tag, java.lang.Integer num, java.lang.String type, java.lang.String description, java.lang.String format) Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object other)
java.lang.String	getDescription() Get the CompositeData's description.
EvioDictionaryEntryType	getEntryType() Get this entry's type.
java.lang.String	getFormat() Get the CompositeData's format.
java.lang.Integer	getNum() Get the num value.
EvioDictionaryEntry	getParentEntry() Get the parent container's dictionary entry.
java.lang.Integer	getTag() Get the tag value.
java.lang.Integer	getTagEnd() Get the tagEnd value (upper end of a tag range).
DataType	getType() Get the data's type.
int	hashCode() .
boolean	inRange(EvioDictionaryEntry entry) Is the given dictionary entry's tag within the specified range (inclusive) of this dictionary entry?
boolean	inRange(int tagArg) Is the given tag within the specified range (inclusive) of this dictionary entry?
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

EvioDictionaryEntry

EvioDictionaryEntry(java.lang.Integer tag)

Constructor.

Parameters:

tag - tag value of evio container.

EvioDictionaryEntry

public EvioDictionaryEntry(java.lang.Integer tag,
                           java.lang.Integer num)

Constructor.

Parameters:

tag - tag value of evio container.

num - num value of evio container.

EvioDictionaryEntry

EvioDictionaryEntry(java.lang.Integer tag,
                    java.lang.Integer num,
                    java.lang.String type)

Constructor.

Parameters:

tag - tag value of evio container.

num - num value of evio container.

type - type of data in evio container which may be (case-independent): unknown32 DataType.UNKNOWN32 ... composite DataType.COMPOSITE.

EvioDictionaryEntry

public EvioDictionaryEntry(java.lang.Integer tag,
                           java.lang.Integer num,
                           java.lang.Integer tagEnd,
                           java.lang.String type)

Constructor.

Parameters:

tag - tag value of evio container.

num - num value of evio container.

tagEnd - if > 0, this is the high end of a tag range.

type - type of data in evio container which may be (case-independent): unknown32 DataType.UNKNOWN32 ... composite DataType.COMPOSITE.

EvioDictionaryEntry

EvioDictionaryEntry(java.lang.Integer tag,
                    java.lang.Integer num,
                    java.lang.String type,
                    java.lang.String description,
                    java.lang.String format)

Constructor.

Parameters:

tag - tag value of evio container.

num - num value of evio container.

type - type of data in evio container which may be (case-independent): unknown32 DataType.UNKNOWN32 ... composite DataType.COMPOSITE.

description - description of CompositeData

format - format of CompositeData

EvioDictionaryEntry

public EvioDictionaryEntry(java.lang.Integer tag,
                           java.lang.Integer num,
                           java.lang.Integer tagEnd,
                           java.lang.String type,
                           java.lang.String description,
                           java.lang.String format)

Constructor containing actual implementation. Caller assumes responsibility of supplying correct arg values. If tag > tagEnd, these values are switched so tag < tagEnd.

Parameters:

tag - tag value or low end of a tag range of an evio container.

num - num value of evio container.

tagEnd - if > 0, this is the high end of a tag range.

type - type of data in evio container which may be (case-independent): unknown32 DataType.UNKNOWN32 ... composite DataType.COMPOSITE.

description - description of CompositeData

format - format of CompositeData

EvioDictionaryEntry

public EvioDictionaryEntry(java.lang.Integer tag,
                           java.lang.Integer num,
                           java.lang.Integer tagEnd,
                           java.lang.String type,
                           java.lang.String description,
                           java.lang.String format,
                           EvioDictionaryEntry parentEntry)

Constructor containing actual implementation. Caller assumes responsibility of supplying correct arg values. If tag > tagEnd, these values are switched so tag < tagEnd.

Parameters:

tag - tag value or low end of a tag range of an evio container.

num - num value of evio container.

tagEnd - if > 0, this is the high end of a tag range.

type - type of data in evio container which may be (case-independent): unknown32 DataType.UNKNOWN32, int32 DataType.INT32, uint32 DataType.UINT32, float32DataType.FLOAT32, double64 DataType.DOUBLE64, charstar8 DataType.CHARSTAR8, char8 DataType.CHAR8, uchar8 DataType.UCHAR8, short16DataType.SHORT16, ushort16 DataType.USHORT16, long64 DataType.LONG64, ulong64 DataType.ULONG64, tagsegment DataType.TAGSEGMENT, segment DataType.SEGMENT. alsosegment DataType.ALSOSEGMENT, bank DataType.BANK, alsobank DataType.ALSOBANK, or composite DataType.COMPOSITE,

description - description of CompositeData

format - format of CompositeData

parentEntry - parent dictionary entry object

Method Detail

inRange

public boolean inRange(int tagArg)

Is the given tag within the specified range (inclusive) of this dictionary entry?

Parameters:

tagArg - tag to compare with range

Returns:

false if tag not in range, else true.

Since:

5.2

inRange

public boolean inRange(EvioDictionaryEntry entry)

Is the given dictionary entry's tag within the specified range (inclusive) of this dictionary entry?

Parameters:

entry - dictionary entry to compare with range

Returns:

false if tag not in range, else true.

Since:

5.2

hashCode

public int hashCode()

. Algorithm suggested by Joshua Block in "Effective Java".

Overrides:

hashCode in class java.lang.Object

equals

public final boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

toString

public final java.lang.String toString()

Overrides:

toString in class java.lang.Object

getTag

public final java.lang.Integer getTag()

Get the tag value. This is the low end of a tag range if tagEnd > 0.

Returns:

tag value.

getTagEnd

public final java.lang.Integer getTagEnd()

Get the tagEnd value (upper end of a tag range). A value of 0 means there is no range.

Returns:

tagEnd value.

getNum

public final java.lang.Integer getNum()

Get the num value.

Returns:

num value, null if nonexistent.

getType

public final DataType getType()

Get the data's type.

Returns:

data type object, null if nonexistent.

getFormat

public final java.lang.String getFormat()

Get the CompositeData's format.

Returns:

CompositeData's format, null if nonexistent.

getDescription

public final java.lang.String getDescription()

Get the CompositeData's description.

Returns:

CompositeData's description, null if nonexistent.

getEntryType

public EvioDictionaryEntryType getEntryType()

Get this entry's type.

Returns:

this entry's type.

getParentEntry

public EvioDictionaryEntry getParentEntry()

Get the parent container's dictionary entry.

Returns:

the parent container's dictionary entry, null if nonexistent.