.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  | will give a
.\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
.\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
.\" expand to `' in nroff, nothing in troff, for use with C<>.
.tr \(*W-|\(bv\*(Tr
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.\"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "KinoSearch::Util::Class 3"
.TH KinoSearch::Util::Class 3 "2008-01-14" "perl v5.8.8" "User Contributed Perl Documentation"
.SH "NAME"
KinoSearch::Util::Class \- class building utility
.SH "PRIVATE CLASS"
.IX Header "PRIVATE CLASS"
This is a private class and the interface may change radically and without
warning.  Do not use it on its own.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&    package KinoSearch::SomePackage::SomeClass;
\&    use base qw( KinoSearch::Util::Class );
.Ve
.PP
.Vb 5
\&    BEGIN {
\&        __PACKAGE__->init_instance_vars(
\&            # constructor params / members
\&            foo => undef,
\&            bar => {},
.Ve
.PP
.Vb 4
\&            # members
\&            baz => {},
\&        );
\&    }
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
KinoSearch::Util::Class is a class-building utility a la
Class::Accessor, Class::Meta, etc.  It
provides four main services:
.IP "1" 4
.IX Item "1"
A mechanism for inheriting instance variable declarations.
.IP "2" 4
.IX Item "2"
A constructor with basic argument checking.
.IP "3" 4
.IX Item "3"
Manufacturing of get_xxxx and set_xxxx methods.
.IP "4" 4
.IX Item "4"
Convenience methods which help in defining abstract classes.
.SH "VARIABLES"
.IX Header "VARIABLES"
.Sh "%instance_vars"
.IX Subsection "%instance_vars"
The \f(CW%instance_vars\fR hash, which is always a package global, serves as a
template for the creation of a hash-based object.  It is built up from all the
\&\f(CW%instance_vars\fR hashes in the module's parent classes, using
\&\fIinit_instance_vars()\fR.  
.PP
Key-value pairs in an \f(CW%instance_vars\fR hash are labeled as \*(L"constructor params\*(R"
and/or \*(L"members\*(R".  Items which are labeled as constructor params can be used
as arguments to \fInew()\fR.
.PP
.Vb 9
\&    BEGIN {
\&        __PACKAGE__->init_instance_vars(
\&            # constructor params / members
\&            foo => undef,
\&            bar => {},
\&            # members
\&            baz => '',
\&        );
\&    }
.Ve
.PP
.Vb 2
\&    # ok: specifies foo, uses default for bar, derives baz
\&    my $object = __PACKAGE__->new( foo => $foo );
.Ve
.PP
.Vb 2
\&    # not ok: baz isn't a constructor param
\&    my $object = __PACKAGE__->new( baz => $baz );
.Ve
.PP
.Vb 5
\&    # ok if a parent class defines boffo as a constructor param
\&    my $object = __PACKAGE__->new( 
\&        foo   => $foo,
\&        boffo => $boffo,
\&    );
.Ve
.PP
%instance_vars may contain hashrefs and array\-refs, as Clone's
\&\f(CW\*(C`clone()\*(C'\fR method is used to produce a deep copy.
.PP
\&\fIinit_instance_vars()\fR must be called from within a \s-1BEGIN\s0 block and before any
\&\f(CW\*(C`use\*(C'\fR directives load a child class \*(-- if children are born before their
parents, inheritance gets screwed up.
.SH "METHODS"
.IX Header "METHODS"
.Sh "new"
.IX Subsection "new"
A generic constructor with basic argument checking.  \fInew()\fR expects hash-style
labeled parameters; the label names must be present in the \f(CW%instance_vars\fR
hash, or it will \fIcroak()\fR.
.PP
After verifying the labeled parameters, \fInew()\fR creates a deep clone of
\&\f(CW%instance_vars\fR, and merges in the labeled arguments.  It then calls
\&\f(CW$self\fR\->\fIinit_instance()\fR before returning the blessed reference.
.Sh "init_instance"
.IX Subsection "init_instance"
.Vb 1
\&    $self->init_instance();
.Ve
.PP
Perform customized initialization routine.  By default, this is a no\-op.
.Sh "init_instance_vars"
.IX Subsection "init_instance_vars"
.Vb 6
\&    BEGIN {
\&        __PACKAGE__->init_instance_vars(
\&            a_safe_variable_name_that_wont_clash => 1,
\&            freep_warble                         => undef,
\&        );
\&    }
.Ve
.PP
Package method only.  Creates a package global \f(CW%instance_vars\fR hash in the
passed in package which consists of the passed in arguments plus all the
key-value pairs in the parent class's \f(CW%instance_vars\fR hash.
.Sh "ready_get_set ready_get ready_set"
.IX Subsection "ready_get_set ready_get ready_set"
.Vb 2
\&    # create get_foo(), set_foo(), get_bar(), set_bar() in __PACKAGE__
\&    BEGIN { __PACKAGE__->ready_get_set(qw( foo bar )) };
.Ve
.PP
Mass manufacture getters and setters.  The setters do not return a meaningful
value.
.Sh "abstract_death unimplemented_death todo_death"
.IX Subsection "abstract_death unimplemented_death todo_death"
.Vb 3
\&    sub an_abstract_method      { shift->abstract_death }
\&    sub an_unimplemented_method { shift->unimplemented_death }
\&    sub maybe_someday           { shift->todo_death }
.Ve
.PP
These are just different ways to \fIdie()\fR, and are of little interest until your
particular application comes face to face with one of them.  
.PP
abstract_death indicates that a method must be defined in a subclass.
.PP
unimplemented_death indicates a feature/function that will probably not be
implemented.  Typically, this would appear for a sub that a developer
intimately familiar with Lucene would expect to find.
.PP
todo_death indicates a feature that might get implemented someday.
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright 2005\-2006 Marvin Humphrey
.SH "LICENSE, DISCLAIMER, BUGS, etc."
.IX Header "LICENSE, DISCLAIMER, BUGS, etc."
See KinoSearch version 0.15.