org.apache.jackrabbit.core.config

Class SearchConfig

java.lang.Object

org.apache.jackrabbit.core.config.BeanConfig

org.apache.jackrabbit.core.config.SearchConfig

All Implemented Interfaces:

org.apache.jackrabbit.core.fs.FileSystemFactory

public class SearchConfig
extends BeanConfig
implements org.apache.jackrabbit.core.fs.FileSystemFactory

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 optional file system configuration used by the search index.

Constructor Summary

Constructors

Constructor and Description
SearchConfig(String className, Properties properties, org.apache.jackrabbit.core.fs.FileSystemFactory fsf) Creates a search index configuration object.

Method Summary

Modifier and Type	Method and Description
org.apache.jackrabbit.core.fs.FileSystem	getFileSystem() Creates and returns the configured search file system, or returns null if a search file system has not been configured.

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

getClassLoader, getClassName, getDefaultClassLoader, getParameters, newInstance, setClassLoader, setConnectionFactory, setDefaultClassLoader, setInstanceFactory, setValidate

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,
                    org.apache.jackrabbit.core.fs.FileSystemFactory fsf)

Creates a search index configuration object.

Parameters:

className - search index implementation class

properties - search index properties

fsf - configured search index file system factory, or null

Method Detail

getFileSystem

public org.apache.jackrabbit.core.fs.FileSystem getFileSystem()
                                                       throws RepositoryException

Creates and returns the configured search file system, or returns null if a search file system has not been configured.

Specified by:

getFileSystem in interface org.apache.jackrabbit.core.fs.FileSystemFactory

Returns:

the configured FileSystem, or null

Throws:

RepositoryException - if the file system can not be created