com.day.cq.search
Interface Search

All Known Implementing Classes:

SearchImpl

public interface Search

Search implements the search logic and exposes the query result in a scripting friendly object structure.

Field Summary

static String

RELATED_PREFIX The prefix for a query searches for similar content.

Method Summary

String	getExcerptPropertyNames()
String	getFacetFilterClause()
long	getHitsPerPage()
String	getQuery()
String	getQuerySimilarTemplate()
String	getQueryTemplate()
List<String>	getRelatedQueries()
SearchResult	getResult()
String	getSearchIn()
String	getSearchProperties()
long	getStart()
Trends	getTrends()
void	setExcerptPropertyNames(String properties)
void	setFacetFilterClause(String filter)
void	setHitsPerPage(long num)
void	setQuery(String query) Sets a new fulltext query that will be executed.
void	setSearchIn(String searchIn)
void	setSearchProperties(String properties)
void	setStart(long start)

Field Detail

RELATED_PREFIX

static final String RELATED_PREFIX

The prefix for a query searches for similar content.

See Also:

Constant Field Values

Method Detail

getResult

SearchResult getResult()
                       throws RepositoryException

Returns:

the query result or null if there is no query parameter set.

Throws:

RepositoryException - if an exception occurs while executing the query.

getTrends

Trends getTrends()

Returns:

query trends (popular queries).

getRelatedQueries

List<String> getRelatedQueries()
                               throws RepositoryException

Returns:

queries that are related to the current one.

Throws:

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

getQuery

String getQuery()

Returns:

the query supplied by the user.

setQuery

void setQuery(String query)

Sets a new fulltext query that will be executed.

Parameters:

query - the fulltext query.

getQueryTemplate

String getQueryTemplate()
                        throws RepositoryException

Returns:

the query template.

Throws:

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

getQuerySimilarTemplate

String getQuerySimilarTemplate()

Returns:

the query template, which is used to search for similar content.

getHitsPerPage

long getHitsPerPage()

Returns:

the number of hits to display per page.

setHitsPerPage

void setHitsPerPage(long num)

Parameters:

num - the number of hits to display on a page.

getSearchIn

String getSearchIn()

Returns:

the location where to search in.

setSearchIn

void setSearchIn(String searchIn)

Parameters:

searchIn - the location where to search in.

getSearchProperties

String getSearchProperties()

Returns:

the names of the properties that will be searched.

setSearchProperties

void setSearchProperties(String properties)

Parameters:

properties - comma separated names of the properties that will be searched.

getExcerptPropertyNames

String getExcerptPropertyNames()

Returns:

the names of the properties that will be used in an excerpt.

setExcerptPropertyNames

void setExcerptPropertyNames(String properties)

Parameters:

properties - comma separated names of the properties that will be used in an excerpt.

getFacetFilterClause

String getFacetFilterClause()

Returns:

the currently set facet filter clause.

setFacetFilterClause

void setFacetFilterClause(String filter)

Parameters:

filter - sets a new facet filter clause.

getStart

long getStart()

setStart

void setStart(long start)