Package org.opencms.search.galleries

Class CmsGallerySearchResult

java.lang.Object

org.opencms.search.galleries.CmsGallerySearchResult

All Implemented Interfaces:

Cloneable, Comparable<CmsGallerySearchResult>

public class CmsGallerySearchResult
extends Object
implements Comparable<CmsGallerySearchResult>, Cloneable

Field Summary

Fields

Modifier and Type	Field	Description
static final org.apache.commons.logging.Log	LOG	The logger instance for this class.
protected List<String>	m_containerTypes	The supported container types of this search result.
protected Date	m_dateCreated	The creation date of this search result.
protected Date	m_dateExpired	The expiration date of this search result.
protected Date	m_dateLastModified	The last modification date of this search result.
protected Date	m_dateReleased	The release 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 int	m_length	The length of the search result.
protected List<String>	m_locales	The locales in which the content is available.
protected String	m_path	The resource path of this search result.
protected 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 String	m_structureId	The structure UUID of the resource.
protected String	m_title	The title of this search result.
protected String	m_userCreated	The user who created the search result resource.
protected String	m_userLastModified	The user who last modified the search result resource.

Constructor Summary

Constructors

Constructor	Description
CmsGallerySearchResult(CmsObject cms, CmsResource res, String title)	Creates a fake gallery search result by reading the necessary data from a VFS resource.
CmsGallerySearchResult(I_CmsSearchDocument doc, CmsObject cms, int score, Locale locale)	Creates a new gallery search result.

Method Summary

Modifier and Type	Method	Description
int	compareTo(CmsGallerySearchResult other)	Compares two search results based on the score of the result.
boolean	equals(Object obj)
List<String>	getContainerTypes()	Returns the containers supported by this resource.
Date	getDateCreated()	Returns the date created.
Date	getDateExpired()	Returns the date the resource expires.
Date	getDateLastModified()	Returns the date last modified.
Date	getDateReleased()	Returns the date the resource is released.
String	getDescription()	Returns the description.
String	getExcerpt()	Returns the excerpt.
int	getLength()	Returns the length of the resource.
List<String>	getLocales()	Returns the list of locales this search result is available for.
String	getPath()	Returns the resource root path.
static final String[]	getRequiredSolrFields()	Returns the list of Solr fields a search result must have to initialize the gallery search result correctly.
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.
String	getStructureId()	Returns the structure id of the resource.
String	getTitle()	Returns the title of the resource.
String	getUserCreated()	Returns the name of the user who created the resource.
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.
CmsGallerySearchResult	withTitle(String title)	Returns a shallow copy of this result, with a changed title.

Methods inherited from class java.lang.Object

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

Field Details

LOG

public static final org.apache.commons.logging.Log LOG

The logger instance for this class.

m_containerTypes

protected List<String> m_containerTypes

The supported container types of this search result.

m_dateCreated

protected Date m_dateCreated

The creation date of this search result.

m_dateExpired

protected Date m_dateExpired

The expiration date of this search result.

m_dateLastModified

protected Date m_dateLastModified

The last modification date of this search result.

m_dateReleased

protected Date m_dateReleased

The release 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_length

protected int m_length

The length of the search result.

m_locales

protected List<String> m_locales

The locales in which the content is available.

m_path

protected String m_path

The resource path of this search result.

m_resourceType

protected 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 String m_structureId

The structure UUID of the resource.

m_title

protected String m_title

The title of this search result.

m_userCreated

protected String m_userCreated

The user who created the search result resource.

m_userLastModified

protected String m_userLastModified

The user who last modified the search result resource.

Constructor Details

CmsGallerySearchResult

public CmsGallerySearchResult(CmsObject cms,
 CmsResource res,
 String title)

Creates a fake gallery search result by reading the necessary data from a VFS resource.

Parameters:

cms - the current CMS context

res - the resource from which the data should be read

title - optional value that can be used to override the title (if null, the title is not overridden)

CmsGallerySearchResult

public CmsGallerySearchResult(I_CmsSearchDocument doc,
 CmsObject cms,
 int score,
 Locale locale)

Creates a new gallery search result.

Parameters:

cms - the current CMS context (used for reading information missing from the index)

doc - the I_CmsSearchResult document to extract information from.

score - the score of this search result

locale - the locale to create the result for

Method Details

getRequiredSolrFields

public static final String[] getRequiredSolrFields()

Returns the list of Solr fields a search result must have to initialize the gallery search result correctly.

Returns:

the list of Solr fields.

compareTo

public int compareTo(CmsGallerySearchResult other)

Compares two search results based on the score of the result.

Specified by:

compareTo in interface Comparable<CmsGallerySearchResult>

Parameters:

other - the result to compare this result with

Returns:

the comparison result

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)

getContainerTypes

public List<String> getContainerTypes()

Returns the containers supported by this resource.

Returns:

the containers supported by this resource

getDateCreated

public Date getDateCreated()

Returns the date created.

Returns:

the date created

getDateExpired

public Date getDateExpired()

Returns the date the resource expires.

Returns:

the date the resource expires

See Also:

• CmsResource.getDateExpired()

getDateLastModified

public Date getDateLastModified()

Returns the date last modified.

Returns:

the date last modified

getDateReleased

public Date getDateReleased()

Returns the date the resource is released.

Returns:

the date the resource is released

See Also:

• CmsResource.getDateReleased()

getDescription

public String getDescription()

Returns the description.

Returns:

the description

getExcerpt

public String getExcerpt()

Returns the excerpt.

Returns:

the excerpt

getLength

public int getLength()

Returns the length of the resource.

Returns:

the length of the resource

See Also:

• CmsResource.getLength()

getLocales

public List<String> getLocales()

Returns the list of locales this search result is available for.

Returns:

the list of locales this search result is available for

getPath

public String getPath()

Returns the resource root path.

Returns:

the resource root path

See Also:

• CmsResource.getRootPath()

getResourceType

public String getResourceType()

Returns the resource type of the search result document.

Returns:

the resource type of the search result document

See Also:

• CmsResourceManager.getResourceType(String)

getScore

public int getScore()

Returns the Lucene search score for this result.

Returns:

the Lucene search score for this result

getState

public int getState()

Returns the state of the resource.

Returns:

the state of the resource

See Also:

• CmsResource.getState()

getStructureId

public String getStructureId()

Returns the structure id of the resource.

Returns:

the structure id of the resource

getTitle

public String getTitle()

Returns the title of the resource.

Returns:

the title of the resource

getUserCreated

public String getUserCreated()

Returns the name of the user who created the resource.

Returns:

the name of the user who created the resource

See Also:

• CmsResource.getUserCreated()

getUserLastModified

public String getUserLastModified()

Returns the name of the user who last modified the resource.

Returns:

the name of the user who last modified the resource

See Also:

• CmsResource.getUserLastModified()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

See Also:

• Object.hashCode()

isReleaseAndNotExpired

public boolean isReleaseAndNotExpired(CmsObject cms)

Returns if the related resource is released and not expired.

Parameters:

cms - the cms context

Returns:

true if the related resource is released and not expired

withTitle

public CmsGallerySearchResult withTitle(String title)

Returns a shallow copy of this result, with a changed title.

Parameters:

title - the new title

Returns:

the shallow copy with the changed title

initializeMissingFieldsFromVfs

protected void initializeMissingFieldsFromVfs(CmsObject cms,
 CmsUUID structureId)

Initializes missing fields by reading the information from the VFS.

Parameters:

cms - the current CMS context

structureId - the current structure id