<<

NAME

Web::Chain::IO::Rawtext - adds capability to the IO object to handle the DF Rawtext format.

SYNOPSIS

   See L<Web::Chain::IO>

DESCRIPTION

This class is used to create an input handle object used internally by a Web::Chain::IO handle, to handle input and (ultimately) output from files in the the "Rawtext" DF (aka "Doomfiles") format.

In other words, Web::Chain::IO is the interface, this class is (one) of the implementations.

METHODS

new - create an input handle, used by a Web::Chain::IO object. Example usage:

   my $input_handle = $input_class->new( $self );

input - takes the filename to be read (typically from the already defined input location, but this can be over-ridden by using a full path with this filename), and optionally a numeric limit on how many nodes are to be read from this file (in the case of Rawtext, that option is a nearly useless feature, it's provided only to be consistent with other input modules). Input returns a newly created chain object containing the newly read data. Example:

   $dfh->input($file_name) or $dfh->input($file_name, $howmany)

FUTURE DEVELOPMENT

  Methods are currently only provided for input.  
  Add output routines also (fairly easy really).

SEE ALSO

Project Documentation

AUTHOR

Joseph Brenner, <doom@kzsu.stanford.edu>

COPYRIGHT AND LICENSE

Copyright (C) 2004 by Joseph Brenner

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.8.2 or, at your option, any later version of Perl 5 you may have available.

BUGS

None reported... yet.

<<