Package org.opencms.search

Class CmsSearchResult

java.lang.Object

org.opencms.search.CmsSearchResult

All Implemented Interfaces:

Comparable<CmsSearchResult>, I_CmsMemoryMonitorable

public class CmsSearchResult
extends Object
implements I_CmsMemoryMonitorable, Comparable<CmsSearchResult>

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

Since:

6.0.0

Field Summary

Fields

Modifier and Type	Field	Description
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_documentType	The document type of the search result.
protected String	m_excerpt	The excerpt of this search result.
protected Map<String,String>	m_fields	Holds the values of the search result fields.
protected String	m_path	The resource path of this search result.
protected int	m_score	The score of this search result.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CmsSearchResult()	Empty constructor to be used for overriding classes.
	CmsSearchResult(int score, org.apache.lucene.document.Document doc, String excerpt)	Creates a new search result.

Method Summary

Modifier and Type	Method	Description
int	compareTo(CmsSearchResult obj)
boolean	equals(Object obj)
Date	getDateCreated()	Returns the date created.
Date	getDateLastModified()	Returns the date last modified.
String	getDescription()	Deprecated. use getField(String) instead with the name of the field, for example use CmsSearchField.FIELD_DESCRIPTION to get the description (if available)
String	getDocumentType()	Returns the document type of the search result document.
String	getExcerpt()	Returns the excerpt.
String	getField(String fieldName)	Returns the text stored in the search index field with the given name.
String	getKeywords()	Deprecated. use getField(String) instead with the name of the field, for example use CmsSearchField.FIELD_KEYWORDS to get the keywords (if available)
int	getMemorySize()	Returns the memory size of the object.
String	getPath()	Returns the path.
int	getScore()	Returns the score.
String	getTitle()	Deprecated. use getField(String) instead with the name of the field, for example use CmsSearchField.FIELD_TITLE to get the title (if available)
int	hashCode()

Methods inherited from class java.lang.Object

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

Field Details

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_documentType

protected String m_documentType

The document type of the search result.

m_excerpt

protected String m_excerpt

The excerpt of this search result.

m_fields

protected Map<String,String> m_fields

Holds the values of the search result fields.

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.

Constructor Details

CmsSearchResult

public CmsSearchResult(int score,
 org.apache.lucene.document.Document doc,
 String excerpt)

Creates a new search result.

Parameters:

score - the score of this search result

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

excerpt - the excerpt of the search result's content

CmsSearchResult

protected CmsSearchResult()

Empty constructor to be used for overriding classes.

Method Details

compareTo

public int compareTo(CmsSearchResult obj)

Specified by:

compareTo in interface Comparable<CmsSearchResult>

See Also:

• Comparable.compareTo(java.lang.Object)

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

See Also:

• Object.equals(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

@Deprecated
public String getDescription()

Deprecated.

use getField(String) instead with the name of the field, for example use CmsSearchField.FIELD_DESCRIPTION to get the description (if available)

Returns the description.

Returns:

the description

getDocumentType

public String getDocumentType()

Returns the document type of the search result document.

Usually this will be a VFS resource type String that can be used in the resource type manager with CmsResourceManager.getResourceType(String). However, what is stored in the document type field depends only on the indexer used, and therefore it may also be some String not referring a VFS resource type but some external type or application. It may also be null in case it has not been set by a non-standard indexer.

Returns:

the document type of the search result document

See Also:

• CmsResourceManager.getResourceType(String)

getExcerpt

public String getExcerpt()

Returns the excerpt.

Returns:

the excerpt

getField

public String getField(String fieldName)

Returns the text stored in the search index field with the given name.

Parameters:

fieldName - the name of the field to get the stored text for

Returns:

the text stored in the search index field with the given name

getKeywords

@Deprecated
public String getKeywords()

Deprecated.

use getField(String) instead with the name of the field, for example use CmsSearchField.FIELD_KEYWORDS to get the keywords (if available)

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

@Deprecated
public String getTitle()

Deprecated.

use getField(String) instead with the name of the field, for example use CmsSearchField.FIELD_TITLE to get the title (if available)

Returns the title.

Returns:

the title

hashCode

public int hashCode()

Overrides:

hashCode in class Object

See Also:

• Object.hashCode()