org.jlab.coda.jevio

Interface INameProvider

All Known Implementing Classes:

EvioXMLDictionary

public interface INameProvider

This interface must be implemented by dictionary readers. For example, a dictionary reader that parses standard CODA dictionary plain text files, or a dictionary reader that processes the xml dictionary Maurizio uses for GEMC.

Author:

heddle

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NO_NAME_STRING A string used to indicate that no name can be determined.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getName(BaseStructure structure) Returns the pretty name of some evio structure.

Field Detail

NO_NAME_STRING

static final java.lang.String NO_NAME_STRING

A string used to indicate that no name can be determined.

See Also:

Constant Field Values

Method Detail

getName

java.lang.String getName(BaseStructure structure)

Returns the pretty name of some evio structure. Typically this is involve the use of the "tag" and, if present, "num" fields. There may also be a hierarchical dependence.

Parameters:

structure - the structure to find the name of.

Returns:

a descriptive name, e.g., "Edep".