/ 
NexTrieve-0.02
/ NexTrieve::Index

NAME

NexTrieve::Index - handle indexing with NexTrieve

SYNOPSIS

use NexTrieve;
die unless NexTrieve::Index->executable;

$ntv = NexTrieve->new( | {method => value} );

# using collections
$collection = $ntv->Collection( path );
$index = $collection->Index( mnemonic, | {method => value} );

# using direct access
$resource = $ntv->Resource( | file | xml | {method => value} );
$index = $ntv->Index( | file | $resource | {method => value}, | {}, | files );

# indexing created XML on the fly
$docseq = $index->Docseq;
$docseq->add( xml );
$docseq->done;

# indexing pre-created XML stored in files
$index->index( file1,file2,file3 );

# do it all yourself with created XML on the fly
$handle = $index->stream;
print $handle xml;
close( $handle );

$result = $index->result;

DESCRIPTION

The Index object of the Perl support for NexTrieve. Do not create directly, but through the Index method of the NexTrieve or the NexTrieve::Collection object.

CLASS METHODS

These methods are available as class methods.

executable

$executable = NexTrieve::Index->executable;

METHODS

These methods are available to the NexTrieve::Index object.

Docseq

$docseq = $index->Docseq;

Resource

$resource = $index->Resource( | file | xml | {method => value} );

index

$index->index( file1,file2,file3 );

indexdir

$index->indexdir( directory );
$directory = $index->indexdir;

log

$index->log( filename );
$log = $index->log;

stream

$handle = $index->stream;

result

$handle = $index->result;

AUTHOR

Elizabeth Mattijsen, <liz@nextrieve.com>.

Please report bugs to <perlbugs@nextrieve.com>.

COPYRIGHT

Copyright (c) 1995-2002 Elizabeth Mattijsen <liz@nextrieve.com>. All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

SEE ALSO

http://www.nextrieve.com, the NexTrieve.pm and the other NexTrieve::xxx modules.