| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (1.8.0_121) on Fri Apr 14 22:12:45 PDT 2017 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>LuceneIterator (Mahout Integration 0.13.0 API)</title> |
| <meta name="date" content="2017-04-14"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="LuceneIterator (Mahout Integration 0.13.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/LuceneIterator.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../org/apache/mahout/utils/vectors/lucene/LuceneIterable.html" title="class in org.apache.mahout.utils.vectors.lucene"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/mahout/utils/vectors/lucene/TFDFMapper.html" title="class in org.apache.mahout.utils.vectors.lucene"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/mahout/utils/vectors/lucene/LuceneIterator.html" target="_top">Frames</a></li> |
| <li><a href="LuceneIterator.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.mahout.utils.vectors.lucene</div> |
| <h2 title="Class LuceneIterator" class="title">Class LuceneIterator</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>com.google.common.collect.UnmodifiableIterator<T></li> |
| <li> |
| <ul class="inheritance"> |
| <li>com.google.common.collect.AbstractIterator<<a href="http://mahout.apache.org/mahout-math/apidocs/org/apache/mahout/math/Vector.html?is-external=true" title="class or interface in org.apache.mahout.math">Vector</a>></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../../../org/apache/mahout/utils/vectors/lucene/AbstractLuceneIterator.html" title="class in org.apache.mahout.utils.vectors.lucene">org.apache.mahout.utils.vectors.lucene.AbstractLuceneIterator</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.mahout.utils.vectors.lucene.LuceneIterator</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a><<a href="http://mahout.apache.org/mahout-math/apidocs/org/apache/mahout/math/Vector.html?is-external=true" title="class or interface in org.apache.mahout.math">Vector</a>></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">LuceneIterator</span> |
| extends <a href="../../../../../../org/apache/mahout/utils/vectors/lucene/AbstractLuceneIterator.html" title="class in org.apache.mahout.utils.vectors.lucene">AbstractLuceneIterator</a></pre> |
| <div class="block">An <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util"><code>Iterator</code></a> over <a href="http://mahout.apache.org/mahout-math/apidocs/org/apache/mahout/math/Vector.html?is-external=true" title="class or interface in org.apache.mahout.math"><code>Vector</code></a>s that uses a Lucene index as the source |
| for creating the <a href="http://mahout.apache.org/mahout-math/apidocs/org/apache/mahout/math/Vector.html?is-external=true" title="class or interface in org.apache.mahout.math"><code>Vector</code></a>s. The field used to create the vectors currently must have |
| term vectors stored for it.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/mahout/utils/vectors/lucene/LuceneIterator.html#idField">idField</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/mahout/utils/vectors/lucene/LuceneIterator.html#idFieldSelector">idFieldSelector</a></span></code> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.apache.mahout.utils.vectors.lucene.AbstractLuceneIterator"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.apache.mahout.utils.vectors.lucene.<a href="../../../../../../org/apache/mahout/utils/vectors/lucene/AbstractLuceneIterator.html" title="class in org.apache.mahout.utils.vectors.lucene">AbstractLuceneIterator</a></h3> |
| <code><a href="../../../../../../org/apache/mahout/utils/vectors/lucene/AbstractLuceneIterator.html#bump">bump</a>, <a href="../../../../../../org/apache/mahout/utils/vectors/lucene/AbstractLuceneIterator.html#field">field</a>, <a href="../../../../../../org/apache/mahout/utils/vectors/lucene/AbstractLuceneIterator.html#indexReader">indexReader</a>, <a href="../../../../../../org/apache/mahout/utils/vectors/lucene/AbstractLuceneIterator.html#maxErrorDocs">maxErrorDocs</a>, <a href="../../../../../../org/apache/mahout/utils/vectors/lucene/AbstractLuceneIterator.html#nextDocId">nextDocId</a>, <a href="../../../../../../org/apache/mahout/utils/vectors/lucene/AbstractLuceneIterator.html#nextLogRecord">nextLogRecord</a>, <a href="../../../../../../org/apache/mahout/utils/vectors/lucene/AbstractLuceneIterator.html#normPower">normPower</a>, <a href="../../../../../../org/apache/mahout/utils/vectors/lucene/AbstractLuceneIterator.html#numErrorDocs">numErrorDocs</a>, <a href="../../../../../../org/apache/mahout/utils/vectors/lucene/AbstractLuceneIterator.html#skippedErrorMessages">skippedErrorMessages</a>, <a href="../../../../../../org/apache/mahout/utils/vectors/lucene/AbstractLuceneIterator.html#terminfo">terminfo</a>, <a href="../../../../../../org/apache/mahout/utils/vectors/lucene/AbstractLuceneIterator.html#weight">weight</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/mahout/utils/vectors/lucene/LuceneIterator.html#LuceneIterator-org.apache.lucene.index.IndexReader-java.lang.String-java.lang.String-org.apache.mahout.utils.vectors.TermInfo-org.apache.mahout.vectorizer.Weight-double-">LuceneIterator</a></span>(org.apache.lucene.index.IndexReader indexReader, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> idField, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> field, |
| <a href="../../../../../../org/apache/mahout/utils/vectors/TermInfo.html" title="interface in org.apache.mahout.utils.vectors">TermInfo</a> termInfo, |
| <a href="http://mahout.apache.org/mahout-mr/apidocs/org/apache/mahout/vectorizer/Weight.html?is-external=true" title="class or interface in org.apache.mahout.vectorizer">Weight</a> weight, |
| double normPower)</code> |
| <div class="block">Produce a LuceneIterable that can create the Vector plus normalize it.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/mahout/utils/vectors/lucene/LuceneIterator.html#LuceneIterator-org.apache.lucene.index.IndexReader-java.lang.String-java.lang.String-org.apache.mahout.utils.vectors.TermInfo-org.apache.mahout.vectorizer.Weight-double-double-">LuceneIterator</a></span>(org.apache.lucene.index.IndexReader indexReader, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> idField, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> field, |
| <a href="../../../../../../org/apache/mahout/utils/vectors/TermInfo.html" title="interface in org.apache.mahout.utils.vectors">TermInfo</a> termInfo, |
| <a href="http://mahout.apache.org/mahout-mr/apidocs/org/apache/mahout/vectorizer/Weight.html?is-external=true" title="class or interface in org.apache.mahout.vectorizer">Weight</a> weight, |
| double normPower, |
| double maxPercentErrorDocs)</code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/mahout/utils/vectors/lucene/LuceneIterator.html#getVectorName-int-">getVectorName</a></span>(int documentIndex)</code> |
| <div class="block">Given the document name, derive a name for the vector.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.mahout.utils.vectors.lucene.AbstractLuceneIterator"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.mahout.utils.vectors.lucene.<a href="../../../../../../org/apache/mahout/utils/vectors/lucene/AbstractLuceneIterator.html" title="class in org.apache.mahout.utils.vectors.lucene">AbstractLuceneIterator</a></h3> |
| <code><a href="../../../../../../org/apache/mahout/utils/vectors/lucene/AbstractLuceneIterator.html#computeNext--">computeNext</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.com.google.common.collect.AbstractIterator"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class com.google.common.collect.AbstractIterator</h3> |
| <code>endOfData, hasNext, next, peek</code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.com.google.common.collect.UnmodifiableIterator"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class com.google.common.collect.UnmodifiableIterator</h3> |
| <code>remove</code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.util.Iterator"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface java.util.<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a></h3> |
| <code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Iterator.html?is-external=true#forEachRemaining-java.util.function.Consumer-" title="class or interface in java.util">forEachRemaining</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="idFieldSelector"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>idFieldSelector</h4> |
| <pre>protected final <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> idFieldSelector</pre> |
| </li> |
| </ul> |
| <a name="idField"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>idField</h4> |
| <pre>protected final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> idField</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="LuceneIterator-org.apache.lucene.index.IndexReader-java.lang.String-java.lang.String-org.apache.mahout.utils.vectors.TermInfo-org.apache.mahout.vectorizer.Weight-double-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>LuceneIterator</h4> |
| <pre>public LuceneIterator(org.apache.lucene.index.IndexReader indexReader, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> idField, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> field, |
| <a href="../../../../../../org/apache/mahout/utils/vectors/TermInfo.html" title="interface in org.apache.mahout.utils.vectors">TermInfo</a> termInfo, |
| <a href="http://mahout.apache.org/mahout-mr/apidocs/org/apache/mahout/vectorizer/Weight.html?is-external=true" title="class or interface in org.apache.mahout.vectorizer">Weight</a> weight, |
| double normPower)</pre> |
| <div class="block">Produce a LuceneIterable that can create the Vector plus normalize it.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>indexReader</code> - <code>IndexReader</code> to read the documents from.</dd> |
| <dd><code>idField</code> - field containing the id. May be null.</dd> |
| <dd><code>field</code> - field to use for the Vector</dd> |
| <dd><code>termInfo</code> - termInfo</dd> |
| <dd><code>weight</code> - weight</dd> |
| <dd><code>normPower</code> - the normalization value. Must be non-negative, or <a href="../../../../../../org/apache/mahout/utils/vectors/lucene/LuceneIterable.html#NO_NORMALIZING"><code>LuceneIterable.NO_NORMALIZING</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="LuceneIterator-org.apache.lucene.index.IndexReader-java.lang.String-java.lang.String-org.apache.mahout.utils.vectors.TermInfo-org.apache.mahout.vectorizer.Weight-double-double-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>LuceneIterator</h4> |
| <pre>public LuceneIterator(org.apache.lucene.index.IndexReader indexReader, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> idField, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> field, |
| <a href="../../../../../../org/apache/mahout/utils/vectors/TermInfo.html" title="interface in org.apache.mahout.utils.vectors">TermInfo</a> termInfo, |
| <a href="http://mahout.apache.org/mahout-mr/apidocs/org/apache/mahout/vectorizer/Weight.html?is-external=true" title="class or interface in org.apache.mahout.vectorizer">Weight</a> weight, |
| double normPower, |
| double maxPercentErrorDocs)</pre> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>indexReader</code> - <code>IndexReader</code> to read the documents from.</dd> |
| <dd><code>idField</code> - field containing the id. May be null.</dd> |
| <dd><code>field</code> - field to use for the Vector</dd> |
| <dd><code>termInfo</code> - termInfo</dd> |
| <dd><code>weight</code> - weight</dd> |
| <dd><code>normPower</code> - the normalization value. Must be non-negative, or <a href="../../../../../../org/apache/mahout/utils/vectors/lucene/LuceneIterable.html#NO_NORMALIZING"><code>LuceneIterable.NO_NORMALIZING</code></a></dd> |
| <dd><code>maxPercentErrorDocs</code> - most documents that will be tolerated without a term freq vector. In [0,1].</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../org/apache/mahout/utils/vectors/lucene/LuceneIterator.html#LuceneIterator-org.apache.lucene.index.IndexReader-java.lang.String-java.lang.String-org.apache.mahout.utils.vectors.TermInfo-org.apache.mahout.vectorizer.Weight-double-"><code>LuceneIterator(org.apache.lucene.index.IndexReader, String, String, org.apache.mahout.utils.vectors.TermInfo, |
| org.apache.mahout.vectorizer.Weight, double)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getVectorName-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getVectorName</h4> |
| <pre>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getVectorName(int documentIndex) |
| throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../../org/apache/mahout/utils/vectors/lucene/AbstractLuceneIterator.html#getVectorName-int-">AbstractLuceneIterator</a></code></span></div> |
| <div class="block">Given the document name, derive a name for the vector. This may involve |
| reading the document from Lucene and setting up any other state that the |
| subclass wants. This will be called once for each document that the |
| iterator processes.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/mahout/utils/vectors/lucene/AbstractLuceneIterator.html#getVectorName-int-">getVectorName</a></code> in class <code><a href="../../../../../../org/apache/mahout/utils/vectors/lucene/AbstractLuceneIterator.html" title="class in org.apache.mahout.utils.vectors.lucene">AbstractLuceneIterator</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>documentIndex</code> - the lucene document index.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the name to store in the vector.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/LuceneIterator.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../org/apache/mahout/utils/vectors/lucene/LuceneIterable.html" title="class in org.apache.mahout.utils.vectors.lucene"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/mahout/utils/vectors/lucene/TFDFMapper.html" title="class in org.apache.mahout.utils.vectors.lucene"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/mahout/utils/vectors/lucene/LuceneIterator.html" target="_top">Frames</a></li> |
| <li><a href="LuceneIterator.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2008–2017 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
