edu.sc.seis.sod.source.event
Class SimpleEventSource

java.lang.Object
  extended by edu.sc.seis.sod.source.event.SimpleEventSource
All Implemented Interfaces:
SodElement, EventSource
Direct Known Subclasses:
CSVEventSource

public abstract class SimpleEventSource
extends java.lang.Object
implements EventSource


Field Summary
 boolean hasNextBeenCalled
           
 
Constructor Summary
SimpleEventSource()
           
 
Method Summary
 MicroSecondDate extractBeginTime(CacheEvent ev)
           
abstract  CacheEvent[] getEvents()
           
 MicroSecondTimeRange getEventTimeRange()
           
 TimeInterval getWaitBeforeNext()
          If the source needs to wait for more events to arrive, it should return the amount of time it wants to wait with this method.
 boolean hasNext()
           
 CacheEvent[] next()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface edu.sc.seis.sod.source.event.EventSource
getDescription
 

Field Detail

hasNextBeenCalled

public boolean hasNextBeenCalled
Constructor Detail

SimpleEventSource

public SimpleEventSource()
Method Detail

getEvents

public abstract CacheEvent[] getEvents()

hasNext

public boolean hasNext()
Specified by:
hasNext in interface EventSource
Returns:
- false when this event source will return no new events from calls to next

next

public CacheEvent[] next()
Specified by:
next in interface EventSource
Returns:
- the next set of events. Events can be returned from this method multiple times

getWaitBeforeNext

public TimeInterval getWaitBeforeNext()
Description copied from interface: EventSource
If the source needs to wait for more events to arrive, it should return the amount of time it wants to wait with this method.

Specified by:
getWaitBeforeNext in interface EventSource

getEventTimeRange

public MicroSecondTimeRange getEventTimeRange()
Specified by:
getEventTimeRange in interface EventSource
Returns:
- a MicroSecondTimeRange starting at least as early as the earliest event and ending at least as late as the latest event. No event should be returned by this source with an origin before the begin time or after the end time of this range.

extractBeginTime

public MicroSecondDate extractBeginTime(CacheEvent ev)