net.cnri.apps.doserver.operators

Class DefaultIndexBuilder

java.lang.Object

net.cnri.apps.doserver.operators.DefaultIndexBuilder

All Implemented Interfaces:

IndexBuilder

Direct Known Subclasses:

JsonIndexBuilder

public class DefaultIndexBuilder
extends java.lang.Object
implements IndexBuilder

Constructor Summary

Constructors

Constructor and Description
DefaultIndexBuilder()

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultIndexBuilder

public DefaultIndexBuilder()

Method Detail

init

public void init(Main serverMain)

Description copied from interface: IndexBuilder

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

Specified by:

init in interface IndexBuilder

getAnalyzer

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

Description copied from interface: IndexBuilder

Returns the analyzer used to write documents into the index.

Specified by:

getAnalyzer in interface IndexBuilder

getQueryParser

public 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.

Specified by:

getQueryParser in interface IndexBuilder

Returns:

a query parser to parse queries to this index.

setKeyRing

public void setKeyRing(DOKeyRing keyring)

Description copied from interface: IndexBuilder

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

Specified by:

setKeyRing in interface IndexBuilder

getSortFieldName

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

Description copied from interface: IndexBuilder

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

Specified by:

getSortFieldName in interface IndexBuilder

documentOfStorageProxy

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

Description copied from interface: IndexBuilder

Creates a Lucene Document from an object in local storage.

Specified by:

documentOfStorageProxy in interface IndexBuilder

Throws:

DOException

java.io.IOException

documentOfDigitalObject

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

Description copied from interface: IndexBuilder

Creates a Lucene Document from an object accessed remotely.

Specified by:

documentOfDigitalObject in interface IndexBuilder

Throws:

DOException

java.io.IOException

objectsNeedingReindexingQuery

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

Description copied from interface: IndexBuilder

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.

Specified by:

objectsNeedingReindexingQuery in interface IndexBuilder