org.opencms.search
Class CmsSearch

java.lang.Object
  org.opencms.search.CmsSearch

All Implemented Interfaces:

Cloneable

public class CmsSearch
extends Object
implements Cloneable

Helper class to access the search facility within a jsp.

Typically, the following fields are available for searching:

• title - the title of a resource
• keywords - the keywords of a resource
• description - the description of a resource
• content - the aggregated content of a resource
• created - the creation date of a resource
• lastmodified - the date of the last modification of a resource
• path - the path to display the resource
• channel - the channel of a resource
• contentdefinition - the name of the content definition class of a resource

Since:

6.0.0

Version:

$Revision: 1.39 $

Author:

Carsten Weinholz, Thomas Weckert

Field Summary

protected boolean	m_calculateCategories Indicates if a category count should be calculated for the result list.
protected String[]	m_categories Contains the list of categories that the search is limited to.
protected Map	m_categoriesFound The result categories of a search.
protected CmsObject	m_cms The cms object.
protected int	m_displayPages The number of displayed pages returned by getPageLinks().
protected String[]	m_fields The list of fields to search.
protected CmsSearchIndex	m_index The index to search.
protected String	m_indexName The name of the search index.
protected Exception	m_lastException The latest exception.
protected int	m_matchesPerPage The number of matches per page.
protected String	m_nextUrl The URL which leads to the next result page.
protected int	m_page The current result page.
protected int	m_pageCount The number of pages for the result list.
protected CmsSearchParameters	m_parameterRestriction The restriction for the search parameters, used for "search in seach result".
protected CmsSearchParameters	m_parameters The search parameters used for searching, build out of the given individual parameter values.
protected String	m_prevUrl The URL which leads to the previous result page.
protected String	m_query The current query.
protected int	m_queryLength The minimum length of the search query.
protected List	m_result The current search result.
protected String	m_searchParameters The search parameter String.
protected int	m_searchResultCount The total number of search results matching the query.
protected String[]	m_searchRoots Contains the list of search root paths.
protected Sort	m_sortOrder The search sort order.
static Sort	SORT_DATE_CREATED Sort result documents by date of last modification, then score.
static Sort	SORT_DATE_LASTMODIFIED Sort result documents by date of last modification, then score.
static Sort	SORT_DEFAULT Default sort order (by document score - for this null gave best performance).
static Sort	SORT_TITLE Sort result documents by title, then score.

Constructor Summary

CmsSearch()
Default constructor, used to instanciate the search facility as a bean.

Method Summary

boolean	getCalculateCategories() Returns true if a category overview should be shown as part of the result.
String[]	getCategories() Returns the search categories.
int	getDisplayPages() Returns the maximum number of pages which should be shown.
String	getFields() Gets the current fields list.
String	getIndex() Gets the name of the current search index.
Exception	getLastException() Gets the last exception after a search operation.
int	getMatchesPerPage() Gets the number of matches displayed on each page.
String	getNextUrl() Gets the URL for the link to the next result page.
int	getPage() Gets the current result page.
Map	getPageLinks() Creates a sorted map of URLs to link to other search result pages.
CmsSearchParameters	getParameters() Returns the search parameters used for searching, build out of the given individual parameter values.
String	getPreviousUrl() Gets the URL for the link to the previous result page.
String	getQuery() Gets the current search query.
int	getQueryLength() Gets the minimum search query length.
String	getSearchParameters() Creates a String with the necessary search parameters for page links.
List	getSearchResult() Returns the search result for the current query, as a list of CmsSearchResult objects.
Map	getSearchResultCategories() Returns a map of categories (Strings) for the last search result, mapped to the hit count (Integer) of the documents in this category, or null if the categories have not been calculated.
int	getSearchResultCount() Returns the total number of search results matching the query.
String[]	getSearchRoots() Returns the search roots.
Sort	getSortOrder() Returns the sort order used for sorting the results of s search.
void	init(CmsObject cms) Initializes the bean with the cms object.
void	setCalculateCategories(boolean calculateCategories) Sets the flag that controls calculation of result categories for the next search, use this only if it's really required since the search can become very slow using this option.
void	setCategories(String[] categories) Sets the search categories, all search results must be in one of the categories, the category set must match the indexed category exactly.
void	setDisplayPages(int value) Sets the maximum number of pages which should be shown.
void	setField(String[] fields) Sets the fields to search.
void	setIndex(String indexName) Set the name of the index to search.
void	setMatchesPerPage(int matches) Sets the number of matches per page.
void	setPage(int page) Sets the current result page.
void	setQuery(String query) Sets the search query.
void	setQueryLength(int length) Sets the minimum length of the search query.
void	setResultRestriction(CmsSearchParameters restriction) Restrict the result of the next search to the results of the last search, restricted with the provided parameters.
void	setSearchRoot(String searchRoot) Convenience method to set exactly one search root.
void	setSearchRoots(String[] searchRoots) Sets the search root list.
void	setSortOrder(Sort sortOrder) Sets the sort order used for sorting the results of s search.

Methods inherited from class java.lang.Object

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

Field Detail

SORT_DATE_CREATED

public static final Sort SORT_DATE_CREATED

Sort result documents by date of last modification, then score.

SORT_DATE_LASTMODIFIED

public static final Sort SORT_DATE_LASTMODIFIED

Sort result documents by date of last modification, then score.

SORT_DEFAULT

public static final Sort SORT_DEFAULT

Default sort order (by document score - for this null gave best performance).

SORT_TITLE

public static final Sort SORT_TITLE

Sort result documents by title, then score.

m_calculateCategories

protected boolean m_calculateCategories

Indicates if a category count should be calculated for the result list.

m_categories

protected String[] m_categories

Contains the list of categories that the search is limited to.

m_categoriesFound

protected Map m_categoriesFound

The result categories of a search.

m_cms

protected transient CmsObject m_cms

The cms object.

m_displayPages

protected int m_displayPages

The number of displayed pages returned by getPageLinks().

m_fields

protected String[] m_fields

The list of fields to search.

m_index

protected CmsSearchIndex m_index

The index to search.

m_indexName

protected String m_indexName

The name of the search index.

m_lastException

protected Exception m_lastException

The latest exception.

m_matchesPerPage

protected int m_matchesPerPage

The number of matches per page.

m_nextUrl

protected String m_nextUrl

The URL which leads to the next result page.

m_page

protected int m_page

The current result page.

m_pageCount

protected int m_pageCount

The number of pages for the result list.

m_parameterRestriction

protected CmsSearchParameters m_parameterRestriction

The restriction for the search parameters, used for "search in seach result".

m_parameters

protected CmsSearchParameters m_parameters

The search parameters used for searching, build out of the given individual parameter values.

m_prevUrl

protected String m_prevUrl

The URL which leads to the previous result page.

m_query

protected String m_query

The current query.

m_queryLength

protected int m_queryLength

The minimum length of the search query.

m_result

protected List m_result

The current search result.

m_searchParameters

protected String m_searchParameters

The search parameter String.

m_searchResultCount

protected int m_searchResultCount

The total number of search results matching the query.

m_searchRoots

protected String[] m_searchRoots

Contains the list of search root paths.

m_sortOrder

protected Sort m_sortOrder

The search sort order.

Constructor Detail

CmsSearch

public CmsSearch()

Default constructor, used to instanciate the search facility as a bean.

Method Detail

getCalculateCategories

public boolean getCalculateCategories()

Returns true if a category overview should be shown as part of the result.

Please note: The calculation of the category count slows down the search time by an order of magnitude. Make sure that you only use this feature if it's really required! Be especially careful if your search result list can become large (> 1000 documents), since in this case overall system performance will certainly be impacted considerably when calculating the categories.

Returns:

true if a category overview should be shown as part of the result

getCategories

public String[] getCategories()

Returns the search categories.

Returns:

the search categories

getDisplayPages

public int getDisplayPages()

Returns the maximum number of pages which should be shown.

Returns:

the maximum number of pages which should be shown

getFields

public String getFields()

Gets the current fields list.

Returns:

the fields to search

getIndex

public String getIndex()

Gets the name of the current search index.

Returns:

the name of the index

getLastException

public Exception getLastException()

Gets the last exception after a search operation.

Returns:

the exception occured in a search operation or null

getMatchesPerPage

public int getMatchesPerPage()

Gets the number of matches displayed on each page.

Returns:

matches per result page

getNextUrl

public String getNextUrl()

Gets the URL for the link to the next result page.

Returns:

the URL to the next result page

getPage

public int getPage()

Gets the current result page.

Returns:

the current result page

getPageLinks

public Map getPageLinks()

Creates a sorted map of URLs to link to other search result pages.

The key values are Integers representing the page number, the entry holds the corresponding link.

Returns:

a map with String URLs

getParameters

public CmsSearchParameters getParameters()

Returns the search parameters used for searching, build out of the given individual parameter values.

Returns:

the search parameters used for searching, build out of the given individual parameter values

getPreviousUrl

public String getPreviousUrl()

Gets the URL for the link to the previous result page.

Returns:

the URL to the previous result page

getQuery

public String getQuery()

Gets the current search query.

Returns:

the current query string or null if no query was set before

getQueryLength

public int getQueryLength()

Gets the minimum search query length.

Returns:

the minimum search query length

getSearchParameters

public String getSearchParameters()

Creates a String with the necessary search parameters for page links.

Returns:

String with search parameters

getSearchResult

public List getSearchResult()

Returns the search result for the current query, as a list of CmsSearchResult objects.

Returns:

the search result (may be empty) or null if no index or query was set before

getSearchResultCategories

public Map getSearchResultCategories()

Returns a map of categories (Strings) for the last search result, mapped to the hit count (Integer) of the documents in this category, or null if the categories have not been calculated.

Returns:

a map of categories for the last search result

See Also:

getCalculateCategories(), setCalculateCategories(boolean)

getSearchResultCount

public int getSearchResultCount()

Returns the total number of search results matching the query.

Returns:

the total number of search results matching the query

getSearchRoots

public String[] getSearchRoots()

Returns the search roots.

Only resources that are sub-resources of one of the search roots are included in the search result.

The search roots are used in addition to the current site root of the user performing the search.

By default, the search roots contain only one entry with an empty string.

Returns:

the search roots

getSortOrder

public Sort getSortOrder()

Returns the sort order used for sorting the results of s search.

Returns:

the sort order used for sorting the results of s search

init

public void init(CmsObject cms)

Initializes the bean with the cms object.

Parameters:

cms - the cms object

setCalculateCategories

public void setCalculateCategories(boolean calculateCategories)

Sets the flag that controls calculation of result categories for the next search, use this only if it's really required since the search can become very slow using this option.

Please note: The calculation of the category count slows down the search time by an order of magnitude. Make sure that you only use this feature if it's really required! Be especially careful if your search result list can become large (> 1000 documents), since in this case overall system performance will certainly be impacted considerably when calculating the categories.

Parameters:

calculateCategories - if true, the category count will be calculated for the next search

setCategories

public void setCategories(String[] categories)

Sets the search categories, all search results must be in one of the categories, the category set must match the indexed category exactly.

All categories will automatically be trimmed and lowercased, since search categories are also stored this way in the index.

Parameters:

categories - the categories to set

setDisplayPages

public void setDisplayPages(int value)

Sets the maximum number of pages which should be shown.

Enter an odd value to achieve a nice, "symmetric" output.

Parameters:

value - the maximum number of pages which should be shown

setField

public void setField(String[] fields)

Sets the fields to search.

If the fields are set to null, or not set at all, the default fields "content" and "meta" are used.

For a list of valid field names, see the Interface constants of I_CmsDocumentFactory.

Parameters:

fields - the fields to search

setIndex

public void setIndex(String indexName)

Set the name of the index to search.

A former search result will be deleted.

Parameters:

indexName - the name of the index

setMatchesPerPage

public void setMatchesPerPage(int matches)

Sets the number of matches per page.

Parameters:

matches - the number of matches per page

setPage

public void setPage(int page)

Sets the current result page.

Parameters:

page - the current result page

setQuery

public void setQuery(String query)

Sets the search query.

The syntax of the query depends on the search engine used. A former search result will be deleted.

Parameters:

query - the search query (escaped format)

setQueryLength

public void setQueryLength(int length)

Sets the minimum length of the search query.

Parameters:

length - the minimum search query length

setResultRestriction

public void setResultRestriction(CmsSearchParameters restriction)

Restrict the result of the next search to the results of the last search, restricted with the provided parameters.

Use this for "seach in search result" functions.

Parameters:

restriction - the restriction to use

See Also:

CmsSearchParameters.restrict(CmsSearchParameters)

setSearchRoot

public void setSearchRoot(String searchRoot)

Convenience method to set exactly one search root.

Parameters:

searchRoot - the search root to set

See Also:

setSearchRoots(String[])

setSearchRoots

public void setSearchRoots(String[] searchRoots)

Sets the search root list.

Only resources that are sub-resources of one of the search roots are included in the search result.

The search roots set here are used in addition to the current site root of the user performing the search.

By default, the search roots contain only one entry with an empty string.

Parameters:

searchRoots - the search roots to set

setSortOrder

public void setSortOrder(Sort sortOrder)

Sets the sort order used for sorting the results of s search.

Parameters:

sortOrder - the sort order to set