NAME
HH::Unispool::Config::Entry::Filter - UNISPOOL filter information
SYNOPSIS
use strict;
use HH::Unispool::Config;
use HH::Unispool::Config::OS;
use HH::Unispool::Config::FilterType;
use HH::Unispool::Config::Entry::Filter;
use HH::Unispool::Config::Entry::System;
use HH::Unispool::Config::Entry::RemoteSystem::8;
# Create a config from scratch
my $conf3 = HH::Unispool::Config->new();
# Create a filter and add it to the configuration
my $flt = HH::Unispool::Config::Entry::Filter->new( {
name => 'cat',
file => '/usr/bin/cat',
} );
$conf3->add_filter($flt);
# Create another filter and add it to the configuration
$flt = HH::Unispool::Config::Entry::Filter->new( {
name => 'lpcat',
file => '/my/bin/dir/lpcat',
type => HH::Unispool::Config::FilterType->new( {
type => 'lp',
} ),
} );
$conf3->add_filter($flt);
# Create the _Network_ system and add it to the configuration
my $sysn = HH::Unispool::Config::Entry::System->new( {
name => '_Network_',
} );
$conf3->add_system($sysn);
# Add a type 8 remote system to _Network_
my $rsys = HH::Unispool::Config::Entry::RemoteSystem::8->new( {
name => 'foo',
os => HH::Unispool::Config::OS->new( { os => 'Solaris' } ),
remote_node_name => 'foo.bar.org',
} );
$sysn->add_remote_system($rsys);
# Create the foo.bar.org system and add it to the configuration
my $sysf = HH::Unispool::Config::Entry::System->new( {
name => 'foo.bar.org',
local_system_name => 'foo',
network_name => 'foo.bar.org',
os => HH::Unispool::Config::OS->new( { os => 'Solaris' } ),
type => 'cs',
} );
$conf3->add_system($sysf);
# Write the configuration
$conf3->write('t/config.sample.flt.out');
ABSTRACT
UNISPOOL filter information
DESCRIPTION
HH::Unispool::Config::Entry::Filter
holds information for UNISPOOL filter definitions.
CONSTRUCTOR
- new(OPT_HASH_REF)
-
Creates a new
HH::Unispool::Config::Entry::Filter
object.OPT_HASH_REF
is a hash reference used to pass initialization options.OPT_HASH_REF
is mandatory. On error an exceptionError::Simple
is thrown.Options for
OPT_HASH_REF
may include:file
-
Passed to set_file(). Mandatory option.
type
-
Passed to set_type(). Defaults to HH::Unispool::Config::FilterType->new( { type = 'default'} )>.
Options for
OPT_HASH_REF
inherited through packageHH::Unispool::Config::Entry
may include:name
-
Passed to set_name(). Mandatory option.
- new_from_tokenizer(TOKENIZER)
-
This method is an implementation from package
HH::Unispool::Config::Entry
. Constructs a newHH::Unispool::Config::Entry
object using tokens.TOKENIZER
is anHH::Unispool::Config::File::Tokenizer
reference. On error an exceptionError::Simple
is thrown.
METHODS
- diff(TO)
-
This method is overloaded from package
HH::Unispool::Config::Entry
. Finds differences between two objects. Indiff
terms, the object is the from object and the specifiedTO
parameter the to object.TO
is a reference to an identical object class. Returns an empty string if no difference found and a difference descritpion string otherwise. On error an exceptionError::Simple
is thrown. - get_file()
-
Returns the file name for the filter.
- get_name()
-
This method is inherited from package
HH::Unispool::Config::Entry
. Returns the entry name. - get_type()
-
Returns the type of the filter.
- set_file(VALUE)
-
Set the file name for the filter.
VALUE
is the value.VALUE
may not beundef
. On error an exceptionError::Simple
is thrown. - set_name(VALUE)
-
This method is inherited from package
HH::Unispool::Config::Entry
. Set the entry name.VALUE
is the value.VALUE
may not beundef
. On error an exceptionError::Simple
is thrown. - set_type(VALUE)
-
Set the type of the filter.
VALUE
is the value. Default value at initialization isHH::Unispool::Config::FilterType->new( { type =
'default'} )>.VALUE
may not beundef
. On error an exceptionError::Simple
is thrown. - write(FILE_HANDLE)
-
This method is an implementation from package
HH::Unispool::Config::Entry
. Writes the entry to the specified file handle.FILE_HANDLE
is anIO::Handle
reference. On error an exceptionError::Simple
is thrown.
SEE ALSO
HH::Unispool::Config, HH::Unispool::Config::DateFormat, HH::Unispool::Config::Entry, HH::Unispool::Config::Entry::Device, HH::Unispool::Config::Entry::Device::0, HH::Unispool::Config::Entry::Device::1, HH::Unispool::Config::Entry::Device::2, HH::Unispool::Config::Entry::Device::3, HH::Unispool::Config::Entry::Device::4, HH::Unispool::Config::Entry::Device::5, HH::Unispool::Config::Entry::Device::6, HH::Unispool::Config::Entry::Device::7, HH::Unispool::Config::Entry::Numbered, HH::Unispool::Config::Entry::RemoteSystem, HH::Unispool::Config::Entry::RemoteSystem::3, HH::Unispool::Config::Entry::RemoteSystem::6, HH::Unispool::Config::Entry::RemoteSystem::7, HH::Unispool::Config::Entry::RemoteSystem::8, HH::Unispool::Config::Entry::System, HH::Unispool::Config::ExecPri, HH::Unispool::Config::File::Token, HH::Unispool::Config::File::Token::Comment, HH::Unispool::Config::File::Token::Comment::Cs, HH::Unispool::Config::File::Token::Comment::Date, HH::Unispool::Config::File::Token::Comment::Device, HH::Unispool::Config::File::Token::Comment::Filter, HH::Unispool::Config::File::Token::Comment::Group, HH::Unispool::Config::File::Token::Comment::Head, HH::Unispool::Config::File::Token::Comment::Misc, HH::Unispool::Config::File::Token::Comment::NetDesc, HH::Unispool::Config::File::Token::Comment::RSys, HH::Unispool::Config::File::Token::Comment::Scope, HH::Unispool::Config::File::Token::Comment::Tail, HH::Unispool::Config::File::Token::Factory, HH::Unispool::Config::File::Token::Numbered, HH::Unispool::Config::File::Token::Numbered::Device, HH::Unispool::Config::File::Token::Numbered::Device::0, HH::Unispool::Config::File::Token::Numbered::Device::1, HH::Unispool::Config::File::Token::Numbered::Device::2, HH::Unispool::Config::File::Token::Numbered::Device::3, HH::Unispool::Config::File::Token::Numbered::Device::4, HH::Unispool::Config::File::Token::Numbered::Device::5, HH::Unispool::Config::File::Token::Numbered::Device::6, HH::Unispool::Config::File::Token::Numbered::Device::7, HH::Unispool::Config::File::Token::Numbered::Device::Group, HH::Unispool::Config::File::Token::Numbered::Device::Info, HH::Unispool::Config::File::Token::Numbered::Device::P, HH::Unispool::Config::File::Token::Numbered::Network, HH::Unispool::Config::File::Token::Numbered::System, HH::Unispool::Config::File::Token::Numbered::System::3, HH::Unispool::Config::File::Token::Numbered::System::6, HH::Unispool::Config::File::Token::Numbered::System::7, HH::Unispool::Config::File::Token::Numbered::System::8, HH::Unispool::Config::File::Token::Numbered::System::Info, HH::Unispool::Config::File::Token::Numbered::X, HH::Unispool::Config::File::Token::Unnumbered, HH::Unispool::Config::File::Token::Unnumbered::Bcs, HH::Unispool::Config::File::Token::Unnumbered::CSN, HH::Unispool::Config::File::Token::Unnumbered::Cs, HH::Unispool::Config::File::Token::Unnumbered::CsBcs, HH::Unispool::Config::File::Token::Unnumbered::Filter, HH::Unispool::Config::File::Token::Unnumbered::Host, HH::Unispool::Config::File::Token::Unnumbered::Misc, HH::Unispool::Config::File::Tokenizer, HH::Unispool::Config::FilterType, HH::Unispool::Config::OS, HH::Unispool::Config::Scope
BUGS
None known (yet.)
HISTORY
First development: February 2003 Last update: September 2003
AUTHOR
Vincenzo Zocca
COPYRIGHT
Copyright 2003 by Vincenzo Zocca
LICENSE
This file is part of the HH::Unispool::Config
module hierarchy for Perl by Vincenzo Zocca.
The HH::Unispool::Config module hierarchy 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 2 of the License, or (at your option) any later version.
The HH::Unispool::Config module hierarchy 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 the HH::Unispool::Config module hierarchy; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA