Xindice API
version 1.1

org.apache.xindice.util
Interface Configurable

All Known Subinterfaces:
Filer, Indexer, QueryResolver
All Known Implementing Classes:
Collection, CollectionManager, Paged, SimpleConfigurable

public interface Configurable

Configurable is a simple interface used to pass configuration information to an object. The implementing object is ultimately responsible for maintaining any of that configuration information in any fashion it so desires. Most will create a Configuration instance to manage the data in a consistent, and easy to access fashion.

A Configurable object should be considered 'configured' after receiving a call to setConfig(). No additional configuration activities should be expected of the instance, and so setConfig() should be the last call in any set of configuration commands against an object.

Version:
$Revision: 511426 $, $Date: 2007-02-24 22:25:02 -0500 (Sat, 24 Feb 2007) $
See Also:
Configuration

Method Summary
 Configuration getConfig()
          getConfig retrieves the configuration information for the Configurable object instance.
 void setConfig(Configuration config)
          setConfig sets the configuration information for the Configurable object instance.
 

Method Detail

setConfig

public void setConfig(Configuration config)
               throws XindiceException
setConfig sets the configuration information for the Configurable object instance.
Parameters:
config - The configuration Node

getConfig

public Configuration getConfig()
getConfig retrieves the configuration information for the Configurable object instance.
Returns:
The configuration Node

Xindice API
version 1.1

Copyright (c) 1999-2007 The Apache Software Foundation. All Rights Reserved.