|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.openprivacy.reptile.search.AbstractSearchProvider
Abstract implementation of a SearchProvider, all SearchProviders should implement this interface.
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 |
public AbstractSearchProvider()
Method Detail |
public final int getResultCount()
resultCount
.
getResultCount
in interface SearchProvider
SearchProvider
public final void setResultCount(int resultCount)
resultCount
.
setResultCount
in interface SearchProvider
SearchProvider
public final java.lang.String getHandle()
SearchProvider
Get a unique handle for this SearchProvider. Each SearchProvider has a unique handle that can be used to obtain it from the SearchProviderManager
getHandle
in interface SearchProvider
SearchProvider
public final long getTimeCreated()
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.
getTimeCreated
in interface SearchProvider
SearchProvider
public final int getState()
state
.
getState
in interface SearchProvider
public final java.lang.String getState(int state)
SearchProvider
getState
in interface SearchProvider
SearchProvider.getState()
public final void setState(int state)
state
.
setState
in interface SearchProvider
public final boolean isSearchable()
SearchProvider
isSearchable
in interface SearchProvider
SearchProvider.isSearchable()
public final void assertSearchable() throws java.lang.Exception
SearchProvider
assertSearchable
in interface SearchProvider
java.lang.Exception
SearchProvider.isSearchable()
,
SearchProvider.assertSearchable()
public SearchRequest getSearchRequest()
searchRequest
.
getSearchRequest
in interface SearchProvider
public void setSearchRequest(SearchRequest searchRequest)
searchRequest
.
setSearchRequest
in interface SearchProvider
public long getSearchStartTime()
searchStartTime
.
getSearchStartTime
in interface SearchProvider
public void setSearchStartTime(long searchStartTime)
searchStartTime
.
setSearchStartTime
in interface SearchProvider
SearchProvider.getSearchStartTime()
public long getSearchCompletedTime()
searchCompletedTime
.
getSearchCompletedTime
in interface SearchProvider
public void setSearchCompletedTime(long searchCompletedTime)
searchCompletedTime
.
setSearchCompletedTime
in interface SearchProvider
SearchProvider.getSearchCompletedTime()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |