Modified: websites/staging/lucy/trunk/content/docs/test/Lucy/Index/Indexer.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/test/Lucy/Index/Indexer.html
(original)
+++ websites/staging/lucy/trunk/content/docs/test/Lucy/Index/Indexer.html Fri
Feb 26 12:52:42 2016
@@ -71,15 +71,15 @@
<div>
<a name='___top' class='dummyTopAnchor' ></a>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="NAME"
->NAME</a></h1>
+>NAME</a></h2>
<p>Lucy::Index::Indexer - Build inverted indexes.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="SYNOPSIS"
->SYNOPSIS</a></h1>
+>SYNOPSIS</a></h2>
<pre> my $indexer = Lucy::Index::Indexer->new(
schema => $schema,
@@ -94,28 +94,30 @@ name="SYNOPSIS"
}
$indexer->commit;</pre>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="DESCRIPTION"
->DESCRIPTION</a></h1>
+>DESCRIPTION</a></h2>
-<p>The Indexer class is Apache Lucy's primary tool for managing the
content of inverted indexes, which may later be searched using <a
href="../../Lucy/Search/IndexSearcher.html" class="podlinkpod"
+<p>The Indexer class is Apache Lucy’s primary tool for managing the
content of inverted indexes, which may later be searched using <a
href="../../Lucy/Search/IndexSearcher.html" class="podlinkpod"
>IndexSearcher</a>.</p>
<p>In general, only one Indexer at a time may write to an index safely. If a
write lock cannot be secured, new() will throw an exception.</p>
<p>If an index is located on a shared volume, each writer application must
identify itself by supplying an <a href="../../Lucy/Index/IndexManager.html"
class="podlinkpod"
->IndexManager</a> with a unique <code>host</code> id to Indexer's
constructor or index corruption will occur. See <a
href="../../Lucy/Docs/FileLocking.html" class="podlinkpod"
->Lucy::Docs::FileLocking</a> for a detailed discussion.</p>
+>IndexManager</a> with a unique <code>host</code> id to Indexer’s
constructor or index corruption will occur. See <a
href="../../Lucy/Docs/FileLocking.html" class="podlinkpod"
+>FileLocking</a> for a detailed discussion.</p>
-<p>Note: at present, delete_by_term() and delete_by_query() only affect
documents which had been previously committed to the index -- and not any
documents added this indexing session but not yet committed. This may change in
a future update.</p>
+<p>Note: at present, <a href="#delete_by_term" class="podlinkpod"
+>delete_by_term()</a> and <a href="#delete_by_query" class="podlinkpod"
+>delete_by_query()</a> only affect documents which had been previously
committed to the index – and not any documents added this indexing
session but not yet committed. This may change in a future update.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="CONSTRUCTORS"
->CONSTRUCTORS</a></h1>
+>CONSTRUCTORS</a></h2>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="new(_[labeled_params]_)"
->new( <i>[labeled params]</i> )</a></h2>
+<h3><a class='u'
+name="new"
+>new</a></h3>
<pre> my $indexer = Lucy::Index::Indexer->new(
schema => $schema, # required at index creation
@@ -137,13 +139,13 @@ name="new(_[labeled_params]_)"
<li><b>manager</b> - An IndexManager.</li>
</ul>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="METHODS"
->METHODS</a></h1>
+>METHODS</a></h2>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="add_doc(...)"
->add_doc(...)</a></h2>
+<h3><a class='u'
+name="add_doc"
+>add_doc</a></h3>
<pre> $indexer->add_doc($doc);
$indexer->add_doc( { field_name => $field_value } );
@@ -160,9 +162,11 @@ name="add_doc(...)"
<li><b>boost</b> - A floating point weight which affects how this document
scores.</li>
</ul>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="add_index(index)"
->add_index(index)</a></h2>
+<h3><a class='u'
+name="add_index"
+>add_index</a></h3>
+
+<pre> $indexer->add_index($index);</pre>
<p>Absorb an existing index into this one. The two indexes must have matching
Schemas.</p>
@@ -170,47 +174,29 @@ name="add_index(index)"
<li><b>index</b> - Either an index path name or a Folder.</li>
</ul>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="optimize()"
->optimize()</a></h2>
-
-<p>Optimize the index for search-time performance. This may take a while, as
it can involve rewriting large amounts of data.</p>
-
-<p>Every Indexer session which changes index content and ends in a commit()
creates a new segment. Once written, segments are never modified. However, they
are periodically recycled by feeding their content into the segment currently
being written.</p>
-
-<p>The optimize() method causes all existing index content to be fed back into
the Indexer. When commit() completes after an optimize(), the index will
consist of one segment. So optimize() must be called before commit(). Also,
optimizing a fresh index created from scratch has no effect.</p>
-
-<p>Historically, there was a significant search-time performance benefit to
collapsing down to a single segment versus even two segments. Now the effect of
collapsing is much less significant, and calling optimize() is rarely
justified.</p>
-
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="commit()"
->commit()</a></h2>
-
-<p>Commit any changes made to the index. Until this is called, none of the
changes made during an indexing session are permanent.</p>
-
-<p>Calling commit() invalidates the Indexer, so if you want to make more
changes you'll need a new one.</p>
-
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="prepare_commit()"
->prepare_commit()</a></h2>
-
-<p>Perform the expensive setup for commit() in advance, so that commit()
completes quickly. (If prepare_commit() is not called explicitly by the user,
commit() will call it internally.)</p>
-
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="delete_by_term(_[labeled_params]_)"
->delete_by_term( <i>[labeled params]</i> )</a></h2>
+<h3><a class='u'
+name="delete_by_term"
+>delete_by_term</a></h3>
+
+<pre> $indexer->delete_by_term(
+ field => $field # required
+ term => $term # required
+ );</pre>
-<p>Mark documents which contain the supplied term as deleted, so that they
will be excluded from search results and eventually removed altogether. The
change is not apparent to search apps until after commit() succeeds.</p>
+<p>Mark documents which contain the supplied term as deleted, so that they
will be excluded from search results and eventually removed altogether. The
change is not apparent to search apps until after <a href="#commit"
class="podlinkpod"
+>commit()</a> succeeds.</p>
<ul>
-<li><b>field</b> - The name of an indexed field. (If it is not spec'd as
<code>indexed</code>, an error will occur.)</li>
+<li><b>field</b> - The name of an indexed field. (If it is not spec’d as
<code>indexed</code>, an error will occur.)</li>
-<li><b>term</b> - The term which identifies docs to be marked as deleted. If
<code>field</code> is associated with an Analyzer, <code>term</code> will be
processed automatically (so don't pre-process it yourself).</li>
+<li><b>term</b> - The term which identifies docs to be marked as deleted. If
<code>field</code> is associated with an Analyzer, <code>term</code> will be
processed automatically (so don’t pre-process it yourself).</li>
</ul>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="delete_by_query(query)"
->delete_by_query(query)</a></h2>
+<h3><a class='u'
+name="delete_by_query"
+>delete_by_query</a></h3>
+
+<pre> $indexer->delete_by_query($query);</pre>
<p>Mark documents which match the supplied Query as deleted.</p>
@@ -219,9 +205,11 @@ name="delete_by_query(query)"
>Query</a>.</li>
</ul>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="delete_by_doc_id(doc_id)"
->delete_by_doc_id(doc_id)</a></h2>
+<h3><a class='u'
+name="delete_by_doc_id"
+>delete_by_doc_id</a></h3>
+
+<pre> $indexer->delete_by_doc_id($doc_id);</pre>
<p>Mark the document identified by the supplied document ID as deleted.</p>
@@ -230,15 +218,61 @@ name="delete_by_doc_id(doc_id)"
>document id</a>.</li>
</ul>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="get_schema()"
->get_schema()</a></h2>
+<h3><a class='u'
+name="optimize"
+>optimize</a></h3>
+
+<pre> $indexer->optimize();</pre>
+
+<p>Optimize the index for search-time performance. This may take a while, as
it can involve rewriting large amounts of data.</p>
+
+<p>Every Indexer session which changes index content and ends in a <a
href="#commit" class="podlinkpod"
+>commit()</a> creates a new segment. Once written, segments are never
modified. However, they are periodically recycled by feeding their content into
the segment currently being written.</p>
+
+<p>The <a href="#optimize" class="podlinkpod"
+>optimize()</a> method causes all existing index content to be fed back into
the Indexer. When <a href="#commit" class="podlinkpod"
+>commit()</a> completes after an <a href="#optimize" class="podlinkpod"
+>optimize()</a>, the index will consist of one segment. So <a href="#optimize"
class="podlinkpod"
+>optimize()</a> must be called before <a href="#commit" class="podlinkpod"
+>commit()</a>. Also, optimizing a fresh index created from scratch has no
effect.</p>
+
+<p>Historically, there was a significant search-time performance benefit to
collapsing down to a single segment versus even two segments. Now the effect of
collapsing is much less significant, and calling <a href="#optimize"
class="podlinkpod"
+>optimize()</a> is rarely justified.</p>
+
+<h3><a class='u'
+name="commit"
+>commit</a></h3>
+
+<pre> $indexer->commit();</pre>
+
+<p>Commit any changes made to the index. Until this is called, none of the
changes made during an indexing session are permanent.</p>
+
+<p>Calling <a href="#commit" class="podlinkpod"
+>commit()</a> invalidates the Indexer, so if you want to make more changes
you’ll need a new one.</p>
+
+<h3><a class='u'
+name="prepare_commit"
+>prepare_commit</a></h3>
+
+<pre> $indexer->prepare_commit();</pre>
+
+<p>Perform the expensive setup for <a href="#commit" class="podlinkpod"
+>commit()</a> in advance, so that <a href="#commit" class="podlinkpod"
+>commit()</a> completes quickly. (If <a href="#prepare_commit"
class="podlinkpod"
+>prepare_commit()</a> is not called explicitly by the user, <a href="#commit"
class="podlinkpod"
+>commit()</a> will call it internally.)</p>
+
+<h3><a class='u'
+name="get_schema"
+>get_schema</a></h3>
+
+<pre> my $retval = $indexer->get_schema();</pre>
<p>Accessor for schema.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="INHERITANCE"
->INHERITANCE</a></h1>
+>INHERITANCE</a></h2>
<p>Lucy::Index::Indexer isa Clownfish::Obj.</p>
Modified: websites/staging/lucy/trunk/content/docs/test/Lucy/Index/Lexicon.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/test/Lucy/Index/Lexicon.html
(original)
+++ websites/staging/lucy/trunk/content/docs/test/Lucy/Index/Lexicon.html Fri
Feb 26 12:52:42 2016
@@ -71,15 +71,15 @@
<div>
<a name='___top' class='dummyTopAnchor' ></a>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="NAME"
->NAME</a></h1>
+>NAME</a></h2>
-<p>Lucy::Index::Lexicon - Iterator for a field's terms.</p>
+<p>Lucy::Index::Lexicon - Iterator for a field’s terms.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="SYNOPSIS"
->SYNOPSIS</a></h1>
+>SYNOPSIS</a></h2>
<pre> my $lex_reader =
$seg_reader->obtain('Lucy::Index::LexiconReader');
my $lexicon = $lex_reader->lexicon( field => 'content' );
@@ -87,52 +87,62 @@ name="SYNOPSIS"
print $lexicon->get_term . "\n";
}</pre>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="DESCRIPTION"
->DESCRIPTION</a></h1>
+>DESCRIPTION</a></h2>
<p>A Lexicon is an iterator which provides access to all the unique terms for
a given field in sorted order.</p>
-<p>If an index consists of two documents with a 'content' field
holding "three blind mice" and "three musketeers" respectively,
then iterating through the 'content' field's lexicon would produce
this list:</p>
+<p>If an index consists of two documents with a ‘content’ field
holding “three blind mice” and “three musketeers”
respectively, then iterating through the ‘content’ field’s
lexicon would produce this list:</p>
<pre> blind
mice
musketeers
three</pre>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="ABSTRACT_METHODS"
->ABSTRACT METHODS</a></h1>
+>ABSTRACT METHODS</a></h2>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="seek(target)"
->seek(target)</a></h2>
+<h3><a class='u'
+name="seek"
+>seek</a></h3>
+
+<pre> $lexicon->seek($target);
+ $lexicon->seek(); # default: undef</pre>
<p>Seek the Lexicon to the first iterator state which is greater than or equal
to <code>target</code>. If <code>target</code> is undef, reset the iterator.</p>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="next()"
->next()</a></h2>
+<h3><a class='u'
+name="next"
+>next</a></h3>
+
+<pre> my $retval = $lexicon->next();</pre>
<p>Proceed to the next term.</p>
<p>Returns: true until the iterator is exhausted, then false.</p>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="get_term()"
->get_term()</a></h2>
+<h3><a class='u'
+name="reset"
+>reset</a></h3>
-<p>Return the current term, or undef if the iterator is not in a valid
state.</p>
+<pre> $lexicon->reset();</pre>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="reset()"
->reset()</a></h2>
+<p>Reset the iterator. <a href="#next" class="podlinkpod"
+>next()</a> must be called to proceed to the first element.</p>
-<p>Reset the iterator. next() must be called to proceed to the first
element.</p>
+<h3><a class='u'
+name="get_term"
+>get_term</a></h3>
+
+<pre> my $retval = $lexicon->get_term();</pre>
+
+<p>Return the current term, or undef if the iterator is not in a valid
state.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="INHERITANCE"
->INHERITANCE</a></h1>
+>INHERITANCE</a></h2>
<p>Lucy::Index::Lexicon isa Clownfish::Obj.</p>
Modified:
websites/staging/lucy/trunk/content/docs/test/Lucy/Index/LexiconReader.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/test/Lucy/Index/LexiconReader.html
(original)
+++ websites/staging/lucy/trunk/content/docs/test/Lucy/Index/LexiconReader.html
Fri Feb 26 12:52:42 2016
@@ -71,32 +71,37 @@
<div>
<a name='___top' class='dummyTopAnchor' ></a>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="NAME"
->NAME</a></h1>
+>NAME</a></h2>
<p>Lucy::Index::LexiconReader - Read Lexicon data.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="SYNOPSIS"
->SYNOPSIS</a></h1>
+>SYNOPSIS</a></h2>
<pre> my $lex_reader =
$seg_reader->obtain("Lucy::Index::LexiconReader");
my $lexicon = $lex_reader->lexicon( field => 'title'
);</pre>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="DESCRIPTION"
->DESCRIPTION</a></h1>
+>DESCRIPTION</a></h2>
<p>LexiconReader reads term dictionary information.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="ABSTRACT_METHODS"
->ABSTRACT METHODS</a></h1>
+>ABSTRACT METHODS</a></h2>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="lexicon(_[labeled_params]_)"
->lexicon( <i>[labeled params]</i> )</a></h2>
+<h3><a class='u'
+name="lexicon"
+>lexicon</a></h3>
+
+<pre> my $retval = $lexicon_reader->lexicon(
+ field => $field # required
+ term => $term # default: undef
+ );</pre>
<p>Return a new Lexicon for the given <code>field</code>. Will return undef if
either the field is not indexed, or if no documents contain a value for the
field.</p>
@@ -106,15 +111,41 @@ name="lexicon(_[labeled_params]_)"
<li><b>term</b> - Pre-locate the Lexicon to this term.</li>
</ul>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="doc_freq(_[labeled_params]_)"
->doc_freq( <i>[labeled params]</i> )</a></h2>
+<h3><a class='u'
+name="doc_freq"
+>doc_freq</a></h3>
+
+<pre> my $retval = $lexicon_reader->doc_freq(
+ field => $field # required
+ term => $term # required
+ );</pre>
<p>Return the number of documents where the specified term is present.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
+name="METHODS"
+>METHODS</a></h2>
+
+<h3><a class='u'
+name="aggregator"
+>aggregator</a></h3>
+
+<pre> my $retval = $lexicon_reader->aggregator(
+ readers => $readers # required
+ offsets => $offsets # required
+ );</pre>
+
+<p>Return a LexiconReader which merges the output of other LexiconReaders.</p>
+
+<ul>
+<li><b>readers</b> - An array of LexiconReaders.</li>
+
+<li><b>offsets</b> - Doc id start offsets for each reader.</li>
+</ul>
+
+<h2><a class='u'
name="INHERITANCE"
->INHERITANCE</a></h1>
+>INHERITANCE</a></h2>
<p>Lucy::Index::LexiconReader isa <a href="../../Lucy/Index/DataReader.html"
class="podlinkpod"
>Lucy::Index::DataReader</a> isa Clownfish::Obj.</p>
Modified:
websites/staging/lucy/trunk/content/docs/test/Lucy/Index/PolyReader.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/test/Lucy/Index/PolyReader.html
(original)
+++ websites/staging/lucy/trunk/content/docs/test/Lucy/Index/PolyReader.html
Fri Feb 26 12:52:42 2016
@@ -71,15 +71,15 @@
<div>
<a name='___top' class='dummyTopAnchor' ></a>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="NAME"
->NAME</a></h1>
+>NAME</a></h2>
<p>Lucy::Index::PolyReader - Multi-segment implementation of IndexReader.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="SYNOPSIS"
->SYNOPSIS</a></h1>
+>SYNOPSIS</a></h2>
<pre> my $polyreader = Lucy::Index::IndexReader->open(
index => '/path/to/index',
@@ -90,19 +90,64 @@ name="SYNOPSIS"
print " $doc_id: $doc->{title}\n";
}</pre>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="DESCRIPTION"
->DESCRIPTION</a></h1>
+>DESCRIPTION</a></h2>
-<p>PolyReader conflates index data from multiple segments. For instance, if an
index contains three segments with 10 documents each, PolyReader's
doc_max() method will return 30.</p>
+<p>PolyReader conflates index data from multiple segments. For instance, if an
index contains three segments with 10 documents each, PolyReader’s <a
href="../../Lucy/Index/IndexReader.html#doc_max" class="podlinkpod"
+>doc_max()</a> method will return 30.</p>
-<p>Some of PolyReader's <a href="../../Lucy/Index/DataReader.html"
class="podlinkpod"
+<p>Some of PolyReader’s <a href="../../Lucy/Index/DataReader.html"
class="podlinkpod"
>DataReader</a> components may be less efficient or complete than the
>single-segment implementations accessed via <a
>href="../../Lucy/Index/SegReader.html" class="podlinkpod"
>SegReader</a>.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
+name="METHODS"
+>METHODS</a></h2>
+
+<h3><a class='u'
+name="doc_max"
+>doc_max</a></h3>
+
+<pre> my $retval = $poly_reader->doc_max();</pre>
+
+<p>Return the maximum number of documents available to the reader, which is
also the highest possible internal document id. Documents which have been
marked as deleted but not yet purged from the index are included in this
count.</p>
+
+<h3><a class='u'
+name="doc_count"
+>doc_count</a></h3>
+
+<pre> my $retval = $poly_reader->doc_count();</pre>
+
+<p>Return the number of documents available to the reader, subtracting any
that are marked as deleted.</p>
+
+<h3><a class='u'
+name="del_count"
+>del_count</a></h3>
+
+<pre> my $retval = $poly_reader->del_count();</pre>
+
+<p>Return the number of documents which have been marked as deleted but not
yet purged from the index.</p>
+
+<h3><a class='u'
+name="offsets"
+>offsets</a></h3>
+
+<pre> my $retval = $poly_reader->offsets();</pre>
+
+<p>Return an array with one entry for each segment, corresponding to segment
doc_id start offset.</p>
+
+<h3><a class='u'
+name="seg_readers"
+>seg_readers</a></h3>
+
+<pre> my $retval = $poly_reader->seg_readers();</pre>
+
+<p>Return an array of all the SegReaders represented within the
IndexReader.</p>
+
+<h2><a class='u'
name="INHERITANCE"
->INHERITANCE</a></h1>
+>INHERITANCE</a></h2>
<p>Lucy::Index::PolyReader isa <a href="../../Lucy/Index/IndexReader.html"
class="podlinkpod"
>Lucy::Index::IndexReader</a> isa <a href="../../Lucy/Index/DataReader.html"
>class="podlinkpod"
Modified:
websites/staging/lucy/trunk/content/docs/test/Lucy/Index/PostingList.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/test/Lucy/Index/PostingList.html
(original)
+++ websites/staging/lucy/trunk/content/docs/test/Lucy/Index/PostingList.html
Fri Feb 26 12:52:42 2016
@@ -71,15 +71,15 @@
<div>
<a name='___top' class='dummyTopAnchor' ></a>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="NAME"
->NAME</a></h1>
+>NAME</a></h2>
<p>Lucy::Index::PostingList - Term-Document pairings.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="SYNOPSIS"
->SYNOPSIS</a></h1>
+>SYNOPSIS</a></h2>
<pre> my $posting_list_reader
= $seg_reader->obtain("Lucy::Index::PostingListReader");
@@ -91,42 +91,33 @@ name="SYNOPSIS"
say "Matching doc id: $doc_id";
}</pre>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="DESCRIPTION"
->DESCRIPTION</a></h1>
+>DESCRIPTION</a></h2>
<p>PostingList is an iterator which supplies a list of document ids that match
a given term.</p>
<p>See <a href="../../Lucy/Docs/IRTheory.html" class="podlinkpod"
->Lucy::Docs::IRTheory</a> for definitions of "posting" and
"posting list".</p>
+>IRTheory</a> for definitions of “posting” and “posting
list”.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="ABSTRACT_METHODS"
->ABSTRACT METHODS</a></h1>
+>ABSTRACT METHODS</a></h2>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="next()"
->next()</a></h2>
+<h3><a class='u'
+name="get_doc_freq"
+>get_doc_freq</a></h3>
-<p>Proceed to the next doc id.</p>
-
-<p>Returns: A positive doc id, or 0 once the iterator is exhausted.</p>
-
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="get_doc_id()"
->get_doc_id()</a></h2>
-
-<p>Return the current doc id. Valid only after a successful call to next() or
advance() and must not be called otherwise.</p>
-
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="get_doc_freq()"
->get_doc_freq()</a></h2>
+<pre> my $retval = $posting_list->get_doc_freq();</pre>
<p>Return the number of documents that the PostingList contains. (This number
will include any documents which have been marked as deleted but not yet
purged.)</p>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="seek(target)"
->seek(target)</a></h2>
+<h3><a class='u'
+name="seek"
+>seek</a></h3>
+
+<pre> $posting_list->seek($target);
+ $posting_list->seek(); # default: undef</pre>
<p>Prepare the PostingList object to iterate over matches for documents that
match <code>target</code>.</p>
@@ -134,25 +125,9 @@ name="seek(target)"
<li><b>target</b> - The term to match. If undef, the iterator will be
empty.</li>
</ul>
-<h1><a class='u' href='#___top' title='click to go to top of document'
-name="METHODS"
->METHODS</a></h1>
-
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="advance(target)"
->advance(target)</a></h2>
-
-<p>Advance the iterator to the first doc id greater than or equal to
<code>target</code>. The default implementation simply calls next() over and
over, but subclasses have the option of doing something more efficient.</p>
-
-<ul>
-<li><b>target</b> - A positive doc id, which must be greater than the current
doc id once the iterator has been initialized.</li>
-</ul>
-
-<p>Returns: A positive doc id, or 0 once the iterator is exhausted.</p>
-
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="INHERITANCE"
->INHERITANCE</a></h1>
+>INHERITANCE</a></h2>
<p>Lucy::Index::PostingList isa <a href="../../Lucy/Search/Matcher.html"
class="podlinkpod"
>Lucy::Search::Matcher</a> isa Clownfish::Obj.</p>
Modified:
websites/staging/lucy/trunk/content/docs/test/Lucy/Index/PostingListReader.html
==============================================================================
---
websites/staging/lucy/trunk/content/docs/test/Lucy/Index/PostingListReader.html
(original)
+++
websites/staging/lucy/trunk/content/docs/test/Lucy/Index/PostingListReader.html
Fri Feb 26 12:52:42 2016
@@ -71,15 +71,15 @@
<div>
<a name='___top' class='dummyTopAnchor' ></a>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="NAME"
->NAME</a></h1>
+>NAME</a></h2>
<p>Lucy::Index::PostingListReader - Read postings data.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="SYNOPSIS"
->SYNOPSIS</a></h1>
+>SYNOPSIS</a></h2>
<pre> my $posting_list_reader
= $seg_reader->obtain("Lucy::Index::PostingListReader");
@@ -88,32 +88,53 @@ name="SYNOPSIS"
term => 'foo',
);</pre>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="DESCRIPTION"
->DESCRIPTION</a></h1>
+>DESCRIPTION</a></h2>
<p>PostingListReaders produce <a href="../../Lucy/Index/PostingList.html"
class="podlinkpod"
>PostingList</a> objects which convey document matching information.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="ABSTRACT_METHODS"
->ABSTRACT METHODS</a></h1>
+>ABSTRACT METHODS</a></h2>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="posting_list(_[labeled_params]_)"
->posting_list( <i>[labeled params]</i> )</a></h2>
+<h3><a class='u'
+name="posting_list"
+>posting_list</a></h3>
+
+<pre> my $retval = $posting_list_reader->posting_list(
+ field => $field # default: undef
+ term => $term # default: undef
+ );</pre>
<p>Returns a PostingList, or undef if either <code>field</code> is undef or
<code>field</code> is not present in any documents.</p>
<ul>
<li><b>field</b> - A field name.</li>
-<li><b>term</b> - If supplied, the PostingList will be pre-located to this
term using seek().</li>
+<li><b>term</b> - If supplied, the PostingList will be pre-located to this
term using <a href="../../Lucy/Index/PostingList.html#seek" class="podlinkpod"
+>seek()</a>.</li>
</ul>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
+name="METHODS"
+>METHODS</a></h2>
+
+<h3><a class='u'
+name="aggregator"
+>aggregator</a></h3>
+
+<pre> my $retval = $posting_list_reader->aggregator(
+ readers => $readers # required
+ offsets => $offsets # required
+ );</pre>
+
+<p>Returns undef since PostingLists may only be iterated at the segment
level.</p>
+
+<h2><a class='u'
name="INHERITANCE"
->INHERITANCE</a></h1>
+>INHERITANCE</a></h2>
<p>Lucy::Index::PostingListReader isa <a
href="../../Lucy/Index/DataReader.html" class="podlinkpod"
>Lucy::Index::DataReader</a> isa Clownfish::Obj.</p>
Modified:
websites/staging/lucy/trunk/content/docs/test/Lucy/Index/SegReader.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/test/Lucy/Index/SegReader.html
(original)
+++ websites/staging/lucy/trunk/content/docs/test/Lucy/Index/SegReader.html Fri
Feb 26 12:52:42 2016
@@ -71,15 +71,15 @@
<div>
<a name='___top' class='dummyTopAnchor' ></a>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="NAME"
->NAME</a></h1>
+>NAME</a></h2>
<p>Lucy::Index::SegReader - Single-segment IndexReader.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="SYNOPSIS"
->SYNOPSIS</a></h1>
+>SYNOPSIS</a></h2>
<pre> my $polyreader = Lucy::Index::IndexReader->open(
index => '/path/to/index',
@@ -96,36 +96,80 @@ name="SYNOPSIS"
}
}</pre>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="DESCRIPTION"
->DESCRIPTION</a></h1>
+>DESCRIPTION</a></h2>
<p>SegReader interprets the data within a single segment of an index.</p>
<p>Generally speaking, only advanced users writing subclasses which manipulate
data at the segment level need to deal with the SegReader API directly.</p>
-<p>Nearly all of SegReader's functionality is implemented by pluggable
components spawned by <a href="../../Lucy/Plan/Architecture.html"
class="podlinkpod"
->Architecture</a>'s factory methods.</p>
+<p>Nearly all of SegReader’s functionality is implemented by pluggable
components spawned by <a href="../../Lucy/Plan/Architecture.html"
class="podlinkpod"
+>Architecture</a>’s factory methods.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="METHODS"
->METHODS</a></h1>
+>METHODS</a></h2>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="get_seg_name()"
->get_seg_name()</a></h2>
+<h3><a class='u'
+name="get_seg_name"
+>get_seg_name</a></h3>
+
+<pre> my $retval = $seg_reader->get_seg_name();</pre>
<p>Return the name of the segment.</p>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="get_seg_num()"
->get_seg_num()</a></h2>
+<h3><a class='u'
+name="get_seg_num"
+>get_seg_num</a></h3>
+
+<pre> my $retval = $seg_reader->get_seg_num();</pre>
<p>Return the number of the segment.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h3><a class='u'
+name="del_count"
+>del_count</a></h3>
+
+<pre> my $retval = $seg_reader->del_count();</pre>
+
+<p>Return the number of documents which have been marked as deleted but not
yet purged from the index.</p>
+
+<h3><a class='u'
+name="doc_max"
+>doc_max</a></h3>
+
+<pre> my $retval = $seg_reader->doc_max();</pre>
+
+<p>Return the maximum number of documents available to the reader, which is
also the highest possible internal document id. Documents which have been
marked as deleted but not yet purged from the index are included in this
count.</p>
+
+<h3><a class='u'
+name="doc_count"
+>doc_count</a></h3>
+
+<pre> my $retval = $seg_reader->doc_count();</pre>
+
+<p>Return the number of documents available to the reader, subtracting any
that are marked as deleted.</p>
+
+<h3><a class='u'
+name="_offsets"
+>_offsets</a></h3>
+
+<pre> my $retval = $seg_reader->_offsets();</pre>
+
+<p>Return an array with one entry for each segment, corresponding to segment
doc_id start offset.</p>
+
+<h3><a class='u'
+name="seg_readers"
+>seg_readers</a></h3>
+
+<pre> my $retval = $seg_reader->seg_readers();</pre>
+
+<p>Return an array of all the SegReaders represented within the
IndexReader.</p>
+
+<h2><a class='u'
name="INHERITANCE"
->INHERITANCE</a></h1>
+>INHERITANCE</a></h2>
<p>Lucy::Index::SegReader isa <a href="../../Lucy/Index/IndexReader.html"
class="podlinkpod"
>Lucy::Index::IndexReader</a> isa <a href="../../Lucy/Index/DataReader.html"
>class="podlinkpod"
Modified:
websites/staging/lucy/trunk/content/docs/test/Lucy/Index/SegWriter.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/test/Lucy/Index/SegWriter.html
(original)
+++ websites/staging/lucy/trunk/content/docs/test/Lucy/Index/SegWriter.html Fri
Feb 26 12:52:42 2016
@@ -71,15 +71,15 @@
<div>
<a name='___top' class='dummyTopAnchor' ></a>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="NAME"
->NAME</a></h1>
+>NAME</a></h2>
<p>Lucy::Index::SegWriter - Write one segment of an index.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="DESCRIPTION"
->DESCRIPTION</a></h1>
+>DESCRIPTION</a></h2>
<p>SegWriter is a conduit through which information fed to Indexer passes.
It manages <a href="../../Lucy/Index/Segment.html" class="podlinkpod"
@@ -91,35 +91,26 @@ and feeds low level <a href="../../Lucy/
<p>The sub-components of a SegWriter are determined by <a
href="../../Lucy/Plan/Architecture.html" class="podlinkpod"
>Architecture</a>.
-DataWriter components which are added to the stack of writers via add_writer()
have add_inverted_doc() invoked for each document supplied to SegWriter's
add_doc().</p>
+DataWriter components which are added to the stack of writers via <a
href="#add_writer" class="podlinkpod"
+>add_writer()</a> have Add_Inverted_Doc() invoked for each document supplied
to SegWriter’s <a href="#add_doc" class="podlinkpod"
+>add_doc()</a>.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="METHODS"
->METHODS</a></h1>
+>METHODS</a></h2>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="add_doc(_[labeled_params]_)"
->add_doc( <i>[labeled params]</i> )</a></h2>
-
-<p>Add a document to the segment.
-Inverts <code>doc</code>,
-increments the Segment's internal document id,
-then calls add_inverted_doc(),
-feeding all sub-writers.</p>
-
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="add_writer(writer)"
->add_writer(writer)</a></h2>
-
-<p>Add a DataWriter to the SegWriter's stack of writers.</p>
-
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="register(_[labeled_params]_)"
->register( <i>[labeled params]</i> )</a></h2>
-
-<p>Register a DataWriter component with the SegWriter.
-(Note that registration simply makes the writer available via fetch(),
-so you may also want to call add_writer()).</p>
+<h3><a class='u'
+name="register"
+>register</a></h3>
+
+<pre> $seg_writer->register(
+ api => $api # required
+ component => $component # required
+ );</pre>
+
+<p>Register a DataWriter component with the SegWriter. (Note that registration
simply makes the writer available via <a href="#fetch" class="podlinkpod"
+>fetch()</a>, so you may also want to call <a href="#add_writer"
class="podlinkpod"
+>add_writer()</a>).</p>
<ul>
<li><b>api</b> - The name of the DataWriter api which <code>writer</code>
implements.</li>
@@ -127,9 +118,11 @@ so you may also want to call add_writer(
<li><b>component</b> - A DataWriter.</li>
</ul>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="fetch(api)"
->fetch(api)</a></h2>
+<h3><a class='u'
+name="fetch"
+>fetch</a></h3>
+
+<pre> my $retval = $seg_writer->fetch($api);</pre>
<p>Retrieve a registered component.</p>
@@ -137,9 +130,53 @@ name="fetch(api)"
<li><b>api</b> - The name of the DataWriter api which the component
implements.</li>
</ul>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h3><a class='u'
+name="add_writer"
+>add_writer</a></h3>
+
+<pre> $seg_writer->add_writer($writer);</pre>
+
+<p>Add a DataWriter to the SegWriter’s stack of writers.</p>
+
+<h3><a class='u'
+name="add_doc"
+>add_doc</a></h3>
+
+<pre> $seg_writer->add_doc(
+ doc => $doc # required
+ boost => $boost # default: 1.0
+ );</pre>
+
+<p>Add a document to the segment. Inverts <code>doc</code>, increments the
Segment’s internal document id, then calls Add_Inverted_Doc(), feeding
all sub-writers.</p>
+
+<h3><a class='u'
+name="add_segment"
+>add_segment</a></h3>
+
+<pre> $seg_writer->add_segment(
+ reader => $reader # required
+ doc_map => $doc_map # default: undef
+ );</pre>
+
+<p>Add content from an existing segment into the one currently being
written.</p>
+
+<ul>
+<li><b>reader</b> - The SegReader containing content to add.</li>
+
+<li><b>doc_map</b> - An array of integers mapping old document ids to new.
Deleted documents are mapped to 0, indicating that they should be skipped.</li>
+</ul>
+
+<h3><a class='u'
+name="finish"
+>finish</a></h3>
+
+<pre> $seg_writer->finish();</pre>
+
+<p>Complete the segment: close all streams, store metadata, etc.</p>
+
+<h2><a class='u'
name="INHERITANCE"
->INHERITANCE</a></h1>
+>INHERITANCE</a></h2>
<p>Lucy::Index::SegWriter isa <a href="../../Lucy/Index/DataWriter.html"
class="podlinkpod"
>Lucy::Index::DataWriter</a> isa Clownfish::Obj.</p>
Modified: websites/staging/lucy/trunk/content/docs/test/Lucy/Index/Segment.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/test/Lucy/Index/Segment.html
(original)
+++ websites/staging/lucy/trunk/content/docs/test/Lucy/Index/Segment.html Fri
Feb 26 12:52:42 2016
@@ -71,15 +71,15 @@
<div>
<a name='___top' class='dummyTopAnchor' ></a>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="NAME"
->NAME</a></h1>
+>NAME</a></h2>
<p>Lucy::Index::Segment - Warehouse for information about one segment of an
inverted index.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="SYNOPSIS"
->SYNOPSIS</a></h1>
+>SYNOPSIS</a></h2>
<pre> # Index-time.
package MyDataWriter;
@@ -111,21 +111,23 @@ name="SYNOPSIS"
return $self;
}</pre>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="DESCRIPTION"
->DESCRIPTION</a></h1>
+>DESCRIPTION</a></h2>
-<p>Apache Lucy's indexes are made up of individual "segments",
each of which is is an independent inverted index. On the file system, each
segment is a directory within the main index directory whose name starts with
"seg_": "seg_2", "seg_5a", etc.</p>
+<p>Apache Lucy’s indexes are made up of individual
“segments”, each of which is is an independent inverted index. On
the file system, each segment is a directory within the main index directory
whose name starts with “seg_”: “seg_2”,
“seg_5a”, etc.</p>
-<p>Each Segment object keeps track of information about an index segment: its
fields, document count, and so on. The Segment object itself writes one file,
<code>segmeta.json</code>; besides storing info needed by Segment itself, the
"segmeta" file serves as a central repository for metadata generated by
other index components -- relieving them of the burden of storing metadata
themselves.</p>
+<p>Each Segment object keeps track of information about an index segment: its
fields, document count, and so on. The Segment object itself writes one file,
<code>segmeta.json</code>; besides storing info needed by Segment itself, the
“segmeta” file serves as a central repository for metadata
generated by other index components – relieving them of the burden of
storing metadata themselves.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="METHODS"
->METHODS</a></h1>
+>METHODS</a></h2>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="add_field(field)"
->add_field(field)</a></h2>
+<h3><a class='u'
+name="add_field"
+>add_field</a></h3>
+
+<pre> my $retval = $segment->add_field($field);</pre>
<p>Register a new field and assign it a field number. If the field was already
known, nothing happens.</p>
@@ -133,13 +135,18 @@ name="add_field(field)"
<li><b>field</b> - Field name.</li>
</ul>
-<p>Returns: the field's field number, which is a positive integer.</p>
+<p>Returns: the field’s field number, which is a positive integer.</p>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="store_metadata(_[labeled_params]_)"
->store_metadata( <i>[labeled params]</i> )</a></h2>
+<h3><a class='u'
+name="store_metadata"
+>store_metadata</a></h3>
+
+<pre> $segment->store_metadata(
+ key => $key # required
+ metadata => $metadata # required
+ );</pre>
-<p>Store arbitrary information in the segment's metadata Hash, to be
serialized later. Throws an error if <code>key</code> is used twice.</p>
+<p>Store arbitrary information in the segment’s metadata Hash, to be
serialized later. Throws an error if <code>key</code> is used twice.</p>
<ul>
<li><b>key</b> - String identifying an index component.</li>
@@ -147,55 +154,77 @@ name="store_metadata(_[labeled_params]_)
<li><b>metadata</b> - JSON-izable data structure.</li>
</ul>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="fetch_metadata(key)"
->fetch_metadata(key)</a></h2>
+<h3><a class='u'
+name="fetch_metadata"
+>fetch_metadata</a></h3>
+
+<pre> my $retval = $segment->fetch_metadata($key);</pre>
+
+<p>Fetch a value from the Segment’s metadata hash.</p>
-<p>Fetch a value from the Segment's metadata hash.</p>
+<h3><a class='u'
+name="field_num"
+>field_num</a></h3>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="field_num(field)"
->field_num(field)</a></h2>
+<pre> my $retval = $segment->field_num($field);</pre>
-<p>Given a field name, return its field number for this segment (which may
differ from its number in other segments). Return 0 (an invalid field number)
if the field name can't be found.</p>
+<p>Given a field name, return its field number for this segment (which may
differ from its number in other segments). Return 0 (an invalid field number)
if the field name can’t be found.</p>
<ul>
<li><b>field</b> - Field name.</li>
</ul>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="field_name(field_num)"
->field_name(field_num)</a></h2>
+<h3><a class='u'
+name="field_name"
+>field_name</a></h3>
+
+<pre> my $retval = $segment->field_name($field_num);</pre>
+
+<p>Given a field number, return the name of its field, or undef if the field
name can’t be found.</p>
+
+<h3><a class='u'
+name="get_name"
+>get_name</a></h3>
-<p>Given a field number, return the name of its field, or undef if the field
name can't be found.</p>
+<pre> my $retval = $segment->get_name();</pre>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="get_name()"
->get_name()</a></h2>
+<p>Getter for the object’s seg name.</p>
-<p>Getter for the object's seg name.</p>
+<h3><a class='u'
+name="get_number"
+>get_number</a></h3>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="get_number()"
->get_number()</a></h2>
+<pre> my $retval = $segment->get_number();</pre>
<p>Getter for the segment number.</p>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="set_count(count)"
->set_count(count)</a></h2>
+<h3><a class='u'
+name="set_count"
+>set_count</a></h3>
+
+<pre> $segment->set_count($count);</pre>
+
+<p>Setter for the object’s document count.</p>
+
+<h3><a class='u'
+name="get_count"
+>get_count</a></h3>
+
+<pre> my $retval = $segment->get_count();</pre>
+
+<p>Getter for the object’s document count.</p>
-<p>Setter for the object's document count.</p>
+<h3><a class='u'
+name="compare_to"
+>compare_to</a></h3>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="get_count()"
->get_count()</a></h2>
+<pre> my $retval = $segment->compare_to($other);</pre>
-<p>Getter for the object's document count.</p>
+<p>Compare by segment number.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="INHERITANCE"
->INHERITANCE</a></h1>
+>INHERITANCE</a></h2>
<p>Lucy::Index::Segment isa Clownfish::Obj.</p>
Modified:
websites/staging/lucy/trunk/content/docs/test/Lucy/Index/Similarity.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/test/Lucy/Index/Similarity.html
(original)
+++ websites/staging/lucy/trunk/content/docs/test/Lucy/Index/Similarity.html
Fri Feb 26 12:52:42 2016
@@ -71,15 +71,15 @@
<div>
<a name='___top' class='dummyTopAnchor' ></a>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="NAME"
->NAME</a></h1>
+>NAME</a></h2>
<p>Lucy::Index::Similarity - Judge how well a document matches a query.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="SYNOPSIS"
->SYNOPSIS</a></h1>
+>SYNOPSIS</a></h2>
<pre> package MySimilarity;
@@ -90,47 +90,49 @@ name="SYNOPSIS"
sub make_similarity { MySimilarity->new }</pre>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="DESCRIPTION"
->DESCRIPTION</a></h1>
+>DESCRIPTION</a></h2>
-<p>After determining whether a document matches a given query, a score must be
calculated which indicates how <i>well</i> the document matches the query. The
Similarity class is used to judge how "similar" the query and the
document are to each other; the closer the resemblance, they higher the
document scores.</p>
+<p>After determining whether a document matches a given query, a score must be
calculated which indicates how <i>well</i> the document matches the query. The
Similarity class is used to judge how “similar” the query and the
document are to each other; the closer the resemblance, they higher the
document scores.</p>
-<p>The default implementation uses Lucene's modified cosine similarity
measure. Subclasses might tweak the existing algorithms, or might be used in
conjunction with custom Query subclasses to implement arbitrary scoring
schemes.</p>
+<p>The default implementation uses Lucene’s modified cosine similarity
measure. Subclasses might tweak the existing algorithms, or might be used in
conjunction with custom Query subclasses to implement arbitrary scoring
schemes.</p>
<p>Most of the methods operate on single fields, but some are used to combine
scores from multiple fields.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="CONSTRUCTORS"
->CONSTRUCTORS</a></h1>
+>CONSTRUCTORS</a></h2>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="new()"
->new()</a></h2>
+<h3><a class='u'
+name="new"
+>new</a></h3>
<pre> my $sim = Lucy::Index::Similarity->new;</pre>
<p>Constructor. Takes no arguments.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="METHODS"
->METHODS</a></h1>
+>METHODS</a></h2>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="length_norm(num_tokens)"
->length_norm(num_tokens)</a></h2>
+<h3><a class='u'
+name="length_norm"
+>length_norm</a></h3>
+
+<pre> my $retval = $similarity->length_norm($num_tokens);</pre>
<p>Dampen the scores of long documents.</p>
<p>After a field is broken up into terms at index-time, each term must be
assigned a weight. One of the factors in calculating this weight is the number
of tokens that the original field was broken into.</p>
-<p>Typically, we assume that the more tokens in a field, the less important
any one of them is -- so that, e.g. 5 mentions of "Kafka" in a short
article are given more heft than 5 mentions of "Kafka" in an entire
book. The default implementation of length_norm expresses this using an
inverted square root.</p>
+<p>Typically, we assume that the more tokens in a field, the less important
any one of them is – so that, e.g. 5 mentions of “Kafka” in a
short article are given more heft than 5 mentions of “Kafka” in an
entire book. The default implementation of length_norm expresses this using an
inverted square root.</p>
-<p>However, the inverted square root has a tendency to reward very short
fields highly, which isn't always appropriate for fields you expect to have
a lot of tokens on average.</p>
+<p>However, the inverted square root has a tendency to reward very short
fields highly, which isn’t always appropriate for fields you expect to
have a lot of tokens on average.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="INHERITANCE"
->INHERITANCE</a></h1>
+>INHERITANCE</a></h2>
<p>Lucy::Index::Similarity isa Clownfish::Obj.</p>
Modified: websites/staging/lucy/trunk/content/docs/test/Lucy/Index/Snapshot.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/test/Lucy/Index/Snapshot.html
(original)
+++ websites/staging/lucy/trunk/content/docs/test/Lucy/Index/Snapshot.html Fri
Feb 26 12:52:42 2016
@@ -71,75 +71,88 @@
<div>
<a name='___top' class='dummyTopAnchor' ></a>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="NAME"
->NAME</a></h1>
+>NAME</a></h2>
<p>Lucy::Index::Snapshot - Point-in-time index file list.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="SYNOPSIS"
->SYNOPSIS</a></h1>
+>SYNOPSIS</a></h2>
<pre> my $snapshot = Lucy::Index::Snapshot->new;
$snapshot->read_file( folder => $folder ); # load most recent
snapshot
my $files = $snapshot->list;
print "$_\n" for @$files;</pre>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="DESCRIPTION"
->DESCRIPTION</a></h1>
+>DESCRIPTION</a></h2>
<p>A Snapshot is list of index files and folders. Because index files, once
written, are never modified, a Snapshot defines a point-in-time view of the
data in an index.</p>
<p><a href="../../Lucy/Index/IndexReader.html" class="podlinkpod"
>IndexReader</a> objects interpret the data associated with a single
>Snapshot.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="CONSTRUCTORS"
->CONSTRUCTORS</a></h1>
+>CONSTRUCTORS</a></h2>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="new()"
->new()</a></h2>
+<h3><a class='u'
+name="new"
+>new</a></h3>
<pre> my $snapshot = Lucy::Index::Snapshot->new;</pre>
<p>Constructor. Takes no arguments.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="METHODS"
->METHODS</a></h1>
+>METHODS</a></h2>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="list()"
->list()</a></h2>
+<h3><a class='u'
+name="list"
+>list</a></h3>
+
+<pre> my $retval = $snapshot->list();</pre>
<p>Return an array of all entries.</p>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="num_entries()"
->num_entries()</a></h2>
+<h3><a class='u'
+name="num_entries"
+>num_entries</a></h3>
+
+<pre> my $retval = $snapshot->num_entries();</pre>
<p>Return the number of entries (including directories).</p>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="add_entry(entry)"
->add_entry(entry)</a></h2>
+<h3><a class='u'
+name="add_entry"
+>add_entry</a></h3>
+
+<pre> $snapshot->add_entry($entry);</pre>
<p>Add a filepath to the snapshot.</p>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="delete_entry(entry)"
->delete_entry(entry)</a></h2>
+<h3><a class='u'
+name="delete_entry"
+>delete_entry</a></h3>
+
+<pre> my $retval = $snapshot->delete_entry($entry);</pre>
<p>Delete a filepath from the snapshot.</p>
<p>Returns: true if the entry existed and was successfully deleted, false
otherwise.</p>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="read_file(_[labeled_params]_)"
->read_file( <i>[labeled params]</i> )</a></h2>
+<h3><a class='u'
+name="read_file"
+>read_file</a></h3>
+
+<pre> my $retval = $snapshot->read_file(
+ folder => $folder # required
+ path => $path # default: undef
+ );</pre>
<p>Decode a snapshot file and initialize the object to reflect its
contents.</p>
@@ -149,11 +162,16 @@ name="read_file(_[labeled_params]_)"
<li><b>path</b> - The location of the snapshot file. If not supplied, the most
recent snapshot file in the base directory will be chosen.</li>
</ul>
-<p>Returns: the object, allowing an assignment idiom.</p>
+<p>Returns: the Snapshot object itself</p>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="write_file(_[labeled_params]_)"
->write_file( <i>[labeled params]</i> )</a></h2>
+<h3><a class='u'
+name="write_file"
+>write_file</a></h3>
+
+<pre> $snapshot->write_file(
+ folder => $folder # required
+ path => $path # default: undef
+ );</pre>
<p>Write a snapshot file. The caller must lock the index while this operation
takes place, and the operation will fail if the snapshot file already
exists.</p>
@@ -163,21 +181,28 @@ name="write_file(_[labeled_params]_)"
<li><b>path</b> - The path of the file to write. If undef, a file name will be
chosen which supersedes the latest snapshot file in the index folder.</li>
</ul>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="set_path(path)"
->set_path(path)</a></h2>
+<h3><a class='u'
+name="set_path"
+>set_path</a></h3>
-<p>Set the path to the file that the Snapshot object serves as a proxy for.</p>
+<pre> $snapshot->set_path($path);</pre>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="get_path()"
->get_path()</a></h2>
+<p>Set the path to the file that the Snapshot object serves as a proxy for.</p>
-<p>Get the path to the snapshot file. Initially undef; updated by read_file(),
write_file(), and set_path().</p>
+<h3><a class='u'
+name="get_path"
+>get_path</a></h3>
+
+<pre> my $retval = $snapshot->get_path();</pre>
+
+<p>Get the path to the snapshot file. Initially undef; updated by <a
href="#read_file" class="podlinkpod"
+>read_file()</a>, <a href="#write_file" class="podlinkpod"
+>write_file()</a>, and <a href="#set_path" class="podlinkpod"
+>set_path()</a>.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="INHERITANCE"
->INHERITANCE</a></h1>
+>INHERITANCE</a></h2>
<p>Lucy::Index::Snapshot isa Clownfish::Obj.</p>
Modified:
websites/staging/lucy/trunk/content/docs/test/Lucy/Object/BitVector.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/test/Lucy/Object/BitVector.html
(original)
+++ websites/staging/lucy/trunk/content/docs/test/Lucy/Object/BitVector.html
Fri Feb 26 12:52:42 2016
@@ -71,15 +71,15 @@
<div>
<a name='___top' class='dummyTopAnchor' ></a>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="NAME"
->NAME</a></h1>
+>NAME</a></h2>
<p>Lucy::Object::BitVector - An array of bits.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="SYNOPSIS"
->SYNOPSIS</a></h1>
+>SYNOPSIS</a></h2>
<pre> my $bit_vec = Lucy::Object::BitVector->new( capacity => 8 );
my $other = Lucy::Object::BitVector->new( capacity => 8 );
@@ -88,45 +88,51 @@ name="SYNOPSIS"
$bit_vec->or($other);
print "$_\n" for @{ $bit_vec->to_array }; # prints 0
through 7.</pre>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="DESCRIPTION"
->DESCRIPTION</a></h1>
+>DESCRIPTION</a></h2>
<p>BitVector is a growable array of bits. All bits are initially zero.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="CONSTRUCTORS"
->CONSTRUCTORS</a></h1>
+>CONSTRUCTORS</a></h2>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="new(_[labeled_params]_)"
->new( <i>[labeled params]</i> )</a></h2>
+<h3><a class='u'
+name="new"
+>new</a></h3>
<pre> my $bit_vec = Lucy::Object::BitVector->new(
capacity => $doc_max + 1, # default 0,
);</pre>
+<p>Create a new BitVector.</p>
+
<ul>
<li><b>capacity</b> - The number of bits that the initial array should be able
to hold.</li>
</ul>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="METHODS"
->METHODS</a></h1>
+>METHODS</a></h2>
+
+<h3><a class='u'
+name="get"
+>get</a></h3>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="get(tick)"
->get(tick)</a></h2>
+<pre> my $retval = $bit_vector->get($tick);</pre>
-<p>Return true if the bit at <code>tick</code> has been set, false if it
hasn't (regardless of whether it lies within the bounds of the object's
capacity).</p>
+<p>Return true if the bit at <code>tick</code> has been set, false if it
hasn’t (regardless of whether it lies within the bounds of the
object’s capacity).</p>
<ul>
<li><b>tick</b> - The requested bit.</li>
</ul>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="set(tick)"
->set(tick)</a></h2>
+<h3><a class='u'
+name="set"
+>set</a></h3>
+
+<pre> $bit_vector->set($tick);</pre>
<p>Set the bit at <code>tick</code> to 1.</p>
@@ -134,9 +140,19 @@ name="set(tick)"
<li><b>tick</b> - The bit to be set.</li>
</ul>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="clear(tick)"
->clear(tick)</a></h2>
+<h3><a class='u'
+name="next_hit"
+>next_hit</a></h3>
+
+<pre> my $retval = $bit_vector->next_hit($tick);</pre>
+
+<p>Returns the next set bit equal to or greater than <code>tick</code>, or -1
if no such bit exists.</p>
+
+<h3><a class='u'
+name="clear"
+>clear</a></h3>
+
+<pre> $bit_vector->clear($tick);</pre>
<p>Clear the indicated bit. (i.e. set it to 0).</p>
@@ -144,15 +160,31 @@ name="clear(tick)"
<li><b>tick</b> - The bit to be cleared.</li>
</ul>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="clear_all()"
->clear_all()</a></h2>
+<h3><a class='u'
+name="clear_all"
+>clear_all</a></h3>
+
+<pre> $bit_vector->clear_all();</pre>
<p>Clear all bits.</p>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="and(other)"
->and(other)</a></h2>
+<h3><a class='u'
+name="grow"
+>grow</a></h3>
+
+<pre> $bit_vector->grow($capacity);</pre>
+
+<p>If the BitVector does not already have enough room to hold the indicated
number of bits, allocate more memory so that it can.</p>
+
+<ul>
+<li><b>capacity</b> - Least number of bits the BitVector should
accomodate.</li>
+</ul>
+
+<h3><a class='u'
+name="and"
+>and</a></h3>
+
+<pre> $bit_vector->and($other);</pre>
<p>Modify the BitVector so that only bits which remain set are those which 1)
were already set in this BitVector, and 2) were also set in the other
BitVector.</p>
@@ -160,9 +192,11 @@ name="and(other)"
<li><b>other</b> - Another BitVector.</li>
</ul>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="or(other)"
->or(other)</a></h2>
+<h3><a class='u'
+name="or"
+>or</a></h3>
+
+<pre> $bit_vector->or($other);</pre>
<p>Modify the BitVector, setting all bits which are set in the other BitVector
if they were not already set.</p>
@@ -170,29 +204,35 @@ name="or(other)"
<li><b>other</b> - Another BitVector.</li>
</ul>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="and_not(other)"
->and_not(other)</a></h2>
+<h3><a class='u'
+name="xor"
+>xor</a></h3>
-<p>Modify the BitVector, clearing all bits which are set in the other.</p>
+<pre> $bit_vector->xor($other);</pre>
+
+<p>Modify the BitVector, performing an XOR operation against the other.</p>
<ul>
<li><b>other</b> - Another BitVector.</li>
</ul>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="xor(other)"
->xor(other)</a></h2>
+<h3><a class='u'
+name="and_not"
+>and_not</a></h3>
-<p>Modify the BitVector, performing an XOR operation against the other.</p>
+<pre> $bit_vector->and_not($other);</pre>
+
+<p>Modify the BitVector, clearing all bits which are set in the other.</p>
<ul>
<li><b>other</b> - Another BitVector.</li>
</ul>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="flip(tick)"
->flip(tick)</a></h2>
+<h3><a class='u'
+name="flip"
+>flip</a></h3>
+
+<pre> $bit_vector->flip($tick);</pre>
<p>Invert the value of a bit.</p>
@@ -200,9 +240,14 @@ name="flip(tick)"
<li><b>tick</b> - The bit to invert.</li>
</ul>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="flip_block(_[labeled_params]_)"
->flip_block( <i>[labeled params]</i> )</a></h2>
+<h3><a class='u'
+name="flip_block"
+>flip_block</a></h3>
+
+<pre> $bit_vector->flip_block(
+ offset => $offset # required
+ length => $length # required
+ );</pre>
<p>Invert each bit within a contiguous block.</p>
@@ -212,37 +257,33 @@ name="flip_block(_[labeled_params]_)"
<li><b>length</b> - The number of bits to flip.</li>
</ul>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="next_hit(tick)"
->next_hit(tick)</a></h2>
+<h3><a class='u'
+name="count"
+>count</a></h3>
-<p>Returns the next set bit equal to or greater than <code>tick</code>, or -1
if no such bit exists.</p>
+<pre> my $retval = $bit_vector->count();</pre>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="to_array()"
->to_array()</a></h2>
+<p>Return a count of the number of set bits.</p>
-<p>Return an array where each element represents a set bit.</p>
+<h3><a class='u'
+name="to_array"
+>to_array</a></h3>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="grow(capacity)"
->grow(capacity)</a></h2>
+<pre> my $retval = $bit_vector->to_array();</pre>
-<p>If the BitVector does not already have enough room to hold the indicated
number of bits, allocate more memory so that it can.</p>
+<p>Return an array where each element represents a set bit.</p>
-<ul>
-<li><b>capacity</b> - Least number of bits the BitVector should
accomodate.</li>
-</ul>
+<h3><a class='u'
+name="clone"
+>clone</a></h3>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="count()"
->count()</a></h2>
+<pre> my $retval = $bit_vector->clone();</pre>
-<p>Return a count of the number of set bits.</p>
+<p>Return a clone of the object.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="INHERITANCE"
->INHERITANCE</a></h1>
+>INHERITANCE</a></h2>
<p>Lucy::Object::BitVector isa Clownfish::Obj.</p>
Modified: websites/staging/lucy/trunk/content/docs/test/Lucy/Object/Obj.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/test/Lucy/Object/Obj.html
(original)
+++ websites/staging/lucy/trunk/content/docs/test/Lucy/Object/Obj.html Fri Feb
26 12:52:42 2016
@@ -71,15 +71,15 @@
<div>
<a name='___top' class='dummyTopAnchor' ></a>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="NAME"
->NAME</a></h1>
+>NAME</a></h2>
<p>Lucy::Object::Obj - Moved.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="MOVED"
->MOVED</a></h1>
+>MOVED</a></h2>
<p>Lucy::Object::Obj has been moved to Clownfish::Obj.</p>
Modified:
websites/staging/lucy/trunk/content/docs/test/Lucy/Plan/Architecture.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/test/Lucy/Plan/Architecture.html
(original)
+++ websites/staging/lucy/trunk/content/docs/test/Lucy/Plan/Architecture.html
Fri Feb 26 12:52:42 2016
@@ -71,15 +71,15 @@
<div>
<a name='___top' class='dummyTopAnchor' ></a>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="NAME"
->NAME</a></h1>
+>NAME</a></h2>
<p>Lucy::Plan::Architecture - Configure major components of an index.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="SYNOPSIS"
->SYNOPSIS</a></h1>
+>SYNOPSIS</a></h2>
<pre> package MyArchitecture;
use base qw( Lucy::Plan::Architecture );
@@ -124,53 +124,58 @@ name="SYNOPSIS"
return MyArchitecture->new(@_);
}</pre>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="DESCRIPTION"
->DESCRIPTION</a></h1>
+>DESCRIPTION</a></h2>
-<p>By default, a Lucy index consists of several main parts: lexicon, postings,
stored documents, deletions, and highlight data. The readers and writers for
that data are spawned by Architecture. Each component operates at the segment
level; Architecture's factory methods are used to build up <a
href="../../Lucy/Index/SegWriter.html" class="podlinkpod"
+<p>By default, a Lucy index consists of several main parts: lexicon, postings,
stored documents, deletions, and highlight data. The readers and writers for
that data are spawned by Architecture. Each component operates at the segment
level; Architecture’s factory methods are used to build up <a
href="../../Lucy/Index/SegWriter.html" class="podlinkpod"
>SegWriter</a> and <a href="../../Lucy/Index/SegReader.html" class="podlinkpod"
>SegReader</a>.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="CONSTRUCTORS"
->CONSTRUCTORS</a></h1>
+>CONSTRUCTORS</a></h2>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="new()"
->new()</a></h2>
+<h3><a class='u'
+name="new"
+>new</a></h3>
<pre> my $arch = Lucy::Plan::Architecture->new;</pre>
<p>Constructor. Takes no arguments.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="METHODS"
->METHODS</a></h1>
+>METHODS</a></h2>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="register_doc_writer(writer)"
->register_doc_writer(writer)</a></h2>
+<h3><a class='u'
+name="register_doc_writer"
+>register_doc_writer</a></h3>
-<p>Spawn a DataWriter and register() it with the supplied SegWriter, adding it
to the SegWriter's writer stack.</p>
+<pre> $architecture->register_doc_writer($writer);</pre>
+
+<p>Spawn a DataWriter and <a href="../../Lucy/Index/SegWriter.html#register"
class="podlinkpod"
+>register()</a> it with the supplied SegWriter, adding it to the
SegWriter’s writer stack.</p>
<ul>
<li><b>writer</b> - A SegWriter.</li>
</ul>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="register_doc_reader(reader)"
->register_doc_reader(reader)</a></h2>
+<h3><a class='u'
+name="register_doc_reader"
+>register_doc_reader</a></h3>
+
+<pre> $architecture->register_doc_reader($reader);</pre>
-<p>Spawn a DocReader and register() it with the supplied SegReader.</p>
+<p>Spawn a DocReader and register it with the supplied SegReader.</p>
<ul>
<li><b>reader</b> - A SegReader.</li>
</ul>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="INHERITANCE"
->INHERITANCE</a></h1>
+>INHERITANCE</a></h2>
<p>Lucy::Plan::Architecture isa Clownfish::Obj.</p>
Modified: websites/staging/lucy/trunk/content/docs/test/Lucy/Plan/BlobType.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/test/Lucy/Plan/BlobType.html
(original)
+++ websites/staging/lucy/trunk/content/docs/test/Lucy/Plan/BlobType.html Fri
Feb 26 12:52:42 2016
@@ -71,15 +71,15 @@
<div>
<a name='___top' class='dummyTopAnchor' ></a>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="NAME"
->NAME</a></h1>
+>NAME</a></h2>
<p>Lucy::Plan::BlobType - Default behaviors for binary fields.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="SYNOPSIS"
->SYNOPSIS</a></h1>
+>SYNOPSIS</a></h2>
<pre> my $string_type = Lucy::Plan::StringType->new;
my $blob_type = Lucy::Plan::BlobType->new( stored => 1 );
@@ -87,31 +87,33 @@ name="SYNOPSIS"
$schema->spec_field( name => 'id', type =>
$string_type );
$schema->spec_field( name => 'jpeg', type =>
$blob_type );</pre>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="DESCRIPTION"
->DESCRIPTION</a></h1>
+>DESCRIPTION</a></h2>
-<p>BlobType is an implementation of FieldType tuned for use with fields
containing binary data, which cannot be indexed or searched -- only stored.</p>
+<p>BlobType is an implementation of FieldType tuned for use with fields
containing binary data, which cannot be indexed or searched – only
stored.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="CONSTRUCTORS"
->CONSTRUCTORS</a></h1>
+>CONSTRUCTORS</a></h2>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="new(_[labeled_params]_)"
->new( <i>[labeled params]</i> )</a></h2>
+<h3><a class='u'
+name="new"
+>new</a></h3>
<pre> my $blob_type = Lucy::Plan::BlobType->new(
stored => 1, # default: false
);</pre>
+<p>Create a new BlobType.</p>
+
<ul>
<li><b>stored</b> - boolean indicating whether the field should be stored.</li>
</ul>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="INHERITANCE"
->INHERITANCE</a></h1>
+>INHERITANCE</a></h2>
<p>Lucy::Plan::BlobType isa <a href="../../Lucy/Plan/FieldType.html"
class="podlinkpod"
>Lucy::Plan::FieldType</a> isa Clownfish::Obj.</p>
Modified: websites/staging/lucy/trunk/content/docs/test/Lucy/Plan/FieldType.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/test/Lucy/Plan/FieldType.html
(original)
+++ websites/staging/lucy/trunk/content/docs/test/Lucy/Plan/FieldType.html Fri
Feb 26 12:52:42 2016
@@ -71,15 +71,15 @@
<div>
<a name='___top' class='dummyTopAnchor' ></a>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="NAME"
->NAME</a></h1>
+>NAME</a></h2>
-<p>Lucy::Plan::FieldType - Define a field's behavior.</p>
+<p>Lucy::Plan::FieldType - Define a field’s behavior.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="SYNOPSIS"
->SYNOPSIS</a></h1>
+>SYNOPSIS</a></h2>
<pre> my @sortable;
for my $field ( @{ $schema->all_fields } ) {
@@ -88,15 +88,15 @@ name="SYNOPSIS"
push @sortable, $field;
}</pre>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="DESCRIPTION"
->DESCRIPTION</a></h1>
+>DESCRIPTION</a></h2>
<p>FieldType is an abstract class defining a set of traits and behaviors which
may be associated with one or more field names.</p>
<p>Properties which are common to all field types include <code>boost</code>,
<code>indexed</code>, <code>stored</code>, <code>sortable</code>,
<code>binary</code>, and <code>similarity</code>.</p>
-<p>The <code>boost</code> property is a floating point scoring multiplier
which defaults to 1.0. Values greater than 1.0 cause the field to contribute
more to a document's score, lower values, less.</p>
+<p>The <code>boost</code> property is a floating point scoring multiplier
which defaults to 1.0. Values greater than 1.0 cause the field to contribute
more to a document’s score, lower values, less.</p>
<p>The <code>indexed</code> property indicates whether the field should be
indexed (so that it can be searched).</p>
@@ -109,43 +109,85 @@ name="DESCRIPTION"
<p>The <code>similarity</code> property is a <a
href="../../Lucy/Index/Similarity.html" class="podlinkpod"
>Similarity</a> object which defines matching and scoring behavior for the
>field. It is required if the field is <code>indexed</code>.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="METHODS"
->METHODS</a></h1>
+>METHODS</a></h2>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="get_boost()"
->get_boost()</a></h2>
+<h3><a class='u'
+name="set_boost"
+>set_boost</a></h3>
+
+<pre> $field_type->set_boost($boost);</pre>
+
+<p>Setter for <code>boost</code>.</p>
+
+<h3><a class='u'
+name="get_boost"
+>get_boost</a></h3>
+
+<pre> my $retval = $field_type->get_boost();</pre>
<p>Accessor for <code>boost</code>.</p>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="indexed()"
->indexed()</a></h2>
+<h3><a class='u'
+name="set_indexed"
+>set_indexed</a></h3>
+
+<pre> $field_type->set_indexed($indexed);</pre>
+
+<p>Setter for <code>indexed</code>.</p>
+
+<h3><a class='u'
+name="indexed"
+>indexed</a></h3>
+
+<pre> my $retval = $field_type->indexed();</pre>
<p>Accessor for <code>indexed</code>.</p>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="stored()"
->stored()</a></h2>
+<h3><a class='u'
+name="set_stored"
+>set_stored</a></h3>
+
+<pre> $field_type->set_stored($stored);</pre>
+
+<p>Setter for <code>stored</code>.</p>
+
+<h3><a class='u'
+name="stored"
+>stored</a></h3>
+
+<pre> my $retval = $field_type->stored();</pre>
<p>Accessor for <code>stored</code>.</p>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="sortable()"
->sortable()</a></h2>
+<h3><a class='u'
+name="set_sortable"
+>set_sortable</a></h3>
+
+<pre> $field_type->set_sortable($sortable);</pre>
+
+<p>Setter for <code>sortable</code>.</p>
+
+<h3><a class='u'
+name="sortable"
+>sortable</a></h3>
+
+<pre> my $retval = $field_type->sortable();</pre>
<p>Accessor for <code>sortable</code>.</p>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="binary()"
->binary()</a></h2>
+<h3><a class='u'
+name="binary"
+>binary</a></h3>
+
+<pre> my $retval = $field_type->binary();</pre>
<p>Indicate whether the field contains binary data.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="INHERITANCE"
->INHERITANCE</a></h1>
+>INHERITANCE</a></h2>
<p>Lucy::Plan::FieldType isa Clownfish::Obj.</p>
Modified:
websites/staging/lucy/trunk/content/docs/test/Lucy/Plan/FullTextType.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/test/Lucy/Plan/FullTextType.html
(original)
+++ websites/staging/lucy/trunk/content/docs/test/Lucy/Plan/FullTextType.html
Fri Feb 26 12:52:42 2016
@@ -71,15 +71,15 @@
<div>
<a name='___top' class='dummyTopAnchor' ></a>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="NAME"
->NAME</a></h1>
+>NAME</a></h2>
<p>Lucy::Plan::FullTextType - Full-text search field type.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="SYNOPSIS"
->SYNOPSIS</a></h1>
+>SYNOPSIS</a></h2>
<pre> my $easyanalyzer = Lucy::Analysis::EasyAnalyzer->new(
language => 'en',
@@ -91,12 +91,12 @@ name="SYNOPSIS"
$schema->spec_field( name => 'title', type => $type
);
$schema->spec_field( name => 'content', type => $type
);</pre>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="DESCRIPTION"
->DESCRIPTION</a></h1>
+>DESCRIPTION</a></h2>
<p>Lucy::Plan::FullTextType is an implementation of <a
href="../../Lucy/Plan/FieldType.html" class="podlinkpod"
->Lucy::Plan::FieldType</a> tuned for "full text search".</p>
+>FieldType</a> tuned for “full text search”.</p>
<p>Full text fields are associated with an <a
href="../../Lucy/Analysis/Analyzer.html" class="podlinkpod"
>Analyzer</a>, which is used to tokenize and normalize the text so that it can
>be searched for individual words.</p>
@@ -104,13 +104,13 @@ name="DESCRIPTION"
<p>For an exact-match, single value field type using character data, see <a
href="../../Lucy/Plan/StringType.html" class="podlinkpod"
>StringType</a>.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="CONSTRUCTORS"
->CONSTRUCTORS</a></h1>
+>CONSTRUCTORS</a></h2>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="new(_[labeled_params]_)"
->new( <i>[labeled params]</i> )</a></h2>
+<h3><a class='u'
+name="new"
+>new</a></h3>
<pre> my $type = Lucy::Plan::FullTextType->new(
analyzer => $analyzer, # required
@@ -135,26 +135,38 @@ name="new(_[labeled_params]_)"
<li><b>highlightable</b> - boolean indicating whether the field should be
highlightable.</li>
</ul>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="METHODS"
->METHODS</a></h1>
+>METHODS</a></h2>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="set_highlightable(highlightable)"
->set_highlightable(highlightable)</a></h2>
+<h3><a class='u'
+name="set_highlightable"
+>set_highlightable</a></h3>
+
+<pre> $full_text_type->set_highlightable($highlightable);</pre>
<p>Indicate whether to store data required by <a
href="../../Lucy/Highlight/Highlighter.html" class="podlinkpod"
->Lucy::Highlight::Highlighter</a> for excerpt selection and search term
highlighting.</p>
+>Highlighter</a> for excerpt selection and search term highlighting.</p>
+
+<h3><a class='u'
+name="highlightable"
+>highlightable</a></h3>
+
+<pre> my $retval = $full_text_type->highlightable();</pre>
+
+<p>Accessor for “highlightable” property.</p>
+
+<h3><a class='u'
+name="get_analyzer"
+>get_analyzer</a></h3>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="highlightable()"
->highlightable()</a></h2>
+<pre> my $retval = $full_text_type->get_analyzer();</pre>
-<p>Accessor for "highlightable" property.</p>
+<p>Accessor for the type’s analyzer.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="INHERITANCE"
->INHERITANCE</a></h1>
+>INHERITANCE</a></h2>
<p>Lucy::Plan::FullTextType isa Lucy::Plan::TextType isa <a
href="../../Lucy/Plan/FieldType.html" class="podlinkpod"
>Lucy::Plan::FieldType</a> isa Clownfish::Obj.</p>
Modified: websites/staging/lucy/trunk/content/docs/test/Lucy/Plan/Schema.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/test/Lucy/Plan/Schema.html
(original)
+++ websites/staging/lucy/trunk/content/docs/test/Lucy/Plan/Schema.html Fri Feb
26 12:52:42 2016
@@ -71,15 +71,15 @@
<div>
<a name='___top' class='dummyTopAnchor' ></a>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="NAME"
->NAME</a></h1>
+>NAME</a></h2>
<p>Lucy::Plan::Schema - User-created specification for an inverted index.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="SYNOPSIS"
->SYNOPSIS</a></h1>
+>SYNOPSIS</a></h2>
<pre> use Lucy::Plan::Schema;
use Lucy::Plan::FullTextType;
@@ -95,37 +95,51 @@ name="SYNOPSIS"
$schema->spec_field( name => 'title', type => $type
);
$schema->spec_field( name => 'content', type => $type
);</pre>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="DESCRIPTION"
->DESCRIPTION</a></h1>
+>DESCRIPTION</a></h2>
<p>A Schema is a specification which indicates how other entities should
interpret the raw data in an inverted index and interact with it.</p>
<p>Once an actual index has been created using a particular Schema, existing
field definitions may not be changed. However, it is possible to add new fields
during subsequent indexing sessions.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="CONSTRUCTORS"
->CONSTRUCTORS</a></h1>
+>CONSTRUCTORS</a></h2>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="new()"
->new()</a></h2>
+<h3><a class='u'
+name="new"
+>new</a></h3>
<pre> my $schema = Lucy::Plan::Schema->new;</pre>
<p>Constructor. Takes no arguments.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="METHODS"
->METHODS</a></h1>
+>METHODS</a></h2>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="spec_field(_[labeled_params]_)"
->spec_field( <i>[labeled params]</i> )</a></h2>
+<h3><a class='u'
+name="architecture"
+>architecture</a></h3>
+
+<pre> my $retval = $schema->architecture();</pre>
+
+<p>Factory method which creates an Architecture object for this index.</p>
+
+<h3><a class='u'
+name="spec_field"
+>spec_field</a></h3>
+
+<pre> $schema->spec_field(
+ name => $name # required
+ type => $type # required
+ );</pre>
<p>Define the behavior of a field by associating it with a FieldType.</p>
-<p>If this method has already been called for the supplied <code>field</code>,
it will merely test to verify that the supplied FieldType equals() the existing
one.</p>
+<p>If this method has already been called for the supplied <code>field</code>,
it will merely test to verify that the supplied FieldType <a
href="../../Clownfish/Obj.html#equals" class="podlinkpod"
+>equals()</a> the existing one.</p>
<ul>
<li><b>name</b> - The name of the field.</li>
@@ -133,51 +147,58 @@ name="spec_field(_[labeled_params]_)"
<li><b>type</b> - A FieldType.</li>
</ul>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="num_fields()"
->num_fields()</a></h2>
+<h3><a class='u'
+name="fetch_type"
+>fetch_type</a></h3>
-<p>Return the number of fields currently defined.</p>
+<pre> my $retval = $schema->fetch_type($field);</pre>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="all_fields()"
->all_fields()</a></h2>
+<p>Return the FieldType for the specified field. If the field can’t be
found, return undef.</p>
-<p>Return all the Schema's field names as an array.</p>
+<h3><a class='u'
+name="fetch_sim"
+>fetch_sim</a></h3>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="fetch_type(field)"
->fetch_type(field)</a></h2>
+<pre> my $retval = $schema->fetch_sim($field);
+ my $retval = $schema->fetch_sim(); # default: undef</pre>
-<p>Return the FieldType for the specified field. If the field can't be
found, return undef.</p>
+<p>Return the Similarity for the specified field, or undef if either the field
can’t be found or it isn’t associated with a Similarity.</p>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="fetch_sim(field)"
->fetch_sim(field)</a></h2>
+<h3><a class='u'
+name="num_fields"
+>num_fields</a></h3>
-<p>Return the Similarity for the specified field, or undef if either the field
can't be found or it isn't associated with a Similarity.</p>
+<pre> my $retval = $schema->num_fields();</pre>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="architecture()"
->architecture()</a></h2>
+<p>Return the number of fields currently defined.</p>
-<p>Factory method which creates an Architecture object for this index.</p>
+<h3><a class='u'
+name="all_fields"
+>all_fields</a></h3>
+
+<pre> my $retval = $schema->all_fields();</pre>
+
+<p>Return all the Schema’s field names as an array.</p>
+
+<h3><a class='u'
+name="get_architecture"
+>get_architecture</a></h3>
+
+<pre> my $retval = $schema->get_architecture();</pre>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="get_architecture()"
->get_architecture()</a></h2>
+<p>Return the Schema instance’s internal Architecture object.</p>
-<p>Return the Schema instance's internal Architecture object.</p>
+<h3><a class='u'
+name="get_similarity"
+>get_similarity</a></h3>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="get_similarity()"
->get_similarity()</a></h2>
+<pre> my $retval = $schema->get_similarity();</pre>
-<p>Return the Schema instance's internal Similarity object.</p>
+<p>Return the Schema instance’s internal Similarity object.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="INHERITANCE"
->INHERITANCE</a></h1>
+>INHERITANCE</a></h2>
<p>Lucy::Plan::Schema isa Clownfish::Obj.</p>
Modified:
websites/staging/lucy/trunk/content/docs/test/Lucy/Plan/StringType.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/test/Lucy/Plan/StringType.html
(original)
+++ websites/staging/lucy/trunk/content/docs/test/Lucy/Plan/StringType.html Fri
Feb 26 12:52:42 2016
@@ -71,33 +71,33 @@
<div>
<a name='___top' class='dummyTopAnchor' ></a>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="NAME"
->NAME</a></h1>
+>NAME</a></h2>
<p>Lucy::Plan::StringType - Non-tokenized text type.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="SYNOPSIS"
->SYNOPSIS</a></h1>
+>SYNOPSIS</a></h2>
<pre> my $type = Lucy::Plan::StringType->new;
my $schema = Lucy::Plan::Schema->new;
$schema->spec_field( name => 'category', type => $type
);</pre>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="DESCRIPTION"
->DESCRIPTION</a></h1>
+>DESCRIPTION</a></h2>
-<p>Lucy::Plan::StringType is used for "exact-match" strings.</p>
+<p>Lucy::Plan::StringType is used for “exact-match” strings.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="CONSTRUCTORS"
->CONSTRUCTORS</a></h1>
+>CONSTRUCTORS</a></h2>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="new()"
->new()</a></h2>
+<h3><a class='u'
+name="new"
+>new</a></h3>
<pre> my $type = Lucy::Plan::StringType->new(
boost => 0.1, # default: 1.0
@@ -116,9 +116,9 @@ name="new()"
<li><b>sortable</b> - boolean indicating whether the field should be
sortable.</li>
</ul>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="INHERITANCE"
->INHERITANCE</a></h1>
+>INHERITANCE</a></h2>
<p>Lucy::Plan::StringType isa Lucy::Plan::TextType isa <a
href="../../Lucy/Plan/FieldType.html" class="podlinkpod"
>Lucy::Plan::FieldType</a> isa Clownfish::Obj.</p>
