org.lcsim.detector.identifier

Class IdentifierDictionary

java.lang.Object

org.lcsim.detector.identifier.IdentifierDictionary

All Implemented Interfaces:

IIdentifierDictionary

public final class IdentifierDictionary
extends Object
implements IIdentifierDictionary

Implementation of IIdentifierDictionary. This class is declared final because overriding the methods could cause serious bugs. To provide specialized id functionality, the class IdentifierHelper can be subclassed instead.

Version:

$Id: IdentifierDictionary.java,v 1.9 2013/01/24 22:26:35 jeremy Exp $

Author:

Jeremy McCormick

Field Summary

Fields

Modifier and Type	Field and Description
private IIdentifierField[]	fieldArray
private Map<String,Integer>	fieldIndices
private Map<String,IIdentifierField>	fieldMap
protected int	maxIndex
private String	name
protected int	numberOfFields

Constructor Summary

Constructors

Constructor and Description
IdentifierDictionary(String name, List<IIdentifierField> fieldList) Create an identifier dictionary with fields from fieldList.

Method Summary

Methods

Modifier and Type	Method and Description
private void	addField(IIdentifierField field, int index) Add a field.
private void	addFields(List<IIdentifierField> fields) Add a list of fields.
IIdentifierField	getField(int index) Get a field by index.
IIdentifierField	getField(String fieldName) Get a field by name or null if it doesn't exist in this dictionary.
int	getFieldIndex(String fieldName) Get a field's index in the array or null if it doesn't exist.
List<IIdentifierField>	getFieldList() Get the list of fields.
List<String>	getFieldNames() Get the list of fields in this dictionary, which is cloned in case the caller modifies it.
int	getFieldValue(IIdentifier compact, int idx) Extract value of a field by index.
int	getFieldValue(IIdentifier compact, String field) Extract value of a named field from packed id.
int	getMaxIndex() Get the maximum index in the field array.
String	getName() Get the name of this dictionary.
int	getNumberOfFields() Get the number of fields in the dictionary.
boolean	hasField(String fieldName) True if the dictionary has a field called fieldName; false if not.
boolean	isValid(IExpandedIdentifier id) Check that an IExpandedIdentifier is valid for this dictionary.
IIdentifier	pack(IExpandedIdentifier id) Pack an expanded id.
String	toString() Convert the dictionary to a String.
IExpandedIdentifier	unpack(IIdentifier compact) Unpack a packed id.
IExpandedIdentifier	unpack(IIdentifier compact, List<Integer> indices) Unpack id, only including fields with indices in list.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

fieldArray

private IIdentifierField[] fieldArray

fieldMap

private Map<String,IIdentifierField> fieldMap

fieldIndices

private Map<String,Integer> fieldIndices

name

private final String name

numberOfFields

protected int numberOfFields

maxIndex

protected int maxIndex

Constructor Detail

IdentifierDictionary

public IdentifierDictionary(String name,
                    List<IIdentifierField> fieldList)

Create an identifier dictionary with fields from fieldList. A dictionary cannot be modified once it is created.

Parameters:

name - The name of the dictionary.

fieldList - The list of fields.

Method Detail

getName

public String getName()

Get the name of this dictionary.

Specified by:

getName in interface IIdentifierDictionary

Returns:

The dictionary's name.

getFieldList

public List<IIdentifierField> getFieldList()

Get the list of fields.

Specified by:

getFieldList in interface IIdentifierDictionary

Returns:

The list of fields.s

getField

public IIdentifierField getField(String fieldName)

Get a field by name or null if it doesn't exist in this dictionary.

Specified by:

getField in interface IIdentifierDictionary

Parameters:

fieldName - The field.

Returns:

The field called fieldName or null if doesn't exist.

getField

public IIdentifierField getField(int index)

Get a field by index.

Specified by:

getField in interface IIdentifierDictionary

Returns:

The field at index in the array.

Throws:

ArrayOutOfBoundsException - if index is not valid.

getFieldIndex

public int getFieldIndex(String fieldName)

Get a field's index in the array or null if it doesn't exist.

Specified by:

getFieldIndex in interface IIdentifierDictionary

Parameters:

fieldName - The name of the field.

Returns:

The field index for the field called fieldName or null if doesn't exist.

getFieldNames

public List<String> getFieldNames()

Get the list of fields in this dictionary, which is cloned in case the caller modifies it. This means that callers should take care not to put this method inside a loop unnecessarily.

Specified by:

getFieldNames in interface IIdentifierDictionary

Returns:

The list of fields.

getNumberOfFields

public int getNumberOfFields()

Get the number of fields in the dictionary.

Specified by:

getNumberOfFields in interface IIdentifierDictionary

Returns:

The number of fields.

getMaxIndex

public int getMaxIndex()

Get the maximum index in the field array.

Specified by:

getMaxIndex in interface IIdentifierDictionary

Returns:

The max index.

hasField

public boolean hasField(String fieldName)

True if the dictionary has a field called fieldName; false if not.

Specified by:

hasField in interface IIdentifierDictionary

Parameters:

fieldName - The name of the field.

Returns:

True if fieldName exists in this dictionary; false if not.

unpack

public IExpandedIdentifier unpack(IIdentifier compact)

Unpack a packed id.

Specified by:

unpack in interface IIdentifierDictionary

Parameters:

compact - The packed id.

Returns:

The expanded id, which is a list of field values.

unpack

public IExpandedIdentifier unpack(IIdentifier compact,
                         List<Integer> indices)

Description copied from interface: IIdentifierDictionary

Unpack id, only including fields with indices in list.

Specified by:

unpack in interface IIdentifierDictionary

Parameters:

compact - The packed id

indices - The indices of the fields to unpack.

Returns:

The expanded id.

pack

public IIdentifier pack(IExpandedIdentifier id)

Pack an expanded id.

Specified by:

pack in interface IIdentifierDictionary

Parameters:

id - The expanded id.

Returns:

The packed id.

getFieldValue

public int getFieldValue(IIdentifier compact,
                String field)

Extract value of a named field from packed id.

Specified by:

getFieldValue in interface IIdentifierDictionary

Parameters:

compact - The packed id.

field - The field name.

Returns:

The field value.

getFieldValue

public int getFieldValue(IIdentifier compact,
                int idx)

Extract value of a field by index.

Specified by:

getFieldValue in interface IIdentifierDictionary

Parameters:

compact - The packed id.

field - The field name.

Returns:

The field value.

addField

private void addField(IIdentifierField field,
            int index)

Add a field.

Parameters:

field - The field object.

index - The field index.

addFields

private void addFields(List<IIdentifierField> fields)

Add a list of fields.

Parameters:

fields - The list of fields.

isValid

public boolean isValid(IExpandedIdentifier id)

Check that an IExpandedIdentifier is valid for this dictionary. This method checks that the sizes are the same and that the values are valid for their corresponding fields.

Specified by:

isValid in interface IIdentifierDictionary

Returns:

True if valid; false if not.

toString

public String toString()

Convert the dictionary to a String.

Overrides:

toString in class Object

Returns:

A string with the dictionary's field information.