org.lcsim.detector.identifier

Interface IExpandedIdentifier

All Known Implementing Classes:

ExpandedIdentifier

public interface IExpandedIdentifier

An ID that has been unpacked from an IIdentifier so that individual field values are available by index. Use the associated IIdentifierDictionary to see which indices correspond to which field labels.

Version:

$Id: IExpandedIdentifier.java,v 1.13 2007/11/26 18:34:27 jeremy Exp $

Author:

jeremym

Method Summary

Methods

Modifier and Type	Method and Description
void	addValue(int value) Push a value onto the end of this identifier.
void	clear() Clear the identifier of all field values.
int	compareField(IExpandedIdentifier id, int idx) Compare a single field value.
int	getMaxIndex() Get the maximum index which is size() - 1 .
int	getValue(int index) Get the field value at an index.
List<Integer>	getValues() Return the field values as a list.
boolean	isValid() True if the IExpandedIdentifier is in a valid state with 1 or more field values; False if there are no values when size is 0.
boolean	isValidIndex(int i) True if the index is valid.
int	match(IExpandedIdentifier id) Compares identifiers on prefix fields.
void	setValue(int index, int value) Set the field value at an index.
int	size() Get the number of fields in this identifier.

Method Detail

addValue

void addValue(int value)

Push a value onto the end of this identifier.

getValue

int getValue(int index)

Get the field value at an index.

setValue

void setValue(int index,
            int value)

Set the field value at an index.

getValues

List<Integer> getValues()

Return the field values as a list.

size

int size()

Get the number of fields in this identifier.

getMaxIndex

int getMaxIndex()

Get the maximum index which is size() - 1 .

isValidIndex

boolean isValidIndex(int i)

True if the index is valid.

Parameters:

i - The index.

Returns:

True if index is valid.

clear

void clear()

Clear the identifier of all field values. The size() method returns 0 after this method is called.

isValid

boolean isValid()

True if the IExpandedIdentifier is in a valid state with 1 or more field values; False if there are no values when size is 0.

match

int match(IExpandedIdentifier id)

Compares identifiers on prefix fields. The smaller of the two maximum indices is used for the field range.

compareField

int compareField(IExpandedIdentifier id,
               int idx)

Compare a single field value.

Parameters:

id -

idx -

Returns: