CmsSearchIndexSource

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

所有已实现的接口:

java.lang.Comparable<CmsSearchIndexSource>
```
public class CmsSearchIndexSource
extends java.lang.Object
implements java.lang.Comparable<CmsSearchIndexSource>
```
A search index source is a description of a list of Cms resources to be indexed.

从以下版本开始:

6.0.0

构造器概要

构造器
构造器和说明

CmsSearchIndexSource()
Creates a new CmsSearchIndexSource.

构造器
构造器和说明
`CmsSearchIndexSource()` Creates a new CmsSearchIndexSource.

方法概要

方法
限定符和类型	方法和说明
`void`	`addConfigurationParameter(java.lang.String key, java.lang.String value)` Adds a parameter.
`void`	`addDocumentType(java.lang.String key)` Adds the name of a document type.
`void`	`addResourceName(java.lang.String resourceName)` Adds the path of a Cms resource.
`int`	`compareTo(CmsSearchIndexSource obj)` Returns `0` if the given object is an index source with the same name.
`boolean`	`equals(java.lang.Object obj)` Two index sources are considered equal if their names as returned by `getName()` is equal.
`java.util.List<java.lang.String>`	`getDocumentTypes()` Returns the list of names (Strings) of the document 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<java.lang.String,java.lang.String>`	`getParams()` Returns the map of optional key/value parameters.
`java.util.List<java.lang.String>`	`getResourcesNames()` Returns the list of VFS resources to be indexed.
`int`	`hashCode()` Overriden to be consistents with overridden method `equals(Object)`.
`boolean`	`isContaining(java.lang.String rootPath)` Returns `true` in case the given resource root path is contained in the list of configured resource names of this index source.
`boolean`	`isIndexing(java.lang.String rootPath, java.lang.String documentType)` Returns `true` in case the given resource root path is contained in the list of configured resource names, and the given document type name is contained in the list if configured document type names of this index source.
`boolean`	`removeDocumentType(java.lang.String key)` Removes the name of a document type from the list of configured types of this index source.
`void`	`setDocumentTypes(java.util.List<java.lang.String> documentTypes)` Sets the list of document type names (Strings) 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<java.lang.String,java.lang.String> params)` Sets the map of optional key/value parameters.
`void`	`setResourcesNames(java.util.List<java.lang.String> resources)` Sets the list of Cms resources to be indexed.

从类继承的方法 java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - CmsSearchIndexSource
```
public CmsSearchIndexSource()
```
    Creates a new CmsSearchIndexSource.
- 方法详细资料
  - addConfigurationParameter
```
public void addConfigurationParameter(java.lang.String key,
                             java.lang.String value)
```
    Adds a parameter.
    
    参数:
    key - the key/name of the parameter
    value - the value of the parameter
  - addDocumentType
```
public void addDocumentType(java.lang.String key)
```
    Adds the name of a document type.
    
    参数:
    key - the name of a document type to add
  - addResourceName
```
public void addResourceName(java.lang.String resourceName)
```
    Adds the path of a Cms resource.
    
    参数:
    resourceName - the path of a Cms resource
  - compareTo
```
public int compareTo(CmsSearchIndexSource obj)
```
    Returns 0 if the given object is an index source with the same name.
    Note that the name of an index source has to be unique within OpenCms.
    
    指定者:
    
    compareTo 在接口中 java.lang.Comparable<CmsSearchIndexSource>
    
    参数:
    obj - another index source
    
    返回:
    0 if the given object is an index source with the same name
    另请参阅:
    Comparable.compareTo(java.lang.Object)
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Two index sources are considered equal if their names as returned by getName() is equal.
    Note that the name of an index source has to be unique within OpenCms.
    
    覆盖:
    
    equals 在类中 java.lang.Object
    
    另请参阅:
    Object.equals(java.lang.Object)
  - getDocumentTypes
```
public java.util.List<java.lang.String> getDocumentTypes()
```
    Returns the list of names (Strings) of the document types to be indexed.
    
    返回:
    the list of names (Strings) of the document types to be indexed
  - getIndexer
```
public I_CmsIndexer getIndexer()
```
    Returns the indexer.
    
    返回:
    the indexer
  - getIndexerClassName
```
public java.lang.String getIndexerClassName()
```
    Returns the class name of the indexer.
    
    返回:
    the class name of the indexer
  - getName
```
public java.lang.String getName()
```
    Returns the logical key/name of this search index source.
    
    返回:
    the logical key/name of this search index source
  - getParam
```
public java.lang.String getParam(java.lang.String key)
```
    Returns the value for a specified parameter key.
    
    参数:
    key - the parameter key/name
    
    返回:
    the value for the specified parameter key
  - getParams
```
public java.util.Map<java.lang.String,java.lang.String> getParams()
```
    Returns the map of optional key/value parameters.
    
    返回:
    the map of optional key/value parameters
  - getResourcesNames
```
public java.util.List<java.lang.String> getResourcesNames()
```
    Returns the list of VFS resources to be indexed.
    
    返回:
    the list of VFS resources to be indexed
  - hashCode
```
public int hashCode()
```
    Overriden to be consistents with overridden method equals(Object).
    
    覆盖:
    
    hashCode 在类中 java.lang.Object
    
    另请参阅:
    Object.hashCode()
  - isContaining
```
public boolean isContaining(java.lang.String rootPath)
```
    Returns true in case the given resource root path is contained in the list of configured resource names of this index source.
    
    参数:
    rootPath - the resource root path to check
    
    返回:
    true in case the given resource root path is contained in the list of configured resource names of this index source
    另请参阅:
    getResourcesNames()
  - isIndexing
```
public boolean isIndexing(java.lang.String rootPath,
                 java.lang.String documentType)
```
    Returns true in case the given resource root path is contained in the list of configured resource names, and the given document type name is contained in the list if configured document type names of this index source.
    
    参数:
    rootPath - the resource root path to check
    documentType - the document type factory name to check
    
    返回:
    true in case the given resource root path is contained in the list of configured resource names, and the given document type name is contained in the list if configured document type names of this index source
    另请参阅:
    isContaining(String), getDocumentTypes()
  - removeDocumentType
```
public boolean removeDocumentType(java.lang.String key)
```
    Removes the name of a document type from the list of configured types of this index source.
    
    参数:
    key - the name of the document type to remove
    
    返回:
    true if the given document type name was contained before thus could be removed successfully, false otherwise
  - setDocumentTypes
```
public void setDocumentTypes(java.util.List<java.lang.String> documentTypes)
```
    Sets the list of document type names (Strings) to be indexed.
    
    参数:
    documentTypes - the list of document type names (Strings) to be indexed
  - setIndexerClassName
```
public void setIndexerClassName(java.lang.String indexerClassName)
                         throws CmsIllegalArgumentException
```
    Sets the class name of the indexer.
    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)
  - setName
```
public void setName(java.lang.String name)
             throws CmsIllegalArgumentException
```
    Sets the logical key/name of this search index source.
    
    参数:
    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.
  - setParams
```
public void setParams(java.util.Map<java.lang.String,java.lang.String> params)
```
    Sets the map of optional key/value parameters.
    
    参数:
    params - the map of optional key/value parameters
  - setResourcesNames
```
public void setResourcesNames(java.util.List<java.lang.String> resources)
```
    Sets the list of Cms resources to be indexed.
    
    参数:
    resources - the list of Cms resources (Strings) to be indexed

类 CmsSearchIndexSource

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

CmsSearchIndexSource

方法详细资料

addConfigurationParameter

addDocumentType

addResourceName

compareTo

equals

getDocumentTypes

getIndexer

getIndexerClassName

getName

getParam

getParams

getResourcesNames

hashCode

isContaining

isIndexing

removeDocumentType

setDocumentTypes

setIndexerClassName

setName

setParams

setResourcesNames