org.apache.cocoon.components.search.components
Interface IndexManager

All Known Implementing Classes:

IndexManagerImpl

public interface IndexManager

Index Manager Class allow to register and access to a specific index

Author:

Maisonneuve Nicolas

Field Summary

static java.lang.String

ROLE

Method Summary

void	addIndex(Index index) add a index in the indexmanager
void	addIndexes(org.apache.excalibur.source.Source confSource) Adds indexes from the given configuration file to the index manager.
boolean	contains(java.lang.String id) Check if the index exist
Index[]	getIndex() Return all indexes
Index	getIndex(java.lang.String id) Return the index with the id
void	remove(java.lang.String id) remove a index

Field Detail

ROLE

static final java.lang.String ROLE

Method Detail

getIndex

Index[] getIndex()
                 throws IndexException

Return all indexes

Returns:

Array of indexes

Throws:

IndexException

getIndex

Index getIndex(java.lang.String id)
               throws IndexException

Return the index with the id

Parameters:

id - the index ID

Returns:

l'index, null if no found

Throws:

IndexException

addIndex

void addIndex(Index index)

add a index in the indexmanager

Parameters:

index -

remove

void remove(java.lang.String id)

remove a index

Parameters:

id - ID de l'index

contains

boolean contains(java.lang.String id)

Check if the index exist

Parameters:

id - ID de l'index

Returns:

true if the index exist

addIndexes

void addIndexes(org.apache.excalibur.source.Source confSource)
                throws org.apache.avalon.framework.configuration.ConfigurationException

Adds indexes from the given configuration file to the index manager.

Parameters:

confSource -

Throws:

org.apache.avalon.framework.configuration.ConfigurationException