PamguardMVC

Class ChannelIterator<E extends PamDataUnit>

java.lang.Object

PamguardMVC.ChannelIterator<E>

Type Parameters:

E -

All Implemented Interfaces:

java.util.Iterator<E>, java.util.ListIterator<E>

public class ChannelIterator<E extends PamDataUnit>
extends java.lang.Object
implements java.util.ListIterator<E>

An iterator that has a bit more functionality than a basic iterator.
It's main enhancement is to use a channel map match to PamDataUnits, so that it only returns data units that have an overlap in channels with the given channel map (which could be 0xFFFFFFFF).
It also has a couple of extra searches to getPreceeding() and getFollowing() data units.

Author:

Doug Gillespie

Constructor Summary

Constructors

Constructor and Description
ChannelIterator(PamDataBlock<E> pamDataBlock, int channelMap, int whereFrom) An iterator that has a bit more functionality than a basic iterator.

Method Summary

Methods

Modifier and Type	Method and Description
void	add(E e)
int	getChannelMap()
E	getClosest(long timeMilliseconds, boolean firstOrlastOk) Get the unit closest to the given time.
E	getFollowing(long timeMilliseconds, boolean lastOk) Get the unit immediately following or at the given time.
PamDataBlock<E>	getPamDataBlock()
E	getPreceding(long timeMilliseconds, boolean firstOk) Get the unit immediately before or at the given time.
java.lang.Object	getSynchObject()
boolean	hasNext()
boolean	hasPrevious()
E	next()
int	nextIndex()
E	previous()
int	previousIndex()
void	remove()
void	set(E e)
void	setSynchObject(java.lang.Object synchObject)

Methods inherited from class java.lang.Object

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

Constructor Detail

ChannelIterator

public ChannelIterator(PamDataBlock<E> pamDataBlock,
               int channelMap,
               int whereFrom)

An iterator that has a bit more functionality than a basic iterator.
It's main enhancement is to use a channel map match to PamDataUnits, so that it only returns data units that have an overlap in channels with the given channel map (which could be 0xFFFFFFFF).
It also has a couple of extra searches to getPreceeding() and getFollowing() data units.

Parameters:

pamDataBlock - Datablock containing the data

channelMap - channel map (requires overlap, ot exact match)

whereFrom - start at beginning or end. 0 = beginning; -1 (or PamDatablock.ITERATOR_END) for the end

Method Detail

hasNext

public boolean hasNext()

Specified by:

hasNext in interface java.util.Iterator<E extends PamDataUnit>

Specified by:

hasNext in interface java.util.ListIterator<E extends PamDataUnit>

next

public E next()

Specified by:

next in interface java.util.Iterator<E extends PamDataUnit>

Specified by:

next in interface java.util.ListIterator<E extends PamDataUnit>

hasPrevious

public boolean hasPrevious()

Specified by:

hasPrevious in interface java.util.ListIterator<E extends PamDataUnit>

previous

public E previous()

Specified by:

previous in interface java.util.ListIterator<E extends PamDataUnit>

getPreceding

public E getPreceding(long timeMilliseconds,
             boolean firstOk)

Get the unit immediately before or at the given time.

Parameters:

timeMilliseconds - time in milliseconds.

firstOk - if this is true and no unit precedes the given time, it will return the first unit, otherwise it will return null

Returns:

a data unit, or null.

getFollowing

public E getFollowing(long timeMilliseconds,
             boolean lastOk)

Get the unit immediately following or at the given time.

Parameters:

timeMilliseconds - time in milliseconds.

lastOk - if this is true and no unit precedes the given time, it will return the last unit, otherwise it will return null

Returns:

a data unit, or null.

getClosest

public E getClosest(long timeMilliseconds,
           boolean firstOrlastOk)

Get the unit closest to the given time.

Parameters:

timeMilliseconds - time in milliseconds.

firstOrlastOk - if this is true and no unit precedes the given time, it will return the last unit, otherwise it will return null

Returns:

a data unit, or null.

nextIndex

public int nextIndex()

Specified by:

nextIndex in interface java.util.ListIterator<E extends PamDataUnit>

previousIndex

public int previousIndex()

Specified by:

previousIndex in interface java.util.ListIterator<E extends PamDataUnit>

remove

public void remove()

Specified by:

remove in interface java.util.Iterator<E extends PamDataUnit>

Specified by:

remove in interface java.util.ListIterator<E extends PamDataUnit>

set

public void set(E e)

Specified by:

set in interface java.util.ListIterator<E extends PamDataUnit>

add

public void add(E e)

Specified by:

add in interface java.util.ListIterator<E extends PamDataUnit>

getChannelMap

public int getChannelMap()

Returns:

the channelMap

getPamDataBlock

public PamDataBlock<E> getPamDataBlock()

Returns:

the pamDataBlock

getSynchObject

public java.lang.Object getSynchObject()

Returns:

the synchObject

setSynchObject

public void setSynchObject(java.lang.Object synchObject)

Parameters:

synchObject - the synchObject to set