CmsGallerySearchResult

java.lang.Object
- org.opencms.search.galleries.CmsGallerySearchResult

所有已实现的接口:: java.lang.Comparable<CmsGallerySearchResult>

public class CmsGallerySearchResult
extends java.lang.Object
implements java.lang.Comparable<CmsGallerySearchResult>

字段概要

字段
限定符和类型	字段和说明
`static org.apache.commons.logging.Log`	`LOG` The logger instance for this class.
`protected java.lang.String`	`m_additonalInfo` The additional information for the gallery search index.
`protected java.util.List<java.lang.String>`	`m_containerTypes` The supported container types of this search result.
`protected java.util.Date`	`m_dateCreated` The creation date of this search result.
`protected java.util.Date`	`m_dateExpired` The expiration date of this search result.
`protected java.util.Date`	`m_dateLastModified` The last modification date of this search result.
`protected java.util.Date`	`m_dateReleased` The release date of this search result.
`protected java.lang.String`	`m_description` The description of this search result.
`protected java.lang.String`	`m_excerpt` The excerpt of this search result.
`protected int`	`m_length` The length of the search result.
`protected java.util.List<java.lang.String>`	`m_locales` The locales in which the content is available.
`protected java.lang.String`	`m_path` The resource path of this search result.
`protected java.lang.String`	`m_resourceType` The resource type of the search result.
`protected int`	`m_score` The score of this search result.
`protected int`	`m_state` The state of the search result.
`protected java.lang.String`	`m_structureId` The structure UUID of the resource.
`protected java.lang.String`	`m_title` The title of this search result.
`protected java.lang.String`	`m_userCreated` The user who created the search result resource.
`protected java.lang.String`	`m_userLastModified` The user who last modified the search result resource.

构造器概要

构造器
构造器和说明
`CmsGallerySearchResult(CmsObject cms, CmsResource res)` Creates a fake gallery search result by reading the necessary data from a VFS resource.
`CmsGallerySearchResult(CmsObject cms, int score, org.apache.lucene.document.Document doc, java.lang.String excerpt, java.util.Locale locale)` Creates a new gallery search result.
`CmsGallerySearchResult(int score, org.apache.lucene.document.Document doc, java.lang.String excerpt, java.util.Locale locale)` Creates a new gallery search result.

方法概要

方法
限定符和类型	方法和说明
`int`	`compareTo(CmsGallerySearchResult other)` Compares two search results based on the score of the result.
`boolean`	`equals(java.lang.Object obj)`
`java.lang.String`	`getAdditonalInfo()` Returns the additional information stored for this search result in the gallery search index.
`java.util.List<java.lang.String>`	`getContainerTypes()` Returns the containers supported by this resource.
`java.util.Date`	`getDateCreated()` Returns the date created.
`java.util.Date`	`getDateExpired()` Returns the date the resource expires.
`java.util.Date`	`getDateLastModified()` Returns the date last modified.
`java.util.Date`	`getDateReleased()` Returns the date the resource is released.
`java.lang.String`	`getDescription()` Returns the description.
`java.lang.String`	`getExcerpt()` Returns the excerpt.
`int`	`getLength()` Returns the length of the resource.
`java.util.List<java.lang.String>`	`getLocales()` Returns the list of locales this search result is available for.
`java.lang.String`	`getPath()` Returns the resource root path.
`java.lang.String`	`getResourceType()` Returns the resource type of the search result document.
`int`	`getScore()` Returns the Lucene search score for this result.
`int`	`getState()` Returns the state of the resource.
`java.lang.String`	`getStructureId()` Returns the structure id of the resource.
`java.lang.String`	`getTitle()` Returns the title of the resource.
`java.lang.String`	`getUserCreated()` Returns the name of the user who created the resource.
`java.lang.String`	`getUserLastModified()` Returns the name of the user who last modified the resource.
`int`	`hashCode()`
`protected void`	`initializeMissingFieldsFromVfs(CmsObject cms, CmsUUID structureId)` Initializes missing fields by reading the information from the VFS.
`boolean`	`isReleaseAndNotExpired(CmsObject cms)` Returns if the related resource is released and not expired.

从类继承的方法 java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - LOG
```
public static final org.apache.commons.logging.Log LOG
```
    The logger instance for this class.
  - m_additonalInfo
```
protected java.lang.String m_additonalInfo
```
    The additional information for the gallery search index.
  - m_containerTypes
```
protected java.util.List<java.lang.String> m_containerTypes
```
    The supported container types of this search result.
  - m_dateCreated
```
protected java.util.Date m_dateCreated
```
    The creation date of this search result.
  - m_dateExpired
```
protected java.util.Date m_dateExpired
```
    The expiration date of this search result.
  - m_dateLastModified
```
protected java.util.Date m_dateLastModified
```
    The last modification date of this search result.
  - m_dateReleased
```
protected java.util.Date m_dateReleased
```
    The release date of this search result.
  - m_description
```
protected java.lang.String m_description
```
    The description of this search result.
  - m_excerpt
```
protected java.lang.String m_excerpt
```
    The excerpt of this search result.
  - m_length
```
protected int m_length
```
    The length of the search result.
  - m_locales
```
protected java.util.List<java.lang.String> m_locales
```
    The locales in which the content is available.
  - m_path
```
protected java.lang.String m_path
```
    The resource path of this search result.
  - m_resourceType
```
protected java.lang.String m_resourceType
```
    The resource type of the search result.
  - m_score
```
protected int m_score
```
    The score of this search result.
  - m_state
```
protected int m_state
```
    The state of the search result.
  - m_structureId
```
protected java.lang.String m_structureId
```
    The structure UUID of the resource.
  - m_title
```
protected java.lang.String m_title
```
    The title of this search result.
  - m_userCreated
```
protected java.lang.String m_userCreated
```
    The user who created the search result resource.
  - m_userLastModified
```
protected java.lang.String m_userLastModified
```
    The user who last modified the search result resource.
- 构造器详细资料
  - CmsGallerySearchResult
```
public CmsGallerySearchResult(CmsObject cms,
                      CmsResource res)
```
    Creates a fake gallery search result by reading the necessary data from a VFS resource.
    
    参数:
    cms - the current CMS context
    res - the resource from which the data should be read
  - CmsGallerySearchResult
```
public CmsGallerySearchResult(CmsObject cms,
                      int score,
                      org.apache.lucene.document.Document doc,
                      java.lang.String excerpt,
                      java.util.Locale locale)
```
    Creates a new gallery search result.
    
    参数:
    cms - the current CMS context (used for reading information missing from the index)
    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
    locale - the locale to create the result for
  - CmsGallerySearchResult
```
public CmsGallerySearchResult(int score,
                      org.apache.lucene.document.Document doc,
                      java.lang.String excerpt,
                      java.util.Locale locale)
```
    Creates a new gallery 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
    locale - the locale to create the result for
- 方法详细资料
  - compareTo
```
public int compareTo(CmsGallerySearchResult other)
```
    Compares two search results based on the score of the result.
    
    指定者:
    
    compareTo 在接口中 java.lang.Comparable<CmsGallerySearchResult>
    
    参数:
    other - the result to compare this result with
    
    返回:
    the comparison result
    另请参阅:
    Comparable.compareTo(java.lang.Object)
  - equals
```
public boolean equals(java.lang.Object obj)
```
    覆盖:
    
    equals 在类中 java.lang.Object
    
    另请参阅:
    Object.equals(java.lang.Object)
  - getAdditonalInfo
```
public java.lang.String getAdditonalInfo()
```
    Returns the additional information stored for this search result in the gallery search index.
    
    返回:
    the additional information stored for this search result in the gallery search index
  - getContainerTypes
```
public java.util.List<java.lang.String> getContainerTypes()
```
    Returns the containers supported by this resource.
    
    返回:
    the containers supported by this resource
  - getDateCreated
```
public java.util.Date getDateCreated()
```
    Returns the date created.
    
    返回:
    the date created
  - getDateExpired
```
public java.util.Date getDateExpired()
```
    Returns the date the resource expires.
    
    返回:
    the date the resource expires
    另请参阅:
    org.opencms.file.CmsResource#getDateExpired()
  - getDateLastModified
```
public java.util.Date getDateLastModified()
```
    Returns the date last modified.
    
    返回:
    the date last modified
  - getDateReleased
```
public java.util.Date getDateReleased()
```
    Returns the date the resource is released.
    
    返回:
    the date the resource is released
    另请参阅:
    org.opencms.file.CmsResource#getDateReleased()
  - getDescription
```
public java.lang.String getDescription()
```
    Returns the description.
    
    返回:
    the description
  - getExcerpt
```
public java.lang.String getExcerpt()
```
    Returns the excerpt.
    
    返回:
    the excerpt
  - getLength
```
public int getLength()
```
    Returns the length of the resource.
    
    返回:
    the length of the resource
    另请参阅:
    org.opencms.file.CmsResource#getLength()
  - getLocales
```
public java.util.List<java.lang.String> getLocales()
```
    Returns the list of locales this search result is available for.
    
    返回:
    the list of locales this search result is available for
  - getPath
```
public java.lang.String getPath()
```
    Returns the resource root path.
    
    返回:
    the resource root path
    另请参阅:
    org.opencms.file.CmsResource#getRootPath()
  - getResourceType
```
public java.lang.String getResourceType()
```
    Returns the resource type of the search result document.
    
    返回:
    the resource type of the search result document
    另请参阅:
    CmsResourceManager.getResourceType(String)
  - getScore
```
public int getScore()
```
    Returns the Lucene search score for this result.
    
    返回:
    the Lucene search score for this result
  - getState
```
public int getState()
```
    Returns the state of the resource.
    
    返回:
    the state of the resource
    另请参阅:
    org.opencms.file.CmsResource#getState()
  - getStructureId
```
public java.lang.String getStructureId()
```
    Returns the structure id of the resource.
    
    返回:
    the structure id of the resource
  - getTitle
```
public java.lang.String getTitle()
```
    Returns the title of the resource.
    
    返回:
    the title of the resource
  - getUserCreated
```
public java.lang.String getUserCreated()
```
    Returns the name of the user who created the resource.
    
    返回:
    the name of the user who created the resource
    另请参阅:
    org.opencms.file.CmsResource#getUserCreated()
  - getUserLastModified
```
public java.lang.String getUserLastModified()
```
    Returns the name of the user who last modified the resource.
    
    返回:
    the name of the user who last modified the resource
    另请参阅:
    org.opencms.file.CmsResource#getUserLastModified()
  - hashCode
```
public int hashCode()
```
    覆盖:
    
    hashCode 在类中 java.lang.Object
    
    另请参阅:
    Object.hashCode()
  - isReleaseAndNotExpired
```
public boolean isReleaseAndNotExpired(CmsObject cms)
```
    Returns if the related resource is released and not expired.
    
    参数:
    cms - the cms context
    
    返回:
    true if the related resource is released and not expired
  - initializeMissingFieldsFromVfs
```
protected void initializeMissingFieldsFromVfs(CmsObject cms,
                                  CmsUUID structureId)
```
    Initializes missing fields by reading the information from the VFS.
    
    参数:
    cms - the current CMS context
    structureId - the current structure id

类 CmsGallerySearchResult

字段概要

构造器概要

方法概要

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

字段详细资料

LOG

m_additonalInfo

m_containerTypes

m_dateCreated

m_dateExpired

m_dateLastModified

m_dateReleased

m_description

m_excerpt

m_length

m_locales

m_path

m_resourceType

m_score

m_state

m_structureId

m_title

m_userCreated

m_userLastModified

构造器详细资料

CmsGallerySearchResult

CmsGallerySearchResult

CmsGallerySearchResult

方法详细资料

compareTo

equals

getAdditonalInfo

getContainerTypes

getDateCreated

getDateExpired

getDateLastModified

getDateReleased

getDescription

getExcerpt

getLength

getLocales

getPath

getResourceType

getScore

getState

getStructureId

getTitle

getUserCreated

getUserLastModified

hashCode

isReleaseAndNotExpired

initializeMissingFieldsFromVfs