net.sf.mmm.search.api

Interface SearchEntry

All Superinterfaces:

AttributeReadId<Long>

All Known Subinterfaces:

MutableSearchEntry, SearchHit

All Known Implementing Classes:

AbstractMutableSearchEntry, AbstractSearchEntry, BasicSearchEntry, LuceneMutableSearchEntry, LuceneSearchEntry, SearchHitImpl

public interface SearchEntry
extends AttributeReadId<Long>

This interface represents an entry of the search-index. A SearchEntry represents a single content (file, web-page, etc.) and consists of fields with the according metadata. It is either used for indexing (net.sf.mmm.search.indexer.api.SearchIndexer) or retrieval.

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

See Also:

SearchFields, SearchHit

Field Summary

Fields

Modifier and Type	Field and Description
static String	FIELD_CREATOR The name of the "creator" field.
static String	FIELD_CUSTOM_ID The name of the "cid" field.
static String	FIELD_ID The name of the "id" field.
static String	FIELD_KEYWORDS The name of the "keywords" field.
static String	FIELD_LANGUAGE The name of the "lang" field.
static String	FIELD_SIZE The name of the "size" field.
static String	FIELD_SOURCE The name of the "source" field.
static String	FIELD_TEXT The name of the "text" field.
static String	FIELD_TITLE The name of the "title" field.
static String	FIELD_TYPE The name of the "type" field.
static String	FIELD_URI The name of the "uri" field.

Method Summary

Modifier and Type	Method and Description
String	getCreator() This method gets the author of this entry.
Object	getCustomId() This method gets the value of the custom-ID field.
Object	getField(String name) This method is a generic accessor for fields of this entry.
<T> T	getField(String name, Class<T> type) This method is a generic accessor for fields of this entry with a specific type.
String	getFieldAsString(String name) This method is a shortcut for getField(name, String.class).
Iterator<String>	getFieldNames() This method gets the names of all fields that are defined (NOT null).
Long	getId() This method gets the ID used to identify this object.
Long	getSize() This method gets the size of the content.
String	getSource() This method gets the value of the source field.
String	getText() This method gets the value of the text field.
String	getTitle() This method gets the value of the title field.
String	getType() This method gets the value of the type field.
String	getUri() This method gets the value of the FIELD_URI.

Field Detail

FIELD_ID

static final String FIELD_ID

The name of the "id" field. The UID (Unique Identifier) is a field that identifies the content uniquely.
It is strongly suggested for the implementation but NOT strictly guaranteed that the ID remains the same if a SearchEntry is updated in the index. The ID is a Long value. End-users should never make any assumptions or interpretation of its value as this is totally implementation specific.

See Also:

getId(), Constant Field Values

FIELD_TITLE

static final String FIELD_TITLE

The name of the "title" field. The title should always be present.

See Also:

Constant Field Values

FIELD_URI

static final String FIELD_URI

The name of the "uri" field. The URI (Unified Resource Identifier) identifies the original content and allows to link to it. Typically this is not an entire URL but a path relative to the URL-prefix of the according source.
NOTE:
This field should typically be present. Only if the content has a technical UID, the FIELD_CUSTOM_ID can be used for linking the content and the URI might NOT be set then. However it is best practice to set the URI anyways (to the URL-suffix containing the UID for linking the content).

See Also:

getUri(), Constant Field Values

FIELD_CUSTOM_ID

static final String FIELD_CUSTOM_ID

The name of the "cid" field. The custom Identifier (CID) is an optional field that identifies the content uniquely. Unlike the ID this is an optional custom ID given by the user of this API. It can be in any arbitrary format. While the URI of a content may change (e.g. if the content is renamed or moved) the UID has to stay untouched and identifies the content for its complete lifetime.

See Also:

getCustomId(), Constant Field Values

FIELD_TEXT

static final String FIELD_TEXT

The name of the "text" field. This is the default field to search on. All textual information about the content should be stored in this field.

See Also:

getText(), Constant Field Values

FIELD_KEYWORDS

static final String FIELD_KEYWORDS

The name of the "keywords" field. This is an optional field that may hold specific keywords (also called tags) that classify the content.

See Also:

Constant Field Values

FIELD_SIZE

static final String FIELD_SIZE

The name of the "size" field. This is an optional field that may hold the size (also called content-length) of the content. This should be a Long value representing the size in bytes.

See Also:

getSize(), Constant Field Values

FIELD_CREATOR

static final String FIELD_CREATOR

The name of the "creator" field. This is an optional field that may hold the author (aka artist) of the content.

See Also:

getCreator(), Constant Field Values

FIELD_TYPE

static final String FIELD_TYPE

The name of the "type" field. This is an optional field that classifies the type (aka format or content-type) of the content. As values typically either mime-types or file-extensions are used (but NOT mixed).

See Also:

getType(), Constant Field Values

FIELD_LANGUAGE

static final String FIELD_LANGUAGE

The name of the "lang" field. This is an optional field that specifies the language of the content.

See Also:

Constant Field Values

FIELD_SOURCE

static final String FIELD_SOURCE

The name of the "source" field. This field specifies the source of the content. It is not strictly required but should always be present in a regular setup. If it is NOT present, the field URI has to contain the complete URL to the content.

See Also:

getSource(), SearchSource, Constant Field Values

Method Detail

getField

Object getField(String name)

This method is a generic accessor for fields of this entry. For the predefine fields (see FIELD_* constants like FIELD_TEXT) there are specific getter methods like getText().

Parameters:

name - is the name of the requested field.

Returns:

the value of the field in its original type.

See Also:

getField(String, Class)

getFieldAsString

String getFieldAsString(String name)

This method is a shortcut for getField(name, String.class).

Parameters:

name - is the name of the requested field.

Returns:

the value of the requested field or null if no field exists for the given name.

getField

<T> T getField(String name,
               Class<T> type)

This method is a generic accessor for fields of this entry with a specific type.
The type String will always work. Other types have to be compatible to the field type (or a RuntimeException will be thrown).

Type Parameters:

T - is the generic type expected for the requested field-value (see parameter type).

Parameters:

name - is the name of the requested field.

type - is the type of the requested field.

Returns:

the value of the requested field or null if no field exists for the given name.

getFieldNames

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.

getUri

String getUri()

This method gets the value of the FIELD_URI.

Returns:

the URI of this entry.

See Also:

FIELD_URI

getCustomId

Object getCustomId()

This method gets the value of the custom-ID field.

Returns:

the UID of this entry or null if NOT available.

See Also:

FIELD_CUSTOM_ID

getTitle

String getTitle()

This method gets the value of the title field.

Returns:

the title of this entry.

See Also:

FIELD_TITLE

getCreator

String getCreator()

This method gets the author of this entry.

Returns:

the author of this entry or null if NOT available.

See Also:

FIELD_CREATOR

getText

String getText()

This method gets the value of the text field.

Returns:

the text of this entry.

See Also:

FIELD_TEXT

getType

String getType()

This method gets the value of the type field.

Returns:

the type of this entry or null if NOT available.

See Also:

FIELD_TYPE

getSource

String getSource()

This method gets the value of the source field.

Returns:

the source of this entry or null if NOT available.

See Also:

FIELD_SOURCE

getSize

Long getSize()

This method gets the size of the content.

Returns:

the size of this entry or null if NOT available.

See Also:

FIELD_SIZE

getId

Long getId()

This method gets the ID used to identify this object. An ID should be unique.

Specified by:

getId in interface AttributeReadId<Long>

Returns:

the ID of this entry or null if the entry is transient and has not yet been added to the search-index (made persistent).

See Also:

FIELD_ID