Package org.jenkinsci.plugins.lucene.search.databackend

Class SearchBackend<T>

java.lang.Object

org.jenkinsci.plugins.lucene.search.databackend.SearchBackend<T>

Direct Known Subclasses:

LuceneSearchBackend

public abstract class SearchBackend<T>
extends Object

Constructor Summary

Constructors

Constructor	Description
SearchBackend()

Method Summary

Modifier and Type	Method	Description
void	abort()
abstract void	cleanAllJob(ManagerProgress progress)
abstract void	close()
void	commitWrites()	Flushes pending write operations.
abstract void	deleteJob(String jobName)
abstract boolean	findRunIndex(Run<?,?> run)
protected String[]	getAllDefaultSearchableFields()
protected String[]	getAllFields()
abstract List<FreeTextSearchItemImplementation>	getHits(String query, boolean searchNext)
void	rebuildDatabase(ManagerProgress progress, int maxWorkers, Set<String> jobNames, boolean overwrite)
void	rebuildJob(Progress progress, Job<?,?> job, int maxWorkers, boolean overwrite)
abstract SearchBackend<?>	reconfigure(Map<String,Object> config)
abstract void	removeBuild(Run<?,?> run)
void	start()
abstract void	storeBuild(Run<?,?> run)

Methods inherited from class java.lang.Object

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

Constructor Details

SearchBackend

public SearchBackend()

Method Details

close

public abstract void close()

storeBuild

public abstract void storeBuild(Run<?,?> run)
                         throws IOException

Throws:

IOException

findRunIndex

public abstract boolean findRunIndex(Run<?,?> run)

getHits

public abstract List<FreeTextSearchItemImplementation> getHits(String query,
 boolean searchNext)

reconfigure

public abstract SearchBackend<?> reconfigure(Map<String,Object> config)

removeBuild

public abstract void removeBuild(Run<?,?> run)
                          throws IOException

Throws:

IOException

deleteJob

public abstract void deleteJob(String jobName)
                        throws IOException

Throws:

IOException

commitWrites

public void commitWrites()
                  throws IOException

Flushes pending write operations. The default implementation is a no-op; subclasses that batch writes (e.g. LuceneSearchBackend) override it to commit the underlying writer and refresh searchers.

Throws:

IOException

rebuildJob

public void rebuildJob(Progress progress,
 Job<?,?> job,
 int maxWorkers,
 boolean overwrite)
                throws IOException

Throws:

IOException

getAllDefaultSearchableFields

protected String[] getAllDefaultSearchableFields()

abort

public void abort()

start

public void start()

rebuildDatabase

public void rebuildDatabase(ManagerProgress progress,
 int maxWorkers,
 Set<String> jobNames,
 boolean overwrite)

getAllFields

protected String[] getAllFields()

cleanAllJob

public abstract void cleanAllJob(ManagerProgress progress)