|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectfr.gouv.culture.sdx.utils.SdxObjectImpl
fr.gouv.culture.sdx.utils.lucene.LuceneDataStore
fr.gouv.culture.sdx.search.lucene.query.LuceneIndex
Information and services related to a LuceneIndex.
From here we can get an IndexReader, a Searcher, and know a little more about defined fields.
Field Summary | |
static int |
ACTION_ADD_DOCUMENT
int representation of indexing action for adding a document. |
protected java.util.Date |
creationTimestamp
|
static int |
DEFAULT_MAX_FIELD_LENGTH
Defaults for IndexWriter parameters; these are based on lucene defaults |
static int |
DEFAULT_MAX_MERGE_DOCS
Defaults for IndexWriter parameters; these are based on lucene defaults |
static int |
DEFAULT_MERGE_FACTOR
Defaults for IndexWriter parameters; these are based on lucene defaults |
protected java.util.Date |
lastModificationTimestamp
|
Fields inherited from class fr.gouv.culture.sdx.utils.lucene.LuceneDataStore |
ALL_FIELD, ALL_VALUE, analyzer, fsd, fsdFile, ID_FIELD, LUCENE_CHECK_FILE, searcher, XML_LANG_FIELD |
Fields inherited from class fr.gouv.culture.sdx.utils.SdxObjectImpl |
encoding, logger |
Constructor Summary | |
LuceneIndex(java.io.File dir,
java.lang.String host,
java.lang.Integer port,
java.lang.String appId,
java.lang.String dbId)
Builds an index with fields definition and a path to the index files. |
Method Summary | |
void |
configure(org.apache.avalon.framework.configuration.Configuration configuration)
|
void |
deleteDocument(java.lang.String docId)
Deletes a document from the index. |
protected void |
freeResources()
Free's the resources associated with this index USE WITH CARE! |
java.util.Date |
getCreationDate()
|
Field |
getDefaultField()
Returns the default field for this index. |
Field |
getField(java.lang.String name)
Returns a field given a name. |
FieldsDefinition |
getFieldsDefinition()
Returns a the FieldsDefinition for this index (basically a Hashtable of all the Fields) |
int |
getFieldType(java.lang.String name)
Returns the type of a field. |
java.lang.String |
getFieldValue(IndexableDocument doc,
java.lang.String fieldName)
|
java.util.Date |
getLastModificationDate()
|
java.util.Locale |
getLocale(java.lang.String name)
Returns the locale for a field. |
MetaAnalyzer |
getMetaAnalyzer()
Gets the MetaAnalyzer |
QueryParser |
getQueryParser()
|
org.apache.lucene.index.IndexReader |
getReader()
Returns an index reader for the current FSDirectory. |
java.lang.String |
getRemoteIndexName()
|
org.apache.lucene.search.Searchable |
getSearcher()
Gets a searcher. |
protected org.apache.lucene.index.IndexWriter |
getWriter(org.apache.lucene.store.Directory directory)
Get's an IndexWriter based upon the analyzer class field and the provided Lucene Directory |
void |
init()
Initializes the Lucene database. |
void |
mergeBatch()
Merge's any batch in memory, if no batch then it optimizes the lucene index |
void |
optimize()
Optimizeds the index for the current FSDirectory. |
void |
setMetaAnalyzer(MetaAnalyzer mAnalyzer)
Sets the MetaAnalyzer |
void |
setParameters(LuceneIndexParameters params)
Set's parameters for this lucene index |
protected void |
writeCreationTimestampFile()
|
void |
writeDocument(org.apache.lucene.document.Document ldoc,
boolean batchIndex)
Stores a Lucene document within the database. |
void |
writeLastModificationTimestampFile(boolean create)
|
Methods inherited from class fr.gouv.culture.sdx.utils.lucene.LuceneDataStore |
delete, delete, delete, delete, finalize, getFSDirectory, getIndexPath, getWriter, init, recycleSearcher, search, search, size, verifyIndex, write, writeLuceneData |
Methods inherited from class fr.gouv.culture.sdx.utils.SdxObjectImpl |
enableLogging, getChildLogger, setEncoding |
Methods inherited from class java.lang.Object |
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
protected java.util.Date creationTimestamp
protected java.util.Date lastModificationTimestamp
public static final int ACTION_ADD_DOCUMENT
public static final int DEFAULT_MAX_FIELD_LENGTH
public static final int DEFAULT_MAX_MERGE_DOCS
public static final int DEFAULT_MERGE_FACTOR
Constructor Detail |
public LuceneIndex(java.io.File dir, java.lang.String host, java.lang.Integer port, java.lang.String appId, java.lang.String dbId) throws SDXException
dir
- A directory where the index is kept.
TODOJavadocMethod Detail |
public void configure(org.apache.avalon.framework.configuration.Configuration configuration) throws org.apache.avalon.framework.configuration.ConfigurationException
configure
in interface org.apache.avalon.framework.configuration.Configurable
org.apache.avalon.framework.configuration.ConfigurationException
public void init() throws SDXException
It the index exists, nothing is done here. If it is doesn't exist, it will be created.
SDXException
protected void writeCreationTimestampFile()
public void writeLastModificationTimestampFile(boolean create)
public int getFieldType(java.lang.String name)
name
- The name of the field for which the type is desired.
public java.util.Locale getLocale(java.lang.String name)
name
- The name of the field for which the Locale is desired.public Field getDefaultField()
getDefaultField
in interface Index
public Field getField(java.lang.String name)
getField
in interface Index
name
- The name of the field for which the Field is desired.public FieldsDefinition getFieldsDefinition()
public org.apache.lucene.search.Searchable getSearcher()
getSearcher
in interface Index
getSearcher
in class LuceneDataStore
public MetaAnalyzer getMetaAnalyzer()
public void setMetaAnalyzer(MetaAnalyzer mAnalyzer) throws SDXException
mAnalyzer
- A MetaAnalyzer object containing a FieldsDefinition object for this index.
SDXException
public void writeDocument(org.apache.lucene.document.Document ldoc, boolean batchIndex) throws SDXException
ldoc
- The Lucene document to store.batchIndex
- Indicates wheter a tempBatch index is taking place or not. Useful for efficiency of index optimizations
SDXException
public void deleteDocument(java.lang.String docId) throws SDXException
docId
- The document's id.
SDXException
public QueryParser getQueryParser() throws java.io.IOException, SDXException
getQueryParser
in interface Index
java.io.IOException
SDXException
public java.lang.String getRemoteIndexName()
public void mergeBatch() throws SDXException
SDXException
protected void freeResources() throws java.io.IOException
freeResources
in class LuceneDataStore
java.io.IOException
- Lucene IOExceptionsprotected org.apache.lucene.index.IndexWriter getWriter(org.apache.lucene.store.Directory directory) throws java.io.IOException
LuceneDataStore
getWriter
in class LuceneDataStore
directory
- The lucene directory for which the writer is desired
java.io.IOException
public void setParameters(LuceneIndexParameters params)
params
- The parameters relevent to this lucene index.public void optimize() throws SDXException
LuceneDataStore
optimize
in class LuceneDataStore
SDXException
public org.apache.lucene.index.IndexReader getReader() throws SDXException
LuceneDataStore
getReader
in class LuceneDataStore
SDXException
public java.lang.String getFieldValue(IndexableDocument doc, java.lang.String fieldName) throws SDXException
SDXException
public java.util.Date getCreationDate()
public java.util.Date getLastModificationDate()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |