org.mbari.siam.distributed
Interface FilteredDeviceLogIF

All Superinterfaces:

DeviceLogIF

All Known Implementing Classes:

FilteredDeviceLog

public interface FilteredDeviceLogIF
extends DeviceLogIF

FilteredDeviceLogIF is the interface for a DevicePacket logger

Author:

Bob Herlien

See Also:

DeviceLog

Method Summary

DevicePacketSet

getPackets(long startKey, long endKey, int maxReturnedPackets, PacketFilter[] filters, boolean excludeStale) Return a time-sorted packet set, using specified time window and filter criteria.

Methods inherited from interface org.mbari.siam.distributed.DeviceLogIF

appendPacket, appendPacket, close, getDeviceId, getLastMetadataRef, getLastPacket, getMaxTimestamp, getMinTimestamp, getNextPacket, getNumUnreadPackets, getPacketKeyRange, getPackets, nPackets

Method Detail

getPackets

DevicePacketSet getPackets(long startKey,
                           long endKey,
                           int maxReturnedPackets,
                           PacketFilter[] filters,
                           boolean excludeStale)
                           throws NoDataException

Return a time-sorted packet set, using specified time window and filter criteria. The boolean 'excludeStale' argument indicates whether to exclude packets that exceed the _shelfLifeMsec value specified for this FilteredDeviceLog. The returned packet set may be "complete" or "incomplete"; a complete packet set contains all packets from the log that meet the retrieval criteria. An incomplete packet set contains packets from the "lower end" of the time-window.

Throws:

NoDataException