org.alfresco.repo.search.impl.lucene
Interface LuceneConfig

All Known Subinterfaces:
LuceneIndexerAndSearcher
All Known Implementing Classes:
AbstractLuceneIndexerAndSearcherFactory, ADMLuceneIndexerAndSearcherFactory, ADMLuceneUnIndexedIndexAndSearcherFactory, AVMLuceneIndexerAndSearcherFactory

public interface LuceneConfig


Method Summary
 org.springframework.context.ConfigurableApplicationContext getApplicationContext()
          Gets the application context through which events can be broadcast
 NodeBulkLoader getBulkLoader()
          Get preloader - may be null if preloading is not supported
 MLAnalysisMode getDefaultMLIndexAnalysisMode()
          The default mode for analysing ML text during index.
 MLAnalysisMode getDefaultMLSearchAnalysisMode()
          The default mode for analysis of ML text during search.
 int getIndexerBatchSize()
          The batch size in which to group flushes of the index.
 int getIndexerMaxFieldLength()
          Get the max field length that determine how many tokens are put into the index
 java.lang.String getIndexRootLocation()
          The path to the index location
 int getMaxDocIdCacheSize()
          How many document ids to cache (-ve => unbounded)
 int getMaxDocsForInMemoryIndex()
          Max docs to allow for in memory indexes (does no apply to merges)
 int getMaxDocsForInMemoryMerge()
          Max doc number that will merged in memory (and not on disk)
 int getMaxDocumentCacheSize()
          How many documents to cache (-ve => unbounded)
 int getMaxIsCategoryCacheSize()
          How many categories to cache (-ve => unbounded)
 int getMaxLinkAspectCacheSize()
          How many link aspects to cache (-ve => unbounded)
 int getMaxParentCacheSize()
          How many parents to cache (-ve => unbounded)
 int getMaxPathCacheSize()
          How many paths to cache (-ve => unbounded)
 double getMaxRamInMbForInMemoryIndex()
          Max Ram to allow for in memory indexes (does not apply to merges)
 double getMaxRamInMbForInMemoryMerge()
          Ram based limit for in memory merges
 int getMaxTypeCacheSize()
          How many types to cache (-ve => unbounded)
 int getMergerMaxBufferedDocs()
          Lucene merger config
 int getMergerMaxMergeDocs()
          Lucene merger config
 int getMergerMergeBlockingFactor()
          The factor by which the merge factor is multiplied to determine the allowable number of indexes before blocking.
 int getMergerMergeFactor()
          Lucene merger config
 double getMergerRamBufferSizeMb()
          Ram based limit for in memory portion of merger index.
 int getMergerTargetIndexCount()
          Target index count.
 int getMergerTargetOverlayCount()
          Target overlays (will apply deletions and create indexes if over this limit)
 int getMergerTargetOverlaysBlockingFactor()
          The factor by which the target overlay count is multiplied to determine the allowable number of overlays before blocking.
 boolean getPostSortDateTime()
          If we are using the DateAnalyser then lucene sort is only to the date, as that is all that is in the index.
 int getQueryMaxClauses()
          The maximum numbr of sub-queries the can be generated out of wild card expansion etc
 int getTermIndexInterval()
          Lucene term index interval
 java.util.concurrent.ThreadPoolExecutor getThreadPoolExecutor()
          Get the thread pool for index merging etc
 boolean getUseNioMemoryMapping()
          Use the nio memory mapping (work arounf for bugs with some JVMs)
 int getWriterMaxBufferedDocs()
          Lucene writer config
 int getWriterMaxMergeDocs()
          Lucene writer config
 int getWriterMergeFactor()
          Lucene writer config
 double getWriterRamBufferSizeMb()
          Ram based limit for in memory portion of writer index.
 boolean isCacheEnabled()
          Is caching enabled for each index fragment?
 void setLockDirectory(java.lang.String lockDirectory)
          Set the lock dir - just to make sure - this should no longer be used.
 

Method Detail

setLockDirectory

void setLockDirectory(java.lang.String lockDirectory)
Set the lock dir - just to make sure - this should no longer be used.

Parameters:
lockDirectory -

getIndexRootLocation

java.lang.String getIndexRootLocation()
The path to the index location

Returns:

getIndexerBatchSize

int getIndexerBatchSize()
The batch size in which to group flushes of the index.

Returns:

getQueryMaxClauses

int getQueryMaxClauses()
The maximum numbr of sub-queries the can be generated out of wild card expansion etc

Returns:

getDefaultMLIndexAnalysisMode

MLAnalysisMode getDefaultMLIndexAnalysisMode()
The default mode for analysing ML text during index.

Returns:

getDefaultMLSearchAnalysisMode

MLAnalysisMode getDefaultMLSearchAnalysisMode()
The default mode for analysis of ML text during search.

Returns:

getIndexerMaxFieldLength

int getIndexerMaxFieldLength()
Get the max field length that determine how many tokens are put into the index

Returns:

getThreadPoolExecutor

java.util.concurrent.ThreadPoolExecutor getThreadPoolExecutor()
Get the thread pool for index merging etc

Returns:

getBulkLoader

NodeBulkLoader getBulkLoader()
Get preloader - may be null if preloading is not supported


getUseNioMemoryMapping

boolean getUseNioMemoryMapping()
Use the nio memory mapping (work arounf for bugs with some JVMs)

Returns:

getMaxDocsForInMemoryMerge

int getMaxDocsForInMemoryMerge()
Max doc number that will merged in memory (and not on disk)

Returns:

getWriterMaxBufferedDocs

int getWriterMaxBufferedDocs()
Lucene writer config

Returns:

getWriterMergeFactor

int getWriterMergeFactor()
Lucene writer config

Returns:

getWriterMaxMergeDocs

int getWriterMaxMergeDocs()
Lucene writer config

Returns:

getMergerMaxBufferedDocs

int getMergerMaxBufferedDocs()
Lucene merger config

Returns:

getMergerMergeFactor

int getMergerMergeFactor()
Lucene merger config

Returns:

getMergerMergeBlockingFactor

int getMergerMergeBlockingFactor()
The factor by which the merge factor is multiplied to determine the allowable number of indexes before blocking.

Returns:
the factor by which the merge factor is multiplied to determine the allowable number of indexes before blocking

getMergerMaxMergeDocs

int getMergerMaxMergeDocs()
Lucene merger config

Returns:

getMergerTargetOverlayCount

int getMergerTargetOverlayCount()
Target overlays (will apply deletions and create indexes if over this limit)

Returns:

getMergerTargetOverlaysBlockingFactor

int getMergerTargetOverlaysBlockingFactor()
The factor by which the target overlay count is multiplied to determine the allowable number of overlays before blocking.

Returns:
the factor by which the target overlay count is multiplied to determine the allowable number of overlays before blocking

getMergerTargetIndexCount

int getMergerTargetIndexCount()
Target index count. Over this indexes will be merged together.

Returns:

getTermIndexInterval

int getTermIndexInterval()
Lucene term index interval

Returns:

isCacheEnabled

boolean isCacheEnabled()
Is caching enabled for each index fragment?

Returns:

getMaxIsCategoryCacheSize

int getMaxIsCategoryCacheSize()
How many categories to cache (-ve => unbounded)

Returns:

getMaxDocumentCacheSize

int getMaxDocumentCacheSize()
How many documents to cache (-ve => unbounded)

Returns:

getMaxDocIdCacheSize

int getMaxDocIdCacheSize()
How many document ids to cache (-ve => unbounded)

Returns:

getMaxPathCacheSize

int getMaxPathCacheSize()
How many paths to cache (-ve => unbounded)

Returns:

getMaxTypeCacheSize

int getMaxTypeCacheSize()
How many types to cache (-ve => unbounded)

Returns:

getMaxParentCacheSize

int getMaxParentCacheSize()
How many parents to cache (-ve => unbounded)

Returns:

getMaxLinkAspectCacheSize

int getMaxLinkAspectCacheSize()
How many link aspects to cache (-ve => unbounded)

Returns:

getPostSortDateTime

boolean getPostSortDateTime()
If we are using the DateAnalyser then lucene sort is only to the date, as that is all that is in the index. If this is true, a query that defines a sort on a datetime field will do a post sort in Java. For the DateTimeAnalyser no post sort is done. (The default config does do a post sort) In the future, this behaviour may also be set per query on the SearchParameters object.

Returns:

getApplicationContext

org.springframework.context.ConfigurableApplicationContext getApplicationContext()
Gets the application context through which events can be broadcast

Returns:

getMaxRamInMbForInMemoryMerge

double getMaxRamInMbForInMemoryMerge()
Ram based limit for in memory merges

Returns:

getWriterRamBufferSizeMb

double getWriterRamBufferSizeMb()
Ram based limit for in memory portion of writer index.

Returns:

getMergerRamBufferSizeMb

double getMergerRamBufferSizeMb()
Ram based limit for in memory portion of merger index.

Returns:

getMaxDocsForInMemoryIndex

int getMaxDocsForInMemoryIndex()
Max docs to allow for in memory indexes (does no apply to merges)

Returns:

getMaxRamInMbForInMemoryIndex

double getMaxRamInMbForInMemoryIndex()
Max Ram to allow for in memory indexes (does not apply to merges)

Returns:


Copyright © 2005 - 2010 Alfresco Software, Inc. All Rights Reserved.