org.opencms.search
Class CmsSearchResult

java.lang.Object
  org.opencms.search.CmsSearchResult

All Implemented Interfaces:

Comparable, I_CmsMemoryMonitorable

public class CmsSearchResult
extends Object
implements I_CmsMemoryMonitorable, Comparable

Contains the data of a single item in a search result.

Since:

6.0.0

Version:

$Revision: 1.19 $

Author:

Thomas Weckert

Field Summary

protected Date	m_dateCreated The creation date of this search result.
protected Date	m_dateLastModified The last modification date of this search result.
protected String	m_description The description of this search result.
protected String	m_excerpt The excerpt of this search result.
protected String	m_keyWords The key words of this search result.
protected String	m_path The resource path of this search result.
protected int	m_score The score of this search result.
protected String	m_title The title of this search result.

Constructor Summary

protected

CmsSearchResult(int score, Document luceneDocument, String excerpt) Creates a new search result.

Method Summary

int	compareTo(Object obj)
Date	getDateCreated() Returns the date created.
Date	getDateLastModified() Returns the date last modified.
String	getDescription() Returns the description.
String	getExcerpt() Returns the excerpt.
String	getKeywords() Returns the key words.
int	getMemorySize() Returns the memory size of the object.
String	getPath() Returns the path.
int	getScore() Returns the score.
String	getTitle() Returns the title.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

m_dateCreated

protected Date m_dateCreated

The creation date of this search result.

m_dateLastModified

protected Date m_dateLastModified

The last modification date of this search result.

m_description

protected String m_description

The description of this search result.

m_excerpt

protected String m_excerpt

The excerpt of this search result.

m_keyWords

protected String m_keyWords

The key words of this search result.

m_path

protected String m_path

The resource path of this search result.

m_score

protected int m_score

The score of this search result.

m_title

protected String m_title

The title of this search result.

Constructor Detail

CmsSearchResult

protected CmsSearchResult(int score,
                          Document luceneDocument,
                          String excerpt)

Creates a new search result.

Parameters:

score - the score of this search result

luceneDocument - the Lucene document to extract fields from such as description, title, key words etc. pp.

excerpt - the excerpt of the search result's content

Method Detail

compareTo

public int compareTo(Object obj)

Specified by:

compareTo in interface Comparable

See Also:

Comparable.compareTo(java.lang.Object)

getDateCreated

public Date getDateCreated()

Returns the date created.

Returns:

the date created

getDateLastModified

public Date getDateLastModified()

Returns the date last modified.

Returns:

the date last modified

getDescription

public String getDescription()

Returns the description.

Returns:

the description

getExcerpt

public String getExcerpt()

Returns the excerpt.

Returns:

the excerpt

getKeywords

public String getKeywords()

Returns the key words.

Returns:

the key words

getMemorySize

public int getMemorySize()

Description copied from interface: I_CmsMemoryMonitorable

Returns the memory size of the object.

Specified by:

getMemorySize in interface I_CmsMemoryMonitorable

Returns:

the memory size of the object

See Also:

I_CmsMemoryMonitorable.getMemorySize()

getPath

public String getPath()

Returns the path.

Returns:

the path

getScore

public int getScore()

Returns the score.

Returns:

the score

getTitle

public String getTitle()

Returns the title.

Returns:

the title