org.opencms.search
Class CmsSearchIndexSource

java.lang.Object
  org.opencms.search.CmsSearchIndexSource

All Implemented Interfaces:

Comparable

public class CmsSearchIndexSource
extends Object
implements Comparable

A search index source is a description of a list of Cms resources to be indexed.

Since:

6.0.0

Version:

$Revision: 1.13 $

Author:

Thomas Weckert

Constructor Summary

CmsSearchIndexSource()
Creates a new CmsSearchIndexSource.

Method Summary

void	addConfigurationParameter(String key, String value) Adds a parameter.
void	addDocumentType(String key) Adds the key/name of a document type.
void	addResourceName(String resourceName) Adds the path of a Cms resource.
int	compareTo(Object o) Compares the internal name Strings of this instance and the argument casted to this type.
boolean	equals(Object obj) Implemented to be consistent with overridden method compareTo(Object).
List	getDocumentTypes() Returns the list of Cms resource types to be indexed.
I_CmsIndexer	getIndexer() Returns the indexer.
String	getIndexerClassName() Returns the class name of the indexer.
String	getName() Returns the logical key/name of this search index source.
String	getParam(String key) Returns the value for a specified parameter key.
Map	getParams() Returns the map of optional key/value parameters.
List	getResourcesNames() Returns the list of Cms resources to be indexed.
int	hashCode() Overriden to be consistents with overridden method equals(Object).
boolean	removeDocumentType(String key) Removes the key/name of a document type.
void	setDocumentTypes(List documentTypes) Sets the list of Cms resource types to be indexed.
void	setIndexerClassName(String indexerClassName) Sets the class name of the indexer.
void	setName(String name) Sets the logical key/name of this search index source.
void	setParams(Map params) Sets the map of optional key/value parameters.
void	setResourcesNames(List resources) Sets the list of Cms resources to be indexed.

Methods inherited from class java.lang.Object

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

Constructor Detail

CmsSearchIndexSource

public CmsSearchIndexSource()

Creates a new CmsSearchIndexSource.

Method Detail

addConfigurationParameter

public void addConfigurationParameter(String key,
                                      String value)

Adds a parameter.

Parameters:

key - the key/name of the parameter

value - the value of the parameter

addDocumentType

public void addDocumentType(String key)

Adds the key/name of a document type.

Parameters:

key - the key/name of a document type

addResourceName

public void addResourceName(String resourceName)

Adds the path of a Cms resource.

Parameters:

resourceName - the path of a Cms resource

compareTo

public int compareTo(Object o)
              throws ClassCastException

Compares the internal name Strings of this instance and the argument casted to this type.

Note that this method only should return 0 for the statement a.compareTo(a) as the name of a indexsource has to be unique within OpenCms.

Specified by:

compareTo in interface Comparable

Parameters:

o - another indexsource.

Returns:

the comparison result (as specified in String.compareTo(java.lang.String) for the name member of both indexsource instances involved.

Throws:

ClassCastException - if the given argument is not assignable from this class.

See Also:

Comparable.compareTo(java.lang.Object)

equals

public boolean equals(Object obj)

Implemented to be consistent with overridden method compareTo(Object).

Note that this method only should return true for the statement a.compareTo(a) as the name of a indexsource has to be unique within OpenCms.

Overrides:

equals in class Object

Parameters:

obj - another indexsource.

Returns:

true if compareTo(Object) with this argument returns 0, false else.

See Also:

Object.equals(java.lang.Object)

getDocumentTypes

public List getDocumentTypes()

Returns the list of Cms resource types to be indexed.

Returns:

the list of Cms resource types to be indexed

getIndexer

public I_CmsIndexer getIndexer()

Returns the indexer.

Returns:

the indexer

getIndexerClassName

public String getIndexerClassName()

Returns the class name of the indexer.

Returns:

the class name of the indexer

getName

public String getName()

Returns the logical key/name of this search index source.

Returns:

the logical key/name of this search index source

getParam

public String getParam(String key)

Returns the value for a specified parameter key.

Parameters:

key - the parameter key/name

Returns:

the value for the specified parameter key

getParams

public Map getParams()

Returns the map of optional key/value parameters.

Returns:

the map of optional key/value parameters

getResourcesNames

public List getResourcesNames()

Returns the list of Cms resources to be indexed.

Returns:

the list of Cms resources to be indexed

hashCode

public int hashCode()

Overriden to be consistents with overridden method equals(Object).

Overrides:

hashCode in class Object

See Also:

Object.hashCode()

removeDocumentType

public boolean removeDocumentType(String key)

Removes the key/name of a document type.

Parameters:

key - the key/name of a document type

Returns:

true if the given key was contained before thus could be removed successfully, false else.

setDocumentTypes

public void setDocumentTypes(List documentTypes)

Sets the list of Cms resource types to be indexed.

Parameters:

documentTypes - the list of Cms resource types to be indexed

setIndexerClassName

public void setIndexerClassName(String indexerClassName)
                         throws CmsIllegalArgumentException

Sets the class name of the indexer.

An Exception is thrown to allow GUI-display of wrong input.

Parameters:

indexerClassName - the class name of the indexer

Throws:

CmsIllegalArgumentException - if the given String is not a fully qualified classname (within this Java VM)

setName

public void setName(String name)
             throws CmsIllegalArgumentException

Sets the logical key/name of this search index source.

Parameters:

name - the logical key/name of this search index source

Throws:

CmsIllegalArgumentException - if argument name is null, an empty or whitespace-only Strings or already used for another indexsource's name.

setParams

public void setParams(Map params)

Sets the map of optional key/value parameters.

Parameters:

params - the map of optional key/value parameters

setResourcesNames

public void setResourcesNames(List resources)

Sets the list of Cms resources to be indexed.

Parameters:

resources - the list of Cms resources (Strings) to be indexed