net.sf.mmm.search.indexer.api

Interface MutableSearchEntry

All Superinterfaces:

AttributeReadId<Long>, SearchEntry

All Known Implementing Classes:

AbstractMutableSearchEntry, LuceneMutableSearchEntry

public interface MutableSearchEntry
extends SearchEntry

This is the interface for an entry in the search index.

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

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

Method Summary

Modifier and Type	Method and Description
void	setBoost(double boost) This method sets the boost of this this entry.
void	setCreator(String author) This method sets the creator.
void	setCustomId(Object cid) This method sets the UID.
void	setField(String name, Object value) This method sets the field with the given name to the given value.
void	setKeywords(String keywords) This method sets the keywords.
void	setSize(long size) This method sets the size.
void	setSource(String source) This method sets the source.
void	setText(String text) This method sets the text.
void	setTitle(String title) This method sets the title.
void	setType(String type) This method sets the type.
void	setUri(String uri) This method sets the URI.

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

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

Method Detail

setField

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.

setUri

void setUri(String uri)

This method sets the URI.

Parameters:

uri - is the URI to set.

See Also:

setField(String, Object), SearchEntry.getUri()

setCustomId

void setCustomId(Object cid)

This method sets the UID.

Parameters:

cid - is the UID to set.

See Also:

setField(String, Object), SearchEntry.getCustomId()

setTitle

void setTitle(String title)

This method sets the title.

Parameters:

title - is the title to set.

See Also:

setField(String, Object), SearchEntry.getTitle()

setText

void setText(String text)

This method sets the text.

Parameters:

text - is the text to set.

See Also:

setField(String, Object)

setKeywords

void setKeywords(String keywords)

This method sets the keywords.

Parameters:

keywords - are the keywords to set.

See Also:

setField(String, Object)

setCreator

void setCreator(String author)

This method sets the creator.

Parameters:

author - is the author to set.

See Also:

setField(String, Object)

setType

void setType(String type)

This method sets the type.

Parameters:

type - is the type to set.

See Also:

setField(String, Object), SearchEntry.getType()

setSource

void setSource(String source)

This method sets the source.

Parameters:

source - is the source to set.

See Also:

setField(String, Object), SearchEntry.getSource()

setSize

void setSize(long size)

This method sets the size.

Parameters:

size - is the size to set.

See Also:

setField(String, Object), SearchEntry.getSource()

setBoost

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