Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

plucene::index::writer(3pm) [debian man page]

Plucene::Index::Writer(3pm)				User Contributed Perl Documentation			       Plucene::Index::Writer(3pm)

NAME

       Plucene::Index::Writer - write an index.

SYNOPSIS

	       my $writer = Plucene::Index::Writer->new($path, $analyser, $create);

	       $writer->add_document($doc);
	       $writer->add_indexes(@dirs);

	       $writer->optimize; # called before close

	       my $doc_count = $writer->doc_count;

	       my $mergefactor = $writer->mergefactor;

	       $writer->set_mergefactor($value);

DESCRIPTION

       This is the writer class.

       If an index will not have more documents added for a while and optimal search performance is desired, then the "optimize" method should be
       called before the index is closed.

METHODS

   new
	       my $writer = Plucene::Index::Writer->new($path, $analyser, $create);

       This will create a new Plucene::Index::Writer object.

       The third argument to the constructor determines whether a new index is created, or whether an existing index is opened for the addition of
       new documents.

   mergefactor / set_mergefactor
	       my $mergefactor = $writer->mergefactor;

	       $writer->set_mergefactor($value);

       Get / set the mergefactor. It defaults to 5.

   doc_count
	       my $doc_count = $writer->doc_count;

   add_document
	       $writer->add_document($doc);

       Adds a document to the index. After the document has been added, a merge takes place if there are more than
       $Plucene::Index::Writer::mergefactor segments in the index. This defaults to 10, but can be set to whatever value is optimal for your
       application.

   optimize
	       $writer->optimize;

       Merges all segments together into a single segment, optimizing an index for search. This should be the last method called on an indexer, as
       it invalidates the writer object.

   add_indexes
	       $writer->add_indexes(@dirs);

       Merges all segments from an array of indexes into this index.

       This may be used to parallelize batch indexing.	A large document collection can be broken into sub-collections.  Each sub-collection can
       be indexed in parallel, on a different thread, process or machine.  The complete index can then be created by merging sub-collection
       indexes with this method.

       After this completes, the index is optimized.

perl v5.12.4							    2011-08-14					       Plucene::Index::Writer(3pm)

Check Out this Related Man Page

String(3pm)						User Contributed Perl Documentation					       String(3pm)

NAME

       XML::Writer::String - Capture output from XML::Writer.

SYNOPSIS

	 use XML::Writer;
	 use XML::Writer::String;

	 my $s = XML::Writer::String->new();
	 my $writer = new XML::Writer( OUTPUT => $s );

	 $writer->xmlDecl();
	 $writer->startTag('root');
	 $writer->endTag();
	 $writer->end();

	 print $s->value();

DESCRIPTION

       This module implements a bare-bones class specifically for the purpose of capturing data from the XML::Writer module.  XML::Writer expects
       an IO::Handle object and writes XML data to the specified object (or STDOUT) via it's print() method.  This module simulates such an object
       for the specific purpose of providing the required print() method.

       It is recommended that $writer->end() is called prior to calling $s->value() to check for well-formedness.

METHODS

       XML::Writer::String provides three methods, "new()", "print()" and "value()":

       "$s = XML::Writer::String-"new([list]);>
	   new() returns a new String handle.

       "$count = $s-"print([list]);>
	   print() appends concatenated list data and returns number of items in list.

       "$val = $s-"value([list]);>
	   value() returns the current content of the object as a scalar.  It can also be used to initialize/overwrite the current content with
	   concatenated list data.

NOTES

       This module is designed for the specific purpose of capturing the output of XML::Writer objects, as described in this document.	It does
       not inherit form IO::Handle.  For an alternative solution look at IO::Scalar, IO::Lines, IO::String or Tie::Handle::Scalar.

AUTHOR

       Simon Oliver <simon.oliver@umist.ac.uk>

COPYRIGHT

       Copyright (C) 2002 Simon Oliver

       This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

SEE ALSO

       XML::Writer, IO::Handle, IO::Scalar

perl v5.14.2							    2002-03-06							       String(3pm)
Man Page