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

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

NAME

       Config::Model::Describe - Provide a description of a node element

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'
	       },
	   ]
	);
	$model ->create_config_class (
	   name => "MyClass",

	   element => [

	       [qw/foo bar/] => {
		   type       => 'leaf',
		   value_type => 'string'
	       },
	       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 hash_of_nodes:fr foo=bonjour -
	  hash_of_nodes:en foo=hello ';
	$root->load( step => $step );

	print $root->describe ;

	### prints
	# name	       value	    type	 comment
	# foo	       FOO	    string
	# bar	       [undef]	    string
	# hash_of_nodes <Foo>	     node hash	  keys: "en" "fr"

DESCRIPTION

       This module is used directly by Config::Model::Node to describe a node element. This module returns a human readable string that shows the
       content of a configuration node.

       For instance (as shown by "fstab" example:

	name	     value	  type	       comment
	fs_spec      [undef]	  string       mandatory
	fs_vfstype   [undef]	  enum	       choice: auto davfs ext2 ext3 swap proc iso9660 vfat ignore, mandatory
	fs_file      [undef]	  string       mandatory
	fs_freq      0		  boolean
	fs_passno    0		  integer

       This module is also used by the "ll" command of Config::Model::TermUI.

CONSTRUCTOR

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

Methods
   describe(...)
       Return a description string.

       Parameters are:

       node
	   Reference to a Config::Model::Node object. Mandatory

       element
	   Describe only this element from the node. Optional. All elements are described if omitted.

AUTHOR

       Dominique Dumont, (ddumont at cpan dot org)

SEE ALSO

       Config::Model,Config::Model::Node,Config::Model::ObjTreeScanner

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

Check Out this Related Man Page

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

NAME

       Config::Model::TreeSearcher - Search tree for match in value, description...

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 ;

	my $step = 'baz:fr=bonjour baz:hr="dobar dan" foo="journalled"';
	$root->load( step => $step ) ;

	my @result = $root->tree_searcher(type => 'value')->search('jour');
	print join("
",@result),"
" ;
	# print
	#  baz:fr
	#  foo

DESCRIPTION

       This class provides a way to search the content of a configuration tree.  Given a keyword or a pattern, the search method will scan the
       tree to find a value, a description or anything that match the given pattern (or keyword).

Constructor
   new (type => [ value | description ... ] )
       Creates a new searcher object. The "type" parameter can be:

       element
       value
       key
       summary
       description
       help
       all Search in all the items above

Methods
   search(keyword)
       Search the keyword or pattern in the tree. The search is done in a case insensitive manner. Returns a list of path pointing to the matching
       tree element. See "grab(...)" in Config::Model::AnyThing for details on the path syntax.

BUGS

       Creating a class with just one search method may be overkill. OTOH, it may be extended later to provide iterative search.

AUTHOR

       Dominique Dumont, (ddumont at cpan dot org)

SEE ALSO

       Config::Model, Config::Model::SearchElement, Config::Model::AnyThing

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

Linux and UNIX Man Pages

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

Check Out this Related Man Page