config::model::annotation(3pm) [debian man page]

Config::Model::Annotation(3pm)				User Contributed Perl Documentation			    Config::Model::Annotation(3pm)

NAME

       Config::Model::Annotation - Read and write configuration annotations

VERSION

       version 2.021

SYNOPSIS

	use Config::Model ;
	use Log::Log4perl qw(:easy) ;
	Log::Log4perl->easy_init($WARN);

	# define configuration tree object
	my $model = Config::Model->new ;
	$model ->create_config_class (
	   name => "MyClass",
	   element => [
	       [qw/foo bar/] => {
		   type => 'leaf',
		   value_type => 'string'
	       },
	       baz => {
		   type => 'hash',
		   index_type => 'string' ,
		   cargo => {
		       type => 'leaf',
		       value_type => 'string',
		   },
	       },

	   ],
	) ;

	my $inst = $model->instance(root_class_name => 'MyClass' );

	my $root = $inst->config_root ;

	# put some data in config tree the hard way
	$root->fetch_element('foo')->store('yada') ;
	$root->fetch_element('baz')->fetch_with_id('en')->store('hello') ;

	# put annotation the hard way
	$root->fetch_element('foo')->annotation('english') ;
	$root->fetch_element('baz')->fetch_with_id('en')->annotation('also english') ;

	# put more data the easy way
	my $step = 'baz:fr=bonjour#french baz:hr="dobar dan"#croatian';
	$root->load( step => $step ) ;

	# dump resulting tree with annotations
	print $root->dump_tree;

	# save annotations
	my $annotate_saver = Config::Model::Annotation
	 -> new (
		 config_class_name => 'MyClass',
		 instance => $inst ,
		 root_dir => '/tmp/', # for test
		) ;
	$annotate_saver->save ;

	# now check content of /tmp/config-model/MyClass-note.pl

DESCRIPTION

       This module provides an object that read and write annotations (a bit like comments) to and from a configuration tree and save them in a
       file (not configuration file)

       Depending on the effective id of the process, the annotation will be saved in:

       o   "/var/lib/config-model/<model_name>-note.yml" for root (EUID == 0)

       o   "~/.config-model/<model_name>-note.yml" for normal user (EUID > 0)

CONSTRUCTOR

       Quite standard. The constructor is passed a Config::Model::Instance object.

METHODS

   save()
       Save annotations in a file (See DESCRIPTION)

   load()
       Loads annotations from a file (See DESCRIPTION)

AUTHOR

       Dominique Dumont, (ddumont at cpan dot org)

SEE ALSO

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

perl v5.14.2							    2012-11-09					    Config::Model::Annotation(3pm)

Config::Model::Report(3pm)				User Contributed Perl Documentation				Config::Model::Report(3pm)

NAME

       Config::Model::Report - Reports data from config tree

VERSION

       version 2.021

SYNOPSIS

	use Config::Model;
	use Log::Log4perl qw(:easy);
	Log::Log4perl->easy_init($WARN);

	# define configuration tree object
	my $model = Config::Model->new;
	$model->create_config_class(
	   name    => "Foo",
	   element => [
	       [qw/foo bar/] => {
		   type       => 'leaf',
		   value_type => 'string'
	       },
	   ],
	   description => [
	       foo => 'some foo explanation',
	       bar => 'some bar explanation',
	   ]
	);

	$model->create_config_class(
	   name => "MyClass",

	   element => [

	       [qw/foo bar/] => {
		   type       => 'leaf',
		   value_type => 'string'
	       },
	       my_enum => {
		   type       => 'leaf',
		   value_type => 'enum',
		   choice     => [qw/A B C/],
		   help       => {
		       A => 'first letter',
		       B => 'second letter',
		       C => 'third letter',
		   },
		   description => 'some letters',
	       },
	       hash_of_nodes => {
		   type       => 'hash',     # hash id
		   index_type => 'string',
		   cargo      => {
		       type		 => 'node',
		       config_class_name => 'Foo'
		   },
	       },
	   ],
	);

	my $inst = $model->instance(root_class_name => 'MyClass' );

	my $root = $inst->config_root ;

	# put data
	my $step = 'foo=FOO my_enum=B hash_of_nodes:fr foo=bonjour -
	  hash_of_nodes:en foo=hello ';
	$root->load( step => $step );

	print $root->report ;
	#  foo = FOO
	#
	#  my_enum = B
	#	  DESCRIPTION: some letters
	#	  SELECTED: second letter
	#
	# hash_of_nodes:en foo = hello
	#	  DESCRIPTION: some foo explanation
	#
	# hash_of_nodes:fr foo = bonjour
	#	  DESCRIPTION: some foo explanation

DESCRIPTION

       This module is used directly by Config::Model::Node to provide a human readable report of the configuration. This report includes the
       configuration values and (if provided by the model) the description of the configuration item and their effect.

       A "report" will show "all" configuration items. An "audit" will show only configuration items which are different from their default value.

CONSTRUCTOR

   new ( )
       No parameter. The constructor should be used only by Config::Model::Node.

Methods
   report
       Returns a string containing the configuration values and (if provided by the model) the description of the configuration item and their
       effect.

       Parameters are:

       audit
	   Set to 1 to report only configuration data different from default values. Default is 0.

       node
	   Reference to the Config::Model::Node object that is dumped. All nodes and leaves attached to this node are also dumped.

AUTHOR

       Dominique Dumont, (ddumont at cpan dot org)

SEE ALSO

       Config::Model,Config::Model::Node,Config::Model::Walker

perl v5.14.2							    2012-11-09						Config::Model::Report(3pm)