NAME

NexTrieve::Resource - handle the resource specifications of NexTrieve

SYNOPSIS

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

# using collections
$collection = $ntv->Collection( path );
$resource = $collection->Resource( mnemonic );

# direct resource file access without using collections
$resource = $ntv->Resource( | file | xml | {method => value} );

DESCRIPTION

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

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

BASE METHODS

The following methods handle certain base aspects of the NexTrieve resource-file.

basedir

$resource->basedir( path ); 
$basedir = $resource->basedir;

indexdir

$resource->indexdir( path ); 
$indexdir = $resource->indexdir;

cache

$resource->cache( size ); 
$cache = $resource->cache;

licensefile

$resource->licensefile( file ); 
$licensefile = $resource->licensefile;

logfile

$resource->logfile( file ); 
$logfile = $resource->logfile;

INDEXCREATION METHODS

The following methods apply to the <indexcreation> section.

attribute

($type,$key,$nvals) = $resource->attribute( name );
$resource->attribute( name,
                     string | number | flag,
                     key-unique | key-duplicates | notkey,
                     1 | * );

attributes

@attribute = $resource->attributes;
$resource->attributes( name1 | [name1,type1,key1,nvals1], name2 .. nameN )

texttype

($weight) = $resource->texttype( name );
$resource->texttype( name,weight );

texttypes

@texttype = $resource->texttypes;
$resource->texttypes( name1 | [name1,weight1], name2 .. nameN );

INDEXING METHODS

The following methods apply to the <indexing> section.

unknowntext

$resource->unknowntext( log | !log | stop, ignore | default );
($logaction,$indexaction) = $resource->unknowntext;

nestedtext

$resource->nestedtext( log | !log | stop, ignore | inherit );
($logaction,$indexaction) = $resource->nestedtext;

unknownattrs

$resource->unknownattrs( log | !log | stop );
$logaction = $resource->unknownattrs;

nestedattrs

$resource->nestedattrs( log | !log | stop );
$logaction = $resource->nestedattrs;

SEARCHING METHODS

The following methods apply to the <searching> section.

highlight

$resource->highlight( container,on,off );
($container,$on,$off) = $resource->highlight;

querylog

$resource->querylog( file );
$querylog = $resource->querylog;

threads

$resource->threads( connector,worker,core );
($connector,$worker,$core) = $resource->threads;

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.