org.apache.jackrabbit.core.config
Class SearchConfig

java.lang.Object
  org.apache.jackrabbit.core.config.BeanConfig
      org.apache.jackrabbit.core.config.SearchConfig

public class SearchConfig

extends BeanConfig

Search index configuration. This bean configuration class is used to create configured search index objects.

In addition to generic bean configuration information, this class also contains an optionally configured file system implementation used by the search index.

See Also:

WorkspaceConfig.getSearchConfig()

Constructor Summary

SearchConfig(String className, Properties properties, FileSystemConfig fsc)
Creates a search index configuration object.

Method Summary

FileSystem	getFileSystem() Returns the search index file system, or null if none is configured.
FileSystemConfig	getFileSystemConfig() Returns the configuration for the FileSystem or null if none is configured in this SearchConfig.
String	getHandlerClassName() Returns the search implementation class name.
void	init() Initializes the search index file system if one is configured.

Methods inherited from class org.apache.jackrabbit.core.config.BeanConfig

getClassName, getParameters, newInstance

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchConfig

public SearchConfig(String className,
                    Properties properties,
                    FileSystemConfig fsc)

Creates a search index configuration object.

Parameters:

className - search index implementation class

properties - search index properties

fsc - search index file system configuration, or null if none is configured.

Method Detail

init

public void init()
          throws ConfigurationException

Initializes the search index file system if one is configured.

Throws:

ConfigurationException - on file system configuration errors

getHandlerClassName

public String getHandlerClassName()

Returns the search implementation class name.

Returns:

search implementation class name

getFileSystem

public FileSystem getFileSystem()

Returns the search index file system, or null if none is configured.

Returns:

search index file system

getFileSystemConfig

public FileSystemConfig getFileSystemConfig()

Returns the configuration for the FileSystem or null if none is configured in this SearchConfig.

Returns:

the FileSystemConfig for this SearchConfig.