|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.modeshape.search.lucene.LuceneConfigurations
public class LuceneConfigurations
A family of LuceneConfiguration
implementations.
Nested Class Summary | |
---|---|
static class |
LuceneConfigurations.FileSystemDirectoryFromNameFactory
A LuceneConfiguration implementation that creates FSDirectory instances for each workspace and index name. |
protected static class |
LuceneConfigurations.IndexId
|
protected static class |
LuceneConfigurations.PoolingDirectoryFactory<DirectoryType extends org.apache.lucene.store.Directory>
A LuceneConfiguration implementation that creates Directory instances of the supplied type for each
workspace and pools the results, ensuring that the same Directory instance is always returned for the same
workspace name. |
static class |
LuceneConfigurations.RamDirectoryFactory
A LuceneConfiguration implementation that creates RAMDirectory instances for each workspace and index name. |
Constructor Summary | |
---|---|
LuceneConfigurations()
|
Method Summary | |
---|---|
static LuceneConfiguration |
inMemory()
Return a new LuceneConfiguration that creates in-memory directories. |
static LuceneConfiguration |
using(File parent)
Return a new LuceneConfiguration that creates FSDirectory instances mapped to folders under a parent
folder, where the workspace name is used to create the workspace folder. |
static LuceneConfiguration |
using(File parent,
org.apache.lucene.store.LockFactory lockFactory)
Return a new LuceneConfiguration that creates FSDirectory instances mapped to folders under a parent
folder, where the workspace name is used to create the workspace folder. |
static LuceneConfiguration |
using(File parent,
org.apache.lucene.store.LockFactory lockFactory,
TextEncoder workspaceNameEncoder,
TextEncoder indexNameEncoder)
Return a new LuceneConfiguration that creates FSDirectory instances mapped to folders under a parent
folder, where the workspace name is used to create the workspace folder. |
static LuceneConfiguration |
using(File parent,
TextEncoder workspaceNameEncoder,
TextEncoder indexNameEncoder)
Return a new LuceneConfiguration that creates FSDirectory instances mapped to folders under a parent
folder, where the workspace name is used to create the workspace folder. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public LuceneConfigurations()
Method Detail |
---|
public static final LuceneConfiguration inMemory()
LuceneConfiguration
that creates in-memory directories.
public static final LuceneConfiguration using(File parent)
LuceneConfiguration
that creates FSDirectory
instances mapped to folders under a parent
folder, where the workspace name is used to create the workspace folder. Note that this has ramifications on the allowable
workspace names.
parent
- the parent folder
IllegalArgumentException
- if the parent file is nullpublic static final LuceneConfiguration using(File parent, org.apache.lucene.store.LockFactory lockFactory)
LuceneConfiguration
that creates FSDirectory
instances mapped to folders under a parent
folder, where the workspace name is used to create the workspace folder. Note that this has ramifications on the allowable
workspace names.
parent
- the parent folderlockFactory
- the lock factory; may be null
IllegalArgumentException
- if the parent file is nullpublic static final LuceneConfiguration using(File parent, TextEncoder workspaceNameEncoder, TextEncoder indexNameEncoder)
LuceneConfiguration
that creates FSDirectory
instances mapped to folders under a parent
folder, where the workspace name is used to create the workspace folder. Note that this has ramifications on the allowable
workspace names.
parent
- the parent folderworkspaceNameEncoder
- the encoder that should be used for encoding the workspace name into a directory nameindexNameEncoder
- the encoder that should be used for encoding the index name into a directory name
IllegalArgumentException
- if the parent file is nullpublic static final LuceneConfiguration using(File parent, org.apache.lucene.store.LockFactory lockFactory, TextEncoder workspaceNameEncoder, TextEncoder indexNameEncoder)
LuceneConfiguration
that creates FSDirectory
instances mapped to folders under a parent
folder, where the workspace name is used to create the workspace folder. Note that this has ramifications on the allowable
workspace names.
parent
- the parent folderlockFactory
- the lock factory; may be nullworkspaceNameEncoder
- the encoder that should be used for encoding the workspace name into a directory nameindexNameEncoder
- the encoder that should be used for encoding the index name into a directory name
IllegalArgumentException
- if the parent file is null
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |