org.opencms.search
Class CmsSearchIndex

java.lang.Object
  org.opencms.search.CmsSearchIndex

All Implemented Interfaces:

I_CmsConfigurationParameterHandler

public class CmsSearchIndex
extends Object
implements I_CmsConfigurationParameterHandler

Implements the search within an index and the management of the index configuration.

Since:

6.0.0

Version:

$Revision: 1.58 $

Author:

Carsten Weinholz, Thomas Weckert, Alexander Kandzior

Field Summary

static String[]	DOC_META_FIELDS Constant for a field list that cointains only the "meta" field.
static String	EXCERPT Constant for additional param to enable excerpt creation (default: true).
static String	PERMISSIONS Constant for additional param to enable permission checks (default: true).
static String	PRIORITY Constant for additional param to set the thread priority during search.
static String	REBUILD_MODE_AUTO Automatic ("auto") index rebuild mode.
static String	REBUILD_MODE_MANUAL Manual ("manual") index rebuild mode.
static String	ROOT_PATH_SUFFIX Special root path append token for optimized path queries.
static String	ROOT_PATH_TOKEN Special root path start token for optimized path queries.

Fields inherited from interface org.opencms.configuration.I_CmsConfigurationParameterHandler

ADD_PARAMETER_METHOD, INIT_CONFIGURATION_METHOD

Constructor Summary

CmsSearchIndex()
Creates a new CmsSearchIndex.

Method Summary

void	addConfigurationParameter(String key, String value) Adds a parameter.
void	addSourceName(String sourceName) Adds am index source to this search index.
boolean	equals(Object obj)
Map	getConfiguration() Returns the configuration of this parameter configurable class instance, or null if the class does not need to be configured.
List	getDocumenttypes(String path) Returns the configured document types of this index for the given resource path.
protected String	getExcerpt(String content, Query searchQuery, Analyzer analyzer) Returns an excerpt of the given content related to the given search query.
IndexWriter	getIndexWriter(boolean create) Returns a new index writer for this index.
String	getLocale() Gets the langauge of this index.
String	getName() Gets the name of this index.
String	getPath() Returns the path where this index stores it's data in the "real" file system.
String	getProject() Gets the project of this index.
String	getRebuildMode() Get the rebuild mode of this index.
List	getSourceNames() Returns all configured sources names of this search index.
List	getSources() Returns all configured index sources of this search index.
int	hashCode()
protected boolean	hasReadPermission(CmsObject cms, Document doc) Checks if the OpenCms resource referenced by the result document can be read be the user of the given OpenCms context.
void	initConfiguration() Initializes a configuration after all parameters have been added.
void	initialize() Initializes the search index.
void	removeSourceName(String sourceName) Removes an index source from this search index.
static String	rootPathRewrite(String path) Rewrites the a resource path for use in the I_CmsDocumentFactory.DOC_ROOT field.
static String[]	rootPathSplit(String path) Spits the a resource path into tokens for use in the I_CmsDocumentFactory.DOC_ROOT field and with the rootPathRewrite(String) method.
CmsSearchResultList	search(CmsObject cms, CmsSearchParameters params, int page, int matchesPerPage) Performs a search on the index within the given fields.
void	setLocale(String locale) Sets the locale to index resources.
void	setName(String name) Sets the logical key/name of this search index.
void	setProjectName(String projectName) Sets the name of the project used to index resources.
void	setRebuildMode(String rebuildMode) Sets the rebuild mode of this search index.

Methods inherited from class java.lang.Object

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

Field Detail

DOC_META_FIELDS

public static final String[] DOC_META_FIELDS

Constant for a field list that cointains only the "meta" field.

EXCERPT

public static final String EXCERPT

Constant for additional param to enable excerpt creation (default: true).

PERMISSIONS

public static final String PERMISSIONS

Constant for additional param to enable permission checks (default: true).

PRIORITY

public static final String PRIORITY

Constant for additional param to set the thread priority during search.

REBUILD_MODE_AUTO

public static final String REBUILD_MODE_AUTO

Automatic ("auto") index rebuild mode.

See Also:

Constant Field Values

REBUILD_MODE_MANUAL

public static final String REBUILD_MODE_MANUAL

Manual ("manual") index rebuild mode.

See Also:

Constant Field Values

ROOT_PATH_SUFFIX

public static final String ROOT_PATH_SUFFIX

Special root path append token for optimized path queries.

See Also:

Constant Field Values

ROOT_PATH_TOKEN

public static final String ROOT_PATH_TOKEN

Special root path start token for optimized path queries.

See Also:

Constant Field Values

Constructor Detail

CmsSearchIndex

public CmsSearchIndex()

Creates a new CmsSearchIndex.

Method Detail

rootPathRewrite

public static String rootPathRewrite(String path)

Rewrites the a resource path for use in the I_CmsDocumentFactory.DOC_ROOT field.

All "/" chars in the path are replaced with the ROOT_PATH_SUFFIX token. This is required in order to use a Lucene "phrase query" on the resource path. Using a phrase query is much, much better for the search performance then using a straightforward "prefix query". With a "prefix query", Lucene would interally generate a huge list of boolean sub-queries, exactly one for every document in the VFS subtree of the query. So if you query on "/sites/default/*" on a large OpenCms installation, this means thousands of sub-queries. Using the "phrase query", only one (or very few) queries are internally generated, and the result is just the same.

This implementation basically replaces the "/" of a path with "@o.c ". This is a trick so that the Lucene analyzer leaves the directory names untouched, since it treats them like literal email addresses. Otherwise the language analyzer might modify the directory names, leading to potential duplicates (e.g. members/ and member/ may both be trimmed to member), so that the prefix search returns more results then expected.

Parameters:

path - the path to rewrite

Returns:

the re-written path

rootPathSplit

public static String[] rootPathSplit(String path)

Spits the a resource path into tokens for use in the I_CmsDocumentFactory.DOC_ROOT field and with the rootPathRewrite(String) method.

Parameters:

path - the path to split

Returns:

the splitted path

See Also:

rootPathRewrite(String)

addConfigurationParameter

public void addConfigurationParameter(String key,
                                      String value)

Adds a parameter.

Specified by:

addConfigurationParameter in interface I_CmsConfigurationParameterHandler

Parameters:

key - the key/name of the parameter

value - the value of the parameter

addSourceName

public void addSourceName(String sourceName)

Adds am index source to this search index.

Parameters:

sourceName - the index source name to add

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

See Also:

Object.equals(java.lang.Object)

getConfiguration

public Map getConfiguration()

Description copied from interface: I_CmsConfigurationParameterHandler

Returns the configuration of this parameter configurable class instance, or null if the class does not need to be configured.

All elements in the configuration are key, value String pairs, set using the I_CmsConfigurationParameterHandler.addConfigurationParameter(String, String) method during initialization of the loader.

Implementations will (should) not to return a direct reference to the internal configuration but just a copy of it, to avoid unwanted external manipulation.

Specified by:

getConfiguration in interface I_CmsConfigurationParameterHandler

Returns:

the configuration of this resource loader, or null

See Also:

I_CmsConfigurationParameterHandler.getConfiguration()

getDocumenttypes

public List getDocumenttypes(String path)

Returns the configured document types of this index for the given resource path.

The result List contains Strings with the names of the document types.

Parameters:

path - path of the folder

Returns:

the configured document types of this index for the given resource path

getIndexWriter

public IndexWriter getIndexWriter(boolean create)
                           throws CmsIndexException

Returns a new index writer for this index.

Parameters:

create - if true a whole new index is created, if false an existing index is updated

Returns:

a new instance of IndexWriter

Throws:

CmsIndexException - if the index can not be opened

getLocale

public String getLocale()

Gets the langauge of this index.

Returns:

the language of the index, i.e. de

getName

public String getName()

Gets the name of this index.

Returns:

the name of the index

getPath

public String getPath()

Returns the path where this index stores it's data in the "real" file system.

Returns:

the path where this index stores it's data in the "real" file system

getProject

public String getProject()

Gets the project of this index.

Returns:

the project of the index, i.e. "online"

getRebuildMode

public String getRebuildMode()

Get the rebuild mode of this index.

Returns:

the current rebuild mode

getSourceNames

public List getSourceNames()

Returns all configured sources names of this search index.

Returns:

a list with all configured sources names of this search index

getSources

public List getSources()

Returns all configured index sources of this search index.

Returns:

all configured index sources of this search index

hashCode

public int hashCode()

Overrides:

hashCode in class Object

See Also:

Object.hashCode()

initConfiguration

public void initConfiguration()

Description copied from interface: I_CmsConfigurationParameterHandler

Initializes a configuration after all parameters have been added.

Specified by:

initConfiguration in interface I_CmsConfigurationParameterHandler

See Also:

I_CmsConfigurationParameterHandler.initConfiguration()

initialize

public void initialize()
                throws CmsSearchException

Initializes the search index.

Throws:

CmsSearchException - if the index source association failed

removeSourceName

public void removeSourceName(String sourceName)

Removes an index source from this search index.

Parameters:

sourceName - the index source name to remove

search

public CmsSearchResultList search(CmsObject cms,
                                  CmsSearchParameters params,
                                  int page,
                                  int matchesPerPage)
                           throws CmsSearchException

Performs a search on the index within the given fields.

The result is returned as List with entries of type I_CmsSearchResult.

Parameters:

cms - the current user's Cms object

params - the parameters to use for the search

page - the page to calculate the search result list, or -1 to return all found documents in the search result

matchesPerPage - the number of search results per page, or -1 to return all found documents in the search result

Returns:

the List of results found or an empty list

Throws:

CmsSearchException - if something goes wrong

setLocale

public void setLocale(String locale)

Sets the locale to index resources.

Parameters:

locale - the locale to index resources

setName

public void setName(String name)

Sets the logical key/name of this search index.

Parameters:

name - the logical key/name of this search index

setProjectName

public void setProjectName(String projectName)

Sets the name of the project used to index resources.

Parameters:

projectName - the name of the project used to index resources

setRebuildMode

public void setRebuildMode(String rebuildMode)

Sets the rebuild mode of this search index.

Parameters:

rebuildMode - the rebuild mode of this search index {auto|manual}

getExcerpt

protected String getExcerpt(String content,
                            Query searchQuery,
                            Analyzer analyzer)
                     throws IOException

Returns an excerpt of the given content related to the given search query.

Parameters:

content - the content

searchQuery - the search query

analyzer - the analyzer used

Returns:

an excerpt of the content

Throws:

IOException - if something goes wrong

hasReadPermission

protected boolean hasReadPermission(CmsObject cms,
                                    Document doc)

Checks if the OpenCms resource referenced by the result document can be read be the user of the given OpenCms context.

Parameters:

cms - the OpenCms user context to use for permission testing

doc - the search result document to check

Returns:

true if the user has read permissions to the resource