org.weborganic.bastille.flint.config
Class BaseDefaultConfig

java.lang.Object
  org.weborganic.bastille.flint.config.BaseDefaultConfig

All Implemented Interfaces:

IFlintConfig

Direct Known Subclasses:

ComplexConfig, SimpleConfig

public abstract class BaseDefaultConfig
extends Object
implements IFlintConfig

A base class for flint configurations using the default settings.

The default settings assumes that:

• All indexes are located in the same directory, by default /WEB-INF/index
• All templates are located in the same directory, by default /WEB-INF/ixml
• Source files are located in /WEB-INF/xml or /WEB-INF/psml
• All indexes use the LocalIndex Flint implementation

It also provides some useful utility methods that can be used by implementation.

Method Summary

IndexConfig	getDefaultConfig()
File	getDirectory()
List<String>	getIndexNames()
File	getTemplatesDirectory()
boolean	hasMultiple() Indicates whether flint is configured for multiple indexes.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.weborganic.bastille.flint.config.IFlintConfig

getIndexConfig, getTemplates, reload, toFile, toPath

Method Detail

getDirectory

public final File getDirectory()

Specified by:

getDirectory in interface IFlintConfig

Returns:

the root directory containing the index or indexes.

hasMultiple

public final boolean hasMultiple()

Description copied from interface: IFlintConfig

Indicates whether flint is configured for multiple indexes.

Specified by:

hasMultiple in interface IFlintConfig

Returns:

true if Flint is configured for multiple indexes; false for a single index.

getIndexNames

public final List<String> getIndexNames()

Specified by:

getIndexNames in interface IFlintConfig

Returns:

the list of index names.

getDefaultConfig

public final IndexConfig getDefaultConfig()

Returns:

the default index configuration

getTemplatesDirectory

public final File getTemplatesDirectory()

Returns:

the directory containing the ixml templates.