Package PamguardMVC

Class SequenceIterator<E extends PamDataUnit>

java.lang.Object
PamguardMVC.PamDataUnitIterator<E>
PamguardMVC.SequenceIterator<E>
All Implemented Interfaces:
Iterator<E>, ListIterator<E>
public class SequenceIterator<E extends PamDataUnit> extends PamDataUnitIterator<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.
This class matches the sequenceMap field, which may default to the channelMap if the sequenceMap == null. To match specifically to the channelMap, use the ChannelIterator class instead.
Author:
Doug Gillespie

  • Constructor Details

    • SequenceIterator

      public SequenceIterator(PamDataBlock<E> pamDataBlock, int sequenceMap, int whereFrom)
      An iterator that has a bit more functionality than a basic iterator.
      It's main enhancement is to use a sequence map match to PamDataUnits, so that it only returns data units that have an overlap in sequence numbers with the given sequence map (which could be 0xFFFFFFFF).
      It also has a couple of extra searches to getPreceeding() and getFollowing() data units.
      This class matches the sequenceMap field, which may default to the channelMap if the sequenceMap == null. To match specifically to the channelMap, use the ChannelIterator class instead.
      Parameters:
      pamDataBlock - Datablock containing the data
      sequenceMap - sequence map (requires overlap, or exact match)
      whereFrom - start at beginning or end. 0 = beginning; -1 (or PamDatablock.ITERATOR_END) for the end

  • Method Details