NAME

       STAR::Filter - Perl extension for filtering DataBlock objects

   Version
       This documentation refers to version 0.01 of this module.

SYNOPSIS

         use STAR::Filter;

DESCRIPTION

       Contains the filter object for filtering DataBlock objects.  DataBlock objects are created
       by Parser and modified by DataBlock.

CLASS METHODS

   filter_dict
         Usage:  $filtered_dict = STAR::Filter->filter_dict(
                                    -dict=>$dict,
                                    -options=>$options);

       A (very simplistic) interactive method for filtering a STAR::Dictionary object (.cob
       file). The user is prompted for each category whether to include (retain) it in the
       filtered object. The method returns a reference to the filtered (reduced) STAR::Dictionary
       object.

       Note: This method is preliminary and subject to change.

   filter_through_dict
         Usage:  $filtered_data = STAR::Filter->filter_through_dict(
                                    -data=>$data,
                                    -dict=>$dict,
                                    -options=>$options);

       Filters an STAR::DataBlock object through a STAR::Dictionary object.  Returns a reference
       to a new STAR::DataBlock object in which only those items are included which were defined
       in the specified dictionary.

AUTHOR

       Wolfgang Bluhm, mail@wbluhm.com

   Acknowledgments
       Thanks to Phil Bourne, Helge Weissig, Anne Kuller, Doug Greer, Michele Bluhm, and others
       for support, help, and comments.

COPYRIGHT

       A full copyright statement is provided with the distribution Copyright (c) 2000 University
       of California, San Diego

SEE ALSO

       STAR::Parser, STAR::DataBlock, STAR::Dictionary.