NAME

Config::Model::Instance - Instance of configuration tree

SYNOPSIS

my $model = Config::Model->new() ;
$model ->create_config_class ( ... ) ;

my $inst = $model->instance (root_class_name => 'SomeRootClass', 
                             instance_name    => 'some_name');

DESCRIPTION

This module provides an object that holds a configuration tree.

CONSTRUCTOR

Usually, an instance object is created by calling instance method on an existing model:

my $inst = $model->instance (root_class_name => 'SomeRootClass', 
                             instance_name => 'test1');

METHODS

name()

Returns the instance name.

config_root()

Returns the root object of the configuration tree.

config_model()

Returns the model of the configuration tree.

push_no_value_check ( fetch | store | type , ... )

Tune Config::Model::Value to perform check on read (fetch) or write (store) or verify the value according to its value_type. The passed parameters are stacked. Parameters are :

store

Skip write check.

fetch

Skip read check.

type

Skip value_type check (See Config::Model::Value for details). I.e Config::Model::Value will not enforce type checking.

Note that these values are stacked. They can be read by get_value_check until the next push_no_value_check or pop_no_value_check call.

Example:

$i->push_no_value_check('fetch') ;
$i->push_no_value_check('fetch','type') ;

pop_no_value_check()

Pop off the check stack the last check set entered with push_no_value_check.

get_value_check ( fetch | store | type | fetch_or_store )

Read the check status. Returns 1 if a check is to be done. O if not. When used with the fetch_or_store parameter, returns a logical or or the check values, i.e. read_check || write_check

data( kind, [data] )

The data method provide a way to store some arbitrary data in the instance object.

load( "..." )

Load configuration tree with configuration data. See Config::Model::Loader for more details

search_element ( element => <name> [, privilege => ... ] )

Search an element in the configuration model (respecting privilege level).

This method returns a Config::Model::Searcher object. See Config::Model::Searcher for details on how to handle a search.

wizard_helper ( ... )

This method returns a Config::Model::WizardHelper object. See Config::Model::WizardHelper for details on how to create a wizard widget with this object.

wizard_helper arguments are explained in Config::Model::WizardHelper constructor arguments.

Auto read and write feature

Usually, a program based on config model must first create the configuration model, then load all configuration data.

This feature enables you to declare with the model a way to load configuration data (and to write it back). See Config::Model::AutoRead for details.

read_directory()

Returns directory where configuration data is read from.

write_directory()

Returns directory where configuration data is written to.

register_write_back ( sub_ref )

Register a sub ref that will be called with write_back method.

write_back

Run all subroutines registered with register_write_back to write the configuration informations. (See Config::Model::AutoRead for details).

AUTHOR

Dominique Dumont, domi@komarr.grenoble.hp.com

SEE ALSO

Config::Model, Config::Model::Node, Config::Model::Loader, Config::Model::Searcher, Config::Model::Value,

cpanm Config::Model

perl -MCPAN -e shell
install Config::Model