|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opencms.search.CmsSearchIndexSource
A search index source is a description of a list of Cms resources to be indexed.
Constructor Summary | |
CmsSearchIndexSource()
Creates a new CmsSearchIndexSource. |
Method Summary | |
void |
addConfigurationParameter(java.lang.String key,
java.lang.String value)
Adds a parameter. |
void |
addDocumentType(java.lang.String key)
Adds the key/name of a document type. |
void |
addResourceName(java.lang.String resourceName)
Adds the path of a Cms resource. |
int |
compareTo(java.lang.Object o)
Compares the internal name Strings of this instance and the argument casted to this type. |
boolean |
equals(java.lang.Object obj)
Implemented to be consistent with overridden method . |
java.util.List |
getDocumentTypes()
Returns the list of Cms resource types to be indexed. |
I_CmsIndexer |
getIndexer()
Returns the indexer. |
java.lang.String |
getIndexerClassName()
Returns the class name of the indexer. |
java.lang.String |
getName()
Returns the logical key/name of this search index source. |
java.lang.String |
getParam(java.lang.String key)
Returns the value for a specified parameter key. |
java.util.Map |
getParams()
Returns the map of optional key/value parameters. |
java.util.List |
getResourcesNames()
Returns the list of Cms resources to be indexed. |
int |
hashCode()
Overriden to be consistents with overridden method . |
boolean |
removeDocumentType(java.lang.String key)
Removes the key/name of a document type. |
void |
setDocumentTypes(java.util.List documentTypes)
Sets the list of Cms resource types to be indexed. |
void |
setIndexerClassName(java.lang.String indexerClassName)
Sets the class name of the indexer. |
void |
setName(java.lang.String name)
Sets the logical key/name of this search index source. |
void |
setParams(java.util.Map params)
Sets the map of optional key/value parameters. |
void |
setResourcesNames(java.util.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 |
public CmsSearchIndexSource()
Method Detail |
public void addConfigurationParameter(java.lang.String key, java.lang.String value)
key
- the key/name of the parametervalue
- the value of the parameterpublic void addDocumentType(java.lang.String key)
key
- the key/name of a document typepublic void addResourceName(java.lang.String resourceName)
resourceName
- the path of a Cms resourcepublic int compareTo(java.lang.Object o) throws java.lang.ClassCastException
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.
compareTo
in interface java.lang.Comparable
o
- another indexsource.
String.compareTo(java.lang.String)
for the
name member of both indexsource instances involved.
java.lang.ClassCastException
- if the given argument is not assignable from this class.Comparable.compareTo(java.lang.Object)
public boolean equals(java.lang.Object obj)
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.
obj
- another indexsource.
compareTo(Object)
with this argument returns 0, false else.Object.equals(java.lang.Object)
public java.util.List getDocumentTypes()
public I_CmsIndexer getIndexer()
public java.lang.String getIndexerClassName()
public java.lang.String getName()
public java.lang.String getParam(java.lang.String key)
key
- the parameter key/name
public java.util.Map getParams()
public java.util.List getResourcesNames()
public int hashCode()
equals(Object)
.
Object.hashCode()
public boolean removeDocumentType(java.lang.String key)
key
- the key/name of a document type
public void setDocumentTypes(java.util.List documentTypes)
documentTypes
- the list of Cms resource types to be indexedpublic void setIndexerClassName(java.lang.String indexerClassName) throws CmsIllegalArgumentException
An Exception is thrown to allow GUI-display of wrong input.
indexerClassName
- the class name of the indexer
CmsIllegalArgumentException
- if the given String is not a fully qualified classname (within this Java VM)public void setName(java.lang.String name) throws CmsIllegalArgumentException
name
- the logical key/name of this search index source
CmsIllegalArgumentException
- if argument name is null, an empty or whitespace-only Strings
or already used for another indexsource's name.public void setParams(java.util.Map params)
params
- the map of optional key/value parameterspublic void setResourcesNames(java.util.List resources)
resources
- the list of Cms resources (Strings) to be indexed
|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |