net.sf.mmm.search.indexer.impl.lucene

Class LuceneMutableSearchEntry

java.lang.Object

net.sf.mmm.util.component.base.AbstractLoggableObject

net.sf.mmm.search.base.AbstractSearchEntry

net.sf.mmm.search.base.BasicSearchEntry

net.sf.mmm.search.indexer.base.AbstractMutableSearchEntry

net.sf.mmm.search.indexer.impl.lucene.LuceneMutableSearchEntry

All Implemented Interfaces:

SearchEntry, MutableSearchEntry, AttributeReadId<Long>

public class LuceneMutableSearchEntry
extends AbstractMutableSearchEntry

This is the implementation of the MutableSearchEntry interface using lucene as underlying search-engine.

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
private org.apache.lucene.document.Document	document The lucene document that represents the actual entry.
private LuceneFieldManager	fieldManager The LuceneFieldManager.
private List<Reader>	readers

Fields inherited from interface net.sf.mmm.search.api.SearchEntry

FIELD_CREATOR, FIELD_CUSTOM_ID, FIELD_ID, FIELD_KEYWORDS, FIELD_LANGUAGE, FIELD_SIZE, FIELD_SOURCE, FIELD_TEXT, FIELD_TITLE, FIELD_TYPE, FIELD_URI

Constructor Summary

Constructors

Constructor and Description
LuceneMutableSearchEntry(org.apache.lucene.document.Document document, LuceneFieldManager fieldManager, SearchDependencies searchDependencies) The constructor.

Method Summary

Modifier and Type	Method and Description
void	dispose() This method is called to dispose this entry.
Iterator<String>	getFieldNames() This method gets the names of all fields that are defined (NOT null).
protected Object	getFieldRaw(String name)
org.apache.lucene.document.Document	getLuceneDocument() This method gets the unwrapped lucene document.
void	setBoost(double boost) This method sets the boost of this this entry.
void	setField(String name, Object value) This method sets the field with the given name to the given value.

Methods inherited from class net.sf.mmm.search.indexer.base.AbstractMutableSearchEntry

setCreator, setCustomId, setKeywords, setSize, setSource, setText, setTitle, setType, setUri

Methods inherited from class net.sf.mmm.search.base.BasicSearchEntry

getField, getField, getSearchDependencies, getSearchFields

Methods inherited from class net.sf.mmm.search.base.AbstractSearchEntry

equals, getCreator, getCustomId, getFieldAsString, getId, getSize, getSource, getText, getTitle, getType, getUri, hashCode, toString

Methods inherited from class net.sf.mmm.util.component.base.AbstractLoggableObject

getLogger

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.sf.mmm.search.api.SearchEntry

getCreator, getCustomId, getField, getField, getFieldAsString, getId, getSize, getSource, getText, getTitle, getType, getUri

Field Detail

document

private final org.apache.lucene.document.Document document

The lucene document that represents the actual entry.

fieldManager

private final LuceneFieldManager fieldManager

The LuceneFieldManager.

readers

private List<Reader> readers

See Also:

dispose()

Constructor Detail

LuceneMutableSearchEntry

public LuceneMutableSearchEntry(org.apache.lucene.document.Document document,
                                LuceneFieldManager fieldManager,
                                SearchDependencies searchDependencies)

The constructor.

Parameters:

document - is the lucene document that represents the actual entry.

fieldManager - is the LuceneFieldManager.

searchDependencies - are the SearchDependencies.

Method Detail

getLuceneDocument

public org.apache.lucene.document.Document getLuceneDocument()

This method gets the unwrapped lucene document.

Returns:

the lucene document.

setBoost

public void setBoost(double boost)

This method sets the boost of this this entry. The boost is a positive value. The higher the boost, the

Parameters:

boost - is the

setField

public void setField(String name,
                     Object value)

This method sets the field with the given name to the given value.
It is forbidden to change the value of SearchEntry.FIELD_ID and doing so will cause an exception.
For the supported types see SearchFieldType. Additionally Reader can be used to index large texts.
ATTENTION:
A value of the type Reader should only be used when indexing really large texts. In this case the mode has to be SearchFieldMode.SEARCHABLE and type has to be SearchFieldType.TEXT (NOT Reader). Further the Reader will only be closed when the MutableSearchEntry has been added or updated. If you never write the MutableSearchEntry to the index for some reason, you are responsible for closing the reader.

Parameters:

name - is the name of the field. E.g. SearchEntry.FIELD_TEXT.

value - is the value of the field to set.

getFieldRaw

protected Object getFieldRaw(String name)

Specified by:

getFieldRaw in class BasicSearchEntry

Parameters:

name - is the name of the requested field.

Returns:

the raw value of the field as it is given by the underlying search technology.

See Also:

BasicSearchEntry.getField(String)

getFieldNames

public Iterator<String> getFieldNames()

This method gets the names of all fields that are defined (NOT null).

Returns:

a read-only iterator of the field names.

dispose

public void dispose()

This method is called to dispose this entry.