NAME

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

VERSION

version 2.080

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.

pattern

Describe the element matching the regexp ref. Example:

describe => ( pattern => qr/^foo/ )

AUTHOR

Dominique Dumont, (ddumont at cpan dot org)

SEE ALSO

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

AUTHOR

Dominique Dumont

COPYRIGHT AND LICENSE

This software is Copyright (c) 2016 by Dominique Dumont.

This is free software, licensed under:

The GNU Lesser General Public License, Version 2.1, February 1999