org.jlab.coda.jevio

Class EvioDictionaryEntry

java.lang.Object

org.jlab.coda.jevio.EvioDictionaryEntry

All Implemented Interfaces:

java.lang.Comparable<EvioDictionaryEntry>

Deprecated.

public class EvioDictionaryEntry
extends java.lang.Object
implements java.lang.Comparable<EvioDictionaryEntry>

An entry into the evio dictionary.

Author:

heddle

Constructor Summary

Constructors

Constructor and Description
EvioDictionaryEntry(java.lang.String tag, java.lang.String num, java.lang.String description) Deprecated. Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(EvioDictionaryEntry entry) Deprecated. We sort so that the entries with the most number of ancestors match.
java.lang.String	getDescription() Deprecated. Get the nice, hopefully descriptive name for this entry.
int	getTag() Deprecated. Get the tag for this entry.
boolean	match(BaseStructure structure) Deprecated. Checks if a structure matches this dictionary entry.
java.lang.String	toString() Deprecated. Get a string representation of this entry.
java.lang.StringBuilder	toXML() Deprecated. Get an xml representation of this entry.

Methods inherited from class java.lang.Object

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

Constructor Detail

EvioDictionaryEntry

public EvioDictionaryEntry(java.lang.String tag,
                   java.lang.String num,
                   java.lang.String description)

Deprecated.

Constructor.

Parameters:

tag - the string tag, will be converted into an int.

num - the string num field, which might be null, and which will be tokenized (for possible ancestor matching) and converted into an array of ints.

description - the nice name for this dictionary entry--the description.

Method Detail

match

public boolean match(BaseStructure structure)

Deprecated.

Checks if a structure matches this dictionary entry. This is more complicated than at first glance, because a matching of not just the structure but also (for banks) the num fields of its immediate ancestors might be required.

Parameters:

structure - the structure to test.

Returns:

true if the structure matches.

compareTo

public int compareTo(EvioDictionaryEntry entry)

Deprecated.

We sort so that the entries with the most number of ancestors match.

Specified by:

compareTo in interface java.lang.Comparable<EvioDictionaryEntry>

Parameters:

entry - the object to compare against.

getDescription

public java.lang.String getDescription()

Deprecated.

Get the nice, hopefully descriptive name for this entry.

Returns:

the nice, hopefully descriptive name for this entry.

getTag

public int getTag()

Deprecated.

Get the tag for this entry.

Returns:

the tag for this entry.

toXML

public java.lang.StringBuilder toXML()

Deprecated.

Get an xml representation of this entry.

Returns:

an xml representation of this entry.

toString

public java.lang.String toString()

Deprecated.

Get a string representation of this entry.

Overrides:

toString in class java.lang.Object

Returns:

a string representation of this entry.