org.opencms.search

类 CmsSearchResult

java.lang.Object

org.opencms.search.CmsSearchResult

所有已实现的接口:

java.lang.Comparable<CmsSearchResult>, I_CmsMemoryMonitorable

public class CmsSearchResult
extends java.lang.Object
implements I_CmsMemoryMonitorable, java.lang.Comparable<CmsSearchResult>

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

从以下版本开始:

6.0.0

字段概要

字段

限定符和类型	字段和说明
protected java.util.Date	m_dateCreated The creation date of this search result.
protected java.util.Date	m_dateLastModified The last modification date of this search result.
protected java.lang.String	m_documentType The document type of the search result.
protected java.lang.String	m_excerpt The excerpt of this search result.
protected java.util.Map<java.lang.String,java.lang.String>	m_fields Holds the values of the search result fields.
protected java.lang.String	m_path The resource path of this search result.
protected int	m_score The score of this search result.

构造器概要

构造器

限定符	构造器和说明
protected	CmsSearchResult() Empty constructor to be used for overriding classes.
	CmsSearchResult(int score, org.apache.lucene.document.Document doc, java.lang.String excerpt) Creates a new search result.

方法概要

方法

限定符和类型	方法和说明
int	compareTo(CmsSearchResult obj)
boolean	equals(java.lang.Object obj)
java.util.Date	getDateCreated() Returns the date created.
java.util.Date	getDateLastModified() Returns the date last modified.
java.lang.String	getDescription() Returns the description.
java.lang.String	getDocumentType() Returns the document type of the search result document.
java.lang.String	getExcerpt() Returns the excerpt.
java.lang.String	getField(java.lang.String fieldName) Returns the text stored in the search index field with the given name.
java.lang.String	getKeywords() Returns the key words.
int	getMemorySize() Returns the memory size of the object.
java.lang.String	getPath() Returns the path.
int	getScore() Returns the score.
java.lang.String	getTitle() Returns the title.
int	hashCode()

从类继承的方法 java.lang.Object

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

字段详细资料

m_dateCreated

protected java.util.Date m_dateCreated

The creation date of this search result.

m_dateLastModified

protected java.util.Date m_dateLastModified

The last modification date of this search result.

m_documentType

protected java.lang.String m_documentType

The document type of the search result.

m_excerpt

protected java.lang.String m_excerpt

The excerpt of this search result.

m_fields

protected java.util.Map<java.lang.String,java.lang.String> m_fields

Holds the values of the search result fields.

m_path

protected java.lang.String m_path

The resource path of this search result.

m_score

protected int m_score

The score of this search result.

构造器详细资料

CmsSearchResult

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

Creates a new search result.

参数:

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.

方法详细资料

compareTo

public int compareTo(CmsSearchResult obj)

指定者:

compareTo 在接口中 java.lang.Comparable<CmsSearchResult>

另请参阅:

Comparable.compareTo(java.lang.Object)

equals

public boolean equals(java.lang.Object obj)

覆盖:

equals 在类中 java.lang.Object

另请参阅:

Object.equals(java.lang.Object)

getDateCreated

public java.util.Date getDateCreated()

Returns the date created.

返回:

the date created

getDateLastModified

public java.util.Date getDateLastModified()

Returns the date last modified.

返回:

the date last modified

getDescription

public java.lang.String getDescription()

Returns the description.

返回:

the description

getDocumentType

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

返回:

the document type of the search result document

另请参阅:

CmsResourceManager.getResourceType(String)

getExcerpt

public java.lang.String getExcerpt()

Returns the excerpt.

返回:

the excerpt

getField

public java.lang.String getField(java.lang.String fieldName)

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

参数:

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

返回:

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

getKeywords

public java.lang.String getKeywords()

Returns the key words.

返回:

the key words

getMemorySize

public int getMemorySize()

从接口复制的说明: I_CmsMemoryMonitorable

Returns the memory size of the object.

指定者:

getMemorySize 在接口中 I_CmsMemoryMonitorable

返回:

the memory size of the object

另请参阅:

I_CmsMemoryMonitorable.getMemorySize()

getPath

public java.lang.String getPath()

Returns the path.

返回:

the path

getScore

public int getScore()

Returns the score.

返回:

the score

getTitle

public java.lang.String getTitle()

Returns the title.

返回:

the title

hashCode

public int hashCode()

覆盖:

hashCode 在类中 java.lang.Object

另请参阅:

Object.hashCode()