net.sf.mmm.search.base

Class AbstractSearchEntry

java.lang.Object

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

net.sf.mmm.search.base.AbstractSearchEntry

All Implemented Interfaces:

SearchEntry, AttributeReadId<Long>

Direct Known Subclasses:

BasicSearchEntry, SearchHitImpl

public abstract class AbstractSearchEntry
extends AbstractLoggableObject
implements SearchEntry

This is the abstract base implementation of the SearchEntry interface.

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

Constructor Summary

Constructors

Constructor and Description
AbstractSearchEntry() The constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object object)
String	getCreator() This method gets the author of this entry.
Object	getCustomId() This method gets the value of the custom-ID field.
String	getFieldAsString(String name) This method is a shortcut for getField(name, String.class).
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 SearchEntry.FIELD_URI.
int	hashCode()
String	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

getField, getField, getFieldNames

Constructor Detail

AbstractSearchEntry

public AbstractSearchEntry()

The constructor.

Method Detail

getTitle

public String getTitle()

This method gets the value of the title field.

Specified by:

getTitle in interface SearchEntry

Returns:

the title of this entry.

See Also:

SearchEntry.FIELD_TITLE

getUri

public String getUri()

This method gets the value of the SearchEntry.FIELD_URI.

Specified by:

getUri in interface SearchEntry

Returns:

the URI of this entry.

See Also:

SearchEntry.FIELD_URI

getId

public Long getId()

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

Specified by:

getId in interface SearchEntry

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:

SearchEntry.FIELD_ID

getCustomId

public Object getCustomId()

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

Specified by:

getCustomId in interface SearchEntry

Returns:

the UID of this entry or null if NOT available.

See Also:

SearchEntry.FIELD_CUSTOM_ID

getText

public String getText()

This method gets the value of the text field.

Specified by:

getText in interface SearchEntry

Returns:

the text of this entry.

See Also:

SearchEntry.FIELD_TEXT

getType

public String getType()

This method gets the value of the type field.

Specified by:

getType in interface SearchEntry

Returns:

the type of this entry or null if NOT available.

See Also:

SearchEntry.FIELD_TYPE

getCreator

public String getCreator()

This method gets the author of this entry.

Specified by:

getCreator in interface SearchEntry

Returns:

the author of this entry or null if NOT available.

See Also:

SearchEntry.FIELD_CREATOR

getSource

public String getSource()

This method gets the value of the source field.

Specified by:

getSource in interface SearchEntry

Returns:

the source of this entry or null if NOT available.

See Also:

SearchEntry.FIELD_SOURCE

getSize

public Long getSize()

This method gets the size of the content.

Specified by:

getSize in interface SearchEntry

Returns:

the size of this entry or null if NOT available.

See Also:

SearchEntry.FIELD_SIZE

getFieldAsString

public String getFieldAsString(String name)

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

Specified by:

getFieldAsString in interface SearchEntry

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.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object object)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object