public interface IndexManager
Modifier and Type | Method and Description |
---|---|
void |
addContainedEntity(Class<?> entity) |
void |
destroy()
Called when a
SearchFactory is stopped. |
org.apache.lucene.analysis.Analyzer |
getAnalyzer(String name) |
Set<Class<?>> |
getContainedTypes() |
String |
getIndexName()
Useful for labeling and logging resources from this instance.
|
ReaderProvider |
getReaderProvider()
Provide access to
IndexReader s. |
LuceneWorkSerializer |
getSerializer() |
org.apache.lucene.search.Similarity |
getSimilarity() |
void |
initialize(String indexName,
Properties properties,
org.apache.lucene.search.Similarity similarity,
WorkerBuildContext context)
Initialize this
IndexManager before its use. |
void |
optimize()
To optimize the underlying index.
|
void |
performOperations(List<LuceneWork> queue,
IndexingMonitor monitor)
Used to apply update operations to the index.
|
void |
performStreamOperation(LuceneWork singleOperation,
IndexingMonitor monitor,
boolean forceAsync)
Perform a single non-transactional operation, best to stream large amounts of operations.
|
void |
setSearchFactory(SearchFactoryImplementor boundSearchFactory)
Connects this
IndexManager to a new SearchFactory . |
String getIndexName()
ReaderProvider getReaderProvider()
IndexReader
s.ReaderProvider
instance for the index managed by this instancevoid performOperations(List<LuceneWork> queue, IndexingMonitor monitor)
monitor
- no be notified of indexing eventsqueue
- the list of write operations to apply.void performStreamOperation(LuceneWork singleOperation, IndexingMonitor monitor, boolean forceAsync)
singleOperation
- the operation to performmonitor
- no be notified of indexing eventsforceAsync
- if true, the invocation will not block to wait for it being applied.
When false this will depend on the backend configuration.void initialize(String indexName, Properties properties, org.apache.lucene.search.Similarity similarity, WorkerBuildContext context)
IndexManager
before its use.indexName
- the unique name of the index (manager). Can be used to retrieve a IndexManager
instance
via the search factory and IndexManagerHolder
.properties
- the configuration propertiescontext
- context information needed to initialize this index managervoid destroy()
SearchFactory
is stopped. This method typically releases resources.Set<Class<?>> getContainedTypes()
org.apache.lucene.search.Similarity getSimilarity()
Similarity
applied to this index. Note, only a single Similarity
can be applied to
a given index.org.apache.lucene.analysis.Analyzer getAnalyzer(String name)
name
- the name of the analyzer to retrieve.Analyzer
with the given name (see also AnalyzerDef
)SearchException
- in case the analyzer name is unknown.void setSearchFactory(SearchFactoryImplementor boundSearchFactory)
IndexManager
to a new SearchFactory
.boundSearchFactory
- the existing search factory to which to associate this index manager withvoid addContainedEntity(Class<?> entity)
entity
- Adds the specified entity type to this index manager, making it responsible for manging this type.void optimize()
LuceneWorkSerializer getSerializer()
Copyright © 2006–2016 Hibernate. All rights reserved.