Package lrgs.archive

Class SearchHandle

java.lang.Object

lrgs.archive.SearchHandle

public class SearchHandle
extends Object

This object holds variables that are opaque to the application. They are used by the archiving classes to keep track of the progress of a search.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	INDEX_BUF_MAX	The number of indexes to allocate in the buffer.
static final int	SM_BACKREF	Search method for backward search from dcp specific index pointer
static final int	SM_INDEXSEARCH	Search method for forward search of index file from since to until
static final int	SM_UNDEFINED	Undefined search method

Constructor Summary

Constructors

Constructor	Description
SearchHandle(MsgFilter filter)	Default constructor.

Method Summary

Modifier and Type	Method	Description
void	addIndex(DcpMsgIndex idx)	Adds an index to the internal buffer.
int	capacity()
void	flushBuffer()	Empties the cache and resets the pointers.
DcpMsgIndex	getNextIndex()	Return next index in buffer, or null if none.
boolean	isEmpty()

Methods inherited from class java.lang.Object

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

Field Details

SM_UNDEFINED

public static final int SM_UNDEFINED

Undefined search method

See Also:

• Constant Field Values

SM_INDEXSEARCH

public static final int SM_INDEXSEARCH

Search method for forward search of index file from since to until

See Also:

• Constant Field Values

SM_BACKREF

public static final int SM_BACKREF

Search method for backward search from dcp specific index pointer

See Also:

• Constant Field Values

INDEX_BUF_MAX

public static final int INDEX_BUF_MAX

The number of indexes to allocate in the buffer.

See Also:

• Constant Field Values

Constructor Details

SearchHandle

public SearchHandle(MsgFilter filter)

Default constructor.

Method Details

flushBuffer

public void flushBuffer()

Empties the cache and resets the pointers.

isEmpty

public boolean isEmpty()

capacity

public int capacity()

Returns:

remaining capacity, i.e. number of indexes that can be held.

getNextIndex

public DcpMsgIndex getNextIndex()

Return next index in buffer, or null if none.

Returns:

next index in buffer, or null if none.

addIndex

public void addIndex(DcpMsgIndex idx)

Adds an index to the internal buffer.

Parameters:

idx - the index