net.sf.mmm.search.base

Class BasicSearchEntry

java.lang.Object

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

net.sf.mmm.search.base.AbstractSearchEntry

net.sf.mmm.search.base.BasicSearchEntry

All Implemented Interfaces:

SearchEntry, AttributeReadId<Long>

Direct Known Subclasses:

AbstractMutableSearchEntry, LuceneSearchEntry

public abstract class BasicSearchEntry
extends AbstractSearchEntry

This is the abstract base implementation of the SearchEntry interface.

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
private SearchDependencies	searchDependencies
private SearchFields	searchFields

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
BasicSearchEntry(SearchFields searchFields, SearchDependencies searchDependencies) The constructor.

Method Summary

Modifier and Type	Method and Description
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.
protected abstract Object	getFieldRaw(String name)
protected SearchDependencies	getSearchDependencies() This method gets the SearchDependencies.
protected SearchFields	getSearchFields() This method gets the SearchFields.

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

getFieldNames

Field Detail

searchDependencies

private final SearchDependencies searchDependencies

See Also:

getSearchDependencies()

searchFields

private final SearchFields searchFields

See Also:

getSearchFields()

Constructor Detail

BasicSearchEntry

public BasicSearchEntry(SearchFields searchFields,
                        SearchDependencies searchDependencies)

The constructor.

Parameters:

searchFields - are the SearchFields.

searchDependencies - are the SearchDependencies.

Method Detail

getSearchFields

protected SearchFields getSearchFields()

This method gets the SearchFields.

Returns:

the SearchFields.

getSearchDependencies

protected SearchDependencies getSearchDependencies()

This method gets the SearchDependencies.

Returns:

the SearchDependencies.

getFieldRaw

protected abstract Object getFieldRaw(String name)

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:

getField(String)

getField

public Object getField(String name)

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

Parameters:

name - is the name of the requested field.

Returns:

the value of the field in its original type.

See Also:

SearchEntry.getField(String, Class)

getField

public <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.