GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  CONFIG::MODEL::TREESEARCHER (3)

.ds Aq ’

NAME

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

CONTENTS

VERSION

version 2.082

SYNOPSIS



 use Config::Model ;

 # 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("\n",@result),"\n" ;
 # 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

AUTHOR

Dominique Dumont

COPYRIGHT AND LICENSE

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

This is free software, licensed under:



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



Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 CONFIG::MODEL::TREESEARCHER (3) 2016-04-03

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.