net.cnri.apps.doserver.operators

Interface IndexBuilder

All Known Implementing Classes:

DefaultIndexBuilder, JsonIndexBuilder

public interface IndexBuilder

Method Summary

Methods

Modifier and Type	Method and Description
org.apache.lucene.document.Document	documentOfDigitalObject(DigitalObject obj) Creates a Lucene Document from an object accessed remotely.
org.apache.lucene.document.Document	documentOfStorageProxy(StorageProxy objStore) Creates a Lucene Document from an object in local storage.
org.apache.lucene.analysis.Analyzer	getAnalyzer() Returns the analyzer used to write documents into the index.
org.apache.lucene.queryparser.classic.QueryParser	getQueryParser() Returns a query parser to parse queries to this index.
java.lang.String	getSortFieldName(java.lang.String field) Returns the name of the field that will be used for sorting.
void	init(Main serverMain) Initialize the index builder and notify it of its containing server Main instance.
org.apache.lucene.search.Query	objectsNeedingReindexingQuery() Returns a query which matches objects which need to be reindexed.
void	setKeyRing(DOKeyRing keyring) Sets the DOKeyRing which could be used by the index builder to index encrypted documents.

Method Detail

init

void init(Main serverMain)

Initialize the index builder and notify it of its containing server Main instance.

getAnalyzer

org.apache.lucene.analysis.Analyzer getAnalyzer()

Returns the analyzer used to write documents into the index.

getQueryParser

org.apache.lucene.queryparser.classic.QueryParser getQueryParser()

Returns a query parser to parse queries to this index. Returns a new instance of QueryParser each time, as these objects are lightweight and not thread-safe.

setKeyRing

void setKeyRing(DOKeyRing keyring)

Sets the DOKeyRing which could be used by the index builder to index encrypted documents.

documentOfStorageProxy

org.apache.lucene.document.Document documentOfStorageProxy(StorageProxy objStore)
                                                           throws DOException,
                                                                  java.io.IOException

Creates a Lucene Document from an object in local storage.

Throws:

DOException

java.io.IOException

documentOfDigitalObject

org.apache.lucene.document.Document documentOfDigitalObject(DigitalObject obj)
                                                            throws DOException,
                                                                   java.io.IOException

Creates a Lucene Document from an object accessed remotely.

Throws:

DOException

java.io.IOException

getSortFieldName

java.lang.String getSortFieldName(java.lang.String field)

Returns the name of the field that will be used for sorting.

objectsNeedingReindexingQuery

org.apache.lucene.search.Query objectsNeedingReindexingQuery()

Returns a query which matches objects which need to be reindexed. It is the responsibility of the document... methods to introduce version information into the Lucene documents.