org.openprivacy.reptile.search
Class AbstractSearchProvider

java.lang.Object
  |
  +--org.openprivacy.reptile.search.AbstractSearchProvider

All Implemented Interfaces:

SearchProvider

Direct Known Subclasses:

DBSearchProvider

public abstract class AbstractSearchProvider

extends java.lang.Object

implements SearchProvider

Abstract implementation of a SearchProvider, all SearchProviders should implement this interface.

Version:

$Id: AbstractSearchProvider.java,v 1.9 2002/02/07 11:08:13 burton Exp $

Author:

Kevin A. Burton

Field Summary

Fields inherited from interface org.openprivacy.reptile.search.SearchProvider

STATE_NEVER_SEARCHED, STATE_SEARCH_COMPLETE, STATE_SEARCH_IN_PROGRESS

Constructor Summary

AbstractSearchProvider()

Method Summary

void	assertSearchable() Throws an Exception if this SearchProvider is not searchable.
java.lang.String	getHandle() Get a unique handle for this SearchProvider.
int	getResultCount() Get the value of resultCount.
long	getSearchCompletedTime() Get the value of searchCompletedTime.
SearchRequest	getSearchRequest() Get the value of searchRequest.
long	getSearchStartTime() Get the value of searchStartTime.
int	getState() Get the value of state.
java.lang.String	getState(int state) Get the state of this provider as a string.
long	getTimeCreated() The time created for this this SearchProvider is the current time in milliseconds when this SearchProvider was instantiated.
boolean	isSearchable() Return true if this SearchProvider is searchable.
void	setResultCount(int resultCount) Set the value of resultCount.
void	setSearchCompletedTime(long searchCompletedTime) Set the value of searchCompletedTime.
void	setSearchRequest(SearchRequest searchRequest) Set the value of searchRequest.
void	setSearchStartTime(long searchStartTime) Set the value of searchStartTime.
void	setState(int state) Set the value of state.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openprivacy.reptile.search.SearchProvider

destroy, record, search

Constructor Detail

AbstractSearchProvider

public AbstractSearchProvider()

Method Detail

getResultCount

public final int getResultCount()

Get the value of resultCount.

Specified by:

getResultCount in interface SearchProvider

See Also:

SearchProvider

setResultCount

public final void setResultCount(int resultCount)

Set the value of resultCount.

Specified by:

setResultCount in interface SearchProvider

See Also:

SearchProvider

getHandle

public final java.lang.String getHandle()

Description copied from interface: SearchProvider

Get a unique handle for this SearchProvider. Each SearchProvider has a unique handle that can be used to obtain it from the SearchProviderManager

Specified by:

getHandle in interface SearchProvider

See Also:

SearchProvider

getTimeCreated

public final long getTimeCreated()

Description copied from interface: SearchProvider

The time created for this this SearchProvider is the current time in milliseconds when this SearchProvider was instantiated.

This is used by the SearchProviderGCThread to determine when it should GC SearchProviders.

Specified by:

getTimeCreated in interface SearchProvider

See Also:

SearchProvider

getState

public final int getState()

Get the value of state.

Specified by:

getState in interface SearchProvider

getState

public final java.lang.String getState(int state)

Description copied from interface: SearchProvider

Get the state of this provider as a string.

Specified by:

getState in interface SearchProvider

See Also:

SearchProvider.getState()

setState

public final void setState(int state)

Set the value of state.

Specified by:

setState in interface SearchProvider

isSearchable

public final boolean isSearchable()

Description copied from interface: SearchProvider

Return true if this SearchProvider is searchable. A SearchProvider is only searchable if it's state is STATE_NEVER_SEARCHED

Specified by:

isSearchable in interface SearchProvider

See Also:

SearchProvider.isSearchable()

assertSearchable

public final void assertSearchable()
                            throws java.lang.Exception

Description copied from interface: SearchProvider

Throws an Exception if this SearchProvider is not searchable.

Specified by:

assertSearchable in interface SearchProvider

java.lang.Exception

See Also:

SearchProvider.isSearchable(), SearchProvider.assertSearchable()

getSearchRequest

public SearchRequest getSearchRequest()

Get the value of searchRequest.

Specified by:

getSearchRequest in interface SearchProvider

setSearchRequest

public void setSearchRequest(SearchRequest searchRequest)

Set the value of searchRequest.

Specified by:

setSearchRequest in interface SearchProvider

getSearchStartTime

public long getSearchStartTime()

Get the value of searchStartTime.

Specified by:

getSearchStartTime in interface SearchProvider

setSearchStartTime

public void setSearchStartTime(long searchStartTime)

Set the value of searchStartTime.

Specified by:

setSearchStartTime in interface SearchProvider

See Also:

SearchProvider.getSearchStartTime()

getSearchCompletedTime

public long getSearchCompletedTime()

Get the value of searchCompletedTime.

Specified by:

getSearchCompletedTime in interface SearchProvider

setSearchCompletedTime

public void setSearchCompletedTime(long searchCompletedTime)

Set the value of searchCompletedTime.

Specified by:

setSearchCompletedTime in interface SearchProvider

See Also:

SearchProvider.getSearchCompletedTime()