PamguardMVC

Class DataUnitFinder<Tunit extends PamDataUnit>

java.lang.Object

PamguardMVC.DataUnitFinder<Tunit>

Direct Known Subclasses:

DeletedDataUnitFinder

public class DataUnitFinder<Tunit extends PamDataUnit>
extends java.lang.Object

Class for finding data units in a reasonably controlled and organised way.

It sets up a list iterator at the start of the data block and then searches for each requested data unit from the unit after the last unit requested. This will generally be an efficient way of matching two almost ordered lists of units.

If the iterator gets to the end of the list without finding a match it restarts at the beginning, only returning null (nothing found) when it has been right through the list exactly once.

The finder can work with a default mather of time and channel or with user created matchers which can use any criteria the user wants

Author:

Doug Gillespie

See Also:

DataUnitMatcher, DefaultUnitMatcher;

Constructor Summary

Constructors

Constructor and Description
DataUnitFinder(PamDataBlock<Tunit> pamDataBlock) Create a data unit finder that uses the default matcher.
DataUnitFinder(PamDataBlock<Tunit> pamDataBlock, DataUnitMatcher dataUnitMatcher) Create a data unit finder that uses a user created matcher

Method Summary

Methods

Modifier and Type	Method and Description
Tunit	findDataUnit(java.lang.Object... criteria) Find a data unit which satisfies the criteria in criteria.
DataUnitMatcher	getDataUnitMatcher()
Tunit	getLastUnit()
PamDataBlock<Tunit>	getPamDataBlock()
void	setDataUnitMatcher(DataUnitMatcher dataUnitMatcher)

Methods inherited from class java.lang.Object

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

Constructor Detail

DataUnitFinder

public DataUnitFinder(PamDataBlock<Tunit> pamDataBlock)

Create a data unit finder that uses the default matcher.

Parameters:

pamDataBlock - parent PamDataBLock

DataUnitFinder

public DataUnitFinder(PamDataBlock<Tunit> pamDataBlock,
              DataUnitMatcher dataUnitMatcher)

Create a data unit finder that uses a user created matcher

Parameters:

pamDataBlock - parent PamDataBlock

dataUnitMatcher - user created matcher

Method Detail

findDataUnit

public Tunit findDataUnit(java.lang.Object... criteria)

Find a data unit which satisfies the criteria in criteria.

For the default search, the criteria are either just the time in milliseconds OR both the time AND the channel bitmap.

For user defined matchers, the criteria will have to match whatever the matcher expects.

Parameters:

criteria - variable number of matching criteria.

Returns:

the next data unit in the data block that matches those criteria.

getDataUnitMatcher

public DataUnitMatcher getDataUnitMatcher()

Returns:

the dataUnitMatcher

setDataUnitMatcher

public void setDataUnitMatcher(DataUnitMatcher dataUnitMatcher)

Parameters:

dataUnitMatcher - the dataUnitMatcher to set

getPamDataBlock

public PamDataBlock<Tunit> getPamDataBlock()

Returns:

the pamDataBlock

getLastUnit

public Tunit getLastUnit()

Returns:

the lastUnit