com.logicaldoc.core.searchengine

Class Search

java.lang.Object

com.logicaldoc.core.searchengine.Search

Direct Known Subclasses:

FolderSearch, FulltextSearch, TagSearch

public abstract class Search
extends Object

This class executes a search against the full-text indexes

Author:

Michael Scholz

Field Summary

Fields

Modifier and Type	Field and Description
protected long	estimatedHitsNumber
protected long	execTime
protected List<Hit>	hits
protected static org.slf4j.Logger	log
protected boolean	moreHitsPresent
protected SearchOptions	options
protected User	searchUser
protected String	suggestion

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Search()

Method Summary

Methods

Modifier and Type	Method and Description
static Search	get(SearchOptions opt)
long	getEstimatedHitsNumber()
long	getExecTime() Query execution time in milliseconds
List<Hit>	getHits()
SearchOptions	getOptions()
String	getSuggestion()
protected abstract void	internalSearch() Concrete implementations must give a particular search algorithm that populates the hits list.
boolean	isMoreHitsPresent()
static SearchOptions	newOptions(int type)
List<Hit>	search() Perform the search
void	setMoreHitsPresent(boolean moreHitsPresent)
void	setOptions(SearchOptions options)

Methods inherited from class java.lang.Object

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

Field Detail

log

protected static org.slf4j.Logger log

moreHitsPresent

protected boolean moreHitsPresent

options

protected SearchOptions options

hits

protected List<Hit> hits

estimatedHitsNumber

protected long estimatedHitsNumber

execTime

protected long execTime

searchUser

protected User searchUser

suggestion

protected String suggestion

Constructor Detail

Search

protected Search()

Method Detail

get

public static Search get(SearchOptions opt)

newOptions

public static SearchOptions newOptions(int type)

search

public final List<Hit> search()

Perform the search

Returns:

The list of hits

internalSearch

protected abstract void internalSearch()
                                throws Exception

Concrete implementations must give a particular search algorithm that populates the hits list.

Throws:

Exception

getHits

public List<Hit> getHits()

isMoreHitsPresent

public boolean isMoreHitsPresent()

setMoreHitsPresent

public void setMoreHitsPresent(boolean moreHitsPresent)

getEstimatedHitsNumber

public long getEstimatedHitsNumber()

getExecTime

public long getExecTime()

Query execution time in milliseconds

getOptions

public SearchOptions getOptions()

setOptions

public void setOptions(SearchOptions options)

getSuggestion

public String getSuggestion()