Package com.day.cq.wcm.foundation

Class Search.Hit

java.lang.Object

com.day.cq.wcm.foundation.Search.Hit

Enclosing class:

Search

public final class Search.Hit
extends Object

A hit within the search result.

Method Summary

Modifier and Type	Method	Description
String	getExcerpt()
String	getExtension()	Returns the extension of the url of this hit.
String	getIcon()	Returns an icon image for this hit.
Map	getProperties()
String	getSimilarURL()
String	getTitle()	Returns the title for this hit.
String	getURL()

Methods inherited from class java.lang.Object

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

Method Details

getTitle

public String getTitle()
                throws RepositoryException

Returns the title for this hit. The returned string may contain HTML tags, which means it must not be escaped when written to the response.

Returns:

the title for this hit.

Throws:

RepositoryException - if an error occurs while reading form the repository.

getExcerpt

public String getExcerpt()
                  throws RepositoryException

Returns:

the default excerpt for this hit.

Throws:

RepositoryException - if an error occurs while building the excerpt.

getURL

public String getURL()
              throws RepositoryException

Returns:

the url for this hit.

Throws:

RepositoryException - if an error occurs while reading from the query result.

getSimilarURL

public String getSimilarURL()
                     throws RepositoryException

Returns:

the url that displays similar pages for this hit.

Throws:

RepositoryException - if an error occurs while reading from the query result.

getIcon

public String getIcon()
               throws RepositoryException

Returns an icon image for this hit.

Returns:

an icon image for this hit.

Throws:

RepositoryException - if an error occurs while reading from the repository.

getExtension

public String getExtension()
                    throws RepositoryException

Returns the extension of the url of this hit.

Returns:

the extension

Throws:

RepositoryException - if an error occurs

getProperties

public Map getProperties()
                  throws RepositoryException

Returns:

the content properties on this hit.

Throws:

RepositoryException - if an error occurs while reading from the repository.