The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
Siebel-Srvrmgr-0.23
River stage zero No dependents
++
/ Siebel::Srvrmgr::ListParser::Output

NAME

Siebel::Srvrmgr::ListParser::Output - base class of srvrmgr output

SYNOPSIS

        use Siebel::Srvrmgr::ListParser::Output;

        my $output = Siebel::Srvrmgr::ListParser::Output->new({ data_type => 'sometype', 
                                                                                                                        raw_data => \@data, 
                                                                                                                        cmd_line => 'list something from somewhere'});

        $output->store($complete_pathname);

DESCRIPTION

Siebel::Srvrmgr::ListParser::Output is a superclass of output types classes.

It contains only basic attributes and methods that enable specific parsing and serializable methods.

The parse method must be overrided by subclasses or a exception will be raised during object creation.

ATTRIBUTES

data_type

Identifies which kind of data is being given to the class. This is usually used by abstract factory class to identify which subclass of Siebel::Srvrmgr::ListParser::Output must be created.

This attribute is required during object creation.

raw_data

An array reference with the lines to be processed.

This attribute is required during object creation.

data_parsed

An hash reference with the data parsed from raw_data attribute.

cmd_line

A string of the command that originates from the output (the data of raw_data attribute).

This attribute is required during object creation.

clear_raw

A boolean attribute that defines if the raw data recovered from srvrmgr should be kept or discarded as soon as possibly.

Having a default value of true, it should help reducing memory usage or debugging, if set false.

METHODS

clear_raw

Getter for the clear_raw attribute.

set_clear_raw

Setter for the clear_raw attribute.

get_cmd_line

Returns an string of the attribute get_cmd_line.

get_data_parsed

Retuns an hash reference of data_parsed attribute.

set_data_parsed

Sets the data_parsed attribute. It is expected an hash reference as parameter of the method.

get_raw_data

Returns an array reference of the attribute raw_data.

set_raw_data

Sets the raw_data attribute. An array reference is expected as parameter of the method.

load

Method inherited from MooseX::Storage::IO::StorableFile role. It loads a previously serialized Siebel::Srvrmgr::ListParser:Output object into memory.

store

Method inherited from MooseX::Storage::IO::StorableFile role. It stores (serializes) a Siebel::Srvrmgr::ListParser:Output object into a file. A a string of the filename (with complete or not full path) is expected as a parameter.

BUILD

All subclasses of Siebel::Srvrmgr::ListParser::Object will call the method parse right after object instatiation.

parse

This method must be overrided by subclasses.

SEE ALSO

AUTHOR

Alceu Rodrigues de Freitas Junior, <arfreitas@cpan.org>.

COPYRIGHT AND LICENSE

This software is copyright (c) 2012 of Alceu Rodrigues de Freitas Junior, <arfreitas@cpan.org>.

This file is part of Siebel Monitoring Tools.

Siebel Monitoring Tools is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

Siebel Monitoring Tools is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with Siebel Monitoring Tools. If not, see http://www.gnu.org/licenses/.