You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucene.apache.org by rm...@apache.org on 2012/09/21 04:01:28 UTC
svn commit: r1388299 - in /lucene/dev/branches/branch_4x: ./ lucene/
lucene/suggest/ lucene/suggest/src/java/org/apache/lucene/search/spell/
lucene/suggest/src/java/org/apache/lucene/search/suggest/
lucene/suggest/src/java/org/apache/lucene/search/sugg...
Author: rmuir
Date: Fri Sep 21 02:01:27 2012
New Revision: 1388299
URL: http://svn.apache.org/viewvc?rev=1388299&view=rev
Log:
javadocs
Modified:
lucene/dev/branches/branch_4x/ (props changed)
lucene/dev/branches/branch_4x/lucene/ (props changed)
lucene/dev/branches/branch_4x/lucene/suggest/ (props changed)
lucene/dev/branches/branch_4x/lucene/suggest/src/java/org/apache/lucene/search/spell/DirectSpellChecker.java
lucene/dev/branches/branch_4x/lucene/suggest/src/java/org/apache/lucene/search/spell/SpellChecker.java
lucene/dev/branches/branch_4x/lucene/suggest/src/java/org/apache/lucene/search/spell/TermFreqIterator.java
lucene/dev/branches/branch_4x/lucene/suggest/src/java/org/apache/lucene/search/suggest/Lookup.java
lucene/dev/branches/branch_4x/lucene/suggest/src/java/org/apache/lucene/search/suggest/fst/BytesRefSorter.java
lucene/dev/branches/branch_4x/lucene/suggest/src/java/org/apache/lucene/search/suggest/fst/FSTCompletion.java
lucene/dev/branches/branch_4x/lucene/suggest/src/java/org/apache/lucene/search/suggest/fst/FSTCompletionBuilder.java
lucene/dev/branches/branch_4x/lucene/suggest/src/java/org/apache/lucene/search/suggest/fst/FSTCompletionLookup.java
lucene/dev/branches/branch_4x/lucene/suggest/src/java/org/apache/lucene/search/suggest/fst/InMemorySorter.java
lucene/dev/branches/branch_4x/lucene/suggest/src/java/org/apache/lucene/search/suggest/fst/Sort.java
lucene/dev/branches/branch_4x/lucene/suggest/src/java/org/apache/lucene/search/suggest/fst/WFSTCompletionLookup.java
Modified: lucene/dev/branches/branch_4x/lucene/suggest/src/java/org/apache/lucene/search/spell/DirectSpellChecker.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_4x/lucene/suggest/src/java/org/apache/lucene/search/spell/DirectSpellChecker.java?rev=1388299&r1=1388298&r2=1388299&view=diff
==============================================================================
--- lucene/dev/branches/branch_4x/lucene/suggest/src/java/org/apache/lucene/search/spell/DirectSpellChecker.java (original)
+++ lucene/dev/branches/branch_4x/lucene/suggest/src/java/org/apache/lucene/search/spell/DirectSpellChecker.java Fri Sep 21 02:01:27 2012
@@ -88,6 +88,9 @@ public class DirectSpellChecker {
/** the string distance to use */
private StringDistance distance = INTERNAL_LEVENSHTEIN;
+ /** Creates a DirectSpellChecker with default configuration values */
+ public DirectSpellChecker() {}
+
/** Get the maximum number of Levenshtein edit-distances to draw
* candidate terms from. */
public int getMaxEdits() {
Modified: lucene/dev/branches/branch_4x/lucene/suggest/src/java/org/apache/lucene/search/spell/SpellChecker.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_4x/lucene/suggest/src/java/org/apache/lucene/search/spell/SpellChecker.java?rev=1388299&r1=1388298&r2=1388299&view=diff
==============================================================================
--- lucene/dev/branches/branch_4x/lucene/suggest/src/java/org/apache/lucene/search/spell/SpellChecker.java (original)
+++ lucene/dev/branches/branch_4x/lucene/suggest/src/java/org/apache/lucene/search/spell/SpellChecker.java Fri Sep 21 02:01:27 2012
@@ -187,6 +187,10 @@ public class SpellChecker implements jav
this.comparator = comparator;
}
+ /**
+ * Gets the comparator in use for ranking suggestions.
+ * @see #setComparator(Comparator)
+ */
public Comparator<SuggestWord> getComparator() {
return comparator;
}
Modified: lucene/dev/branches/branch_4x/lucene/suggest/src/java/org/apache/lucene/search/spell/TermFreqIterator.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_4x/lucene/suggest/src/java/org/apache/lucene/search/spell/TermFreqIterator.java?rev=1388299&r1=1388298&r2=1388299&view=diff
==============================================================================
--- lucene/dev/branches/branch_4x/lucene/suggest/src/java/org/apache/lucene/search/spell/TermFreqIterator.java (original)
+++ lucene/dev/branches/branch_4x/lucene/suggest/src/java/org/apache/lucene/search/spell/TermFreqIterator.java Fri Sep 21 02:01:27 2012
@@ -28,6 +28,7 @@ import org.apache.lucene.util.BytesRefIt
*/
public interface TermFreqIterator extends BytesRefIterator {
+ /** A term's weight, higher numbers mean better suggestions. */
public long weight();
/**
Modified: lucene/dev/branches/branch_4x/lucene/suggest/src/java/org/apache/lucene/search/suggest/Lookup.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_4x/lucene/suggest/src/java/org/apache/lucene/search/suggest/Lookup.java?rev=1388299&r1=1388298&r2=1388299&view=diff
==============================================================================
--- lucene/dev/branches/branch_4x/lucene/suggest/src/java/org/apache/lucene/search/suggest/Lookup.java (original)
+++ lucene/dev/branches/branch_4x/lucene/suggest/src/java/org/apache/lucene/search/suggest/Lookup.java Fri Sep 21 02:01:27 2012
@@ -109,6 +109,12 @@ public abstract class Lookup {
}
}
+ /**
+ * Sole constructor. (For invocation by subclass
+ * constructors, typically implicit.)
+ */
+ public Lookup() {}
+
/** Build lookup from a dictionary. Some implementations may require sorted
* or unsorted keys from the dictionary's iterator - use
* {@link SortedTermFreqIteratorWrapper} or
Modified: lucene/dev/branches/branch_4x/lucene/suggest/src/java/org/apache/lucene/search/suggest/fst/BytesRefSorter.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_4x/lucene/suggest/src/java/org/apache/lucene/search/suggest/fst/BytesRefSorter.java?rev=1388299&r1=1388298&r2=1388299&view=diff
==============================================================================
--- lucene/dev/branches/branch_4x/lucene/suggest/src/java/org/apache/lucene/search/suggest/fst/BytesRefSorter.java (original)
+++ lucene/dev/branches/branch_4x/lucene/suggest/src/java/org/apache/lucene/search/suggest/fst/BytesRefSorter.java Fri Sep 21 02:01:27 2012
@@ -47,5 +47,8 @@ public interface BytesRefSorter {
*/
BytesRefIterator iterator() throws IOException;
+ /**
+ * Comparator used to determine the sort order of entries.
+ */
Comparator<BytesRef> getComparator();
}
Modified: lucene/dev/branches/branch_4x/lucene/suggest/src/java/org/apache/lucene/search/suggest/fst/FSTCompletion.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_4x/lucene/suggest/src/java/org/apache/lucene/search/suggest/fst/FSTCompletion.java?rev=1388299&r1=1388298&r2=1388299&view=diff
==============================================================================
--- lucene/dev/branches/branch_4x/lucene/suggest/src/java/org/apache/lucene/search/suggest/fst/FSTCompletion.java (original)
+++ lucene/dev/branches/branch_4x/lucene/suggest/src/java/org/apache/lucene/search/suggest/fst/FSTCompletion.java Fri Sep 21 02:01:27 2012
@@ -42,7 +42,9 @@ public class FSTCompletion {
* A single completion for a given key.
*/
public static final class Completion implements Comparable<Completion> {
+ /** UTF-8 bytes of the suggestion */
public final BytesRef utf8;
+ /** source bucket (weight) of the suggestion */
public final int bucket;
Completion(BytesRef key, int bucket) {
@@ -95,6 +97,7 @@ public class FSTCompletion {
private boolean higherWeightsFirst;
/**
+ * Constructs an FSTCompletion, specifying higherWeightsFirst and exactFirst.
* @param automaton
* Automaton with completions. See {@link FSTCompletionBuilder}.
* @param higherWeightsFirst
Modified: lucene/dev/branches/branch_4x/lucene/suggest/src/java/org/apache/lucene/search/suggest/fst/FSTCompletionBuilder.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_4x/lucene/suggest/src/java/org/apache/lucene/search/suggest/fst/FSTCompletionBuilder.java?rev=1388299&r1=1388298&r2=1388299&view=diff
==============================================================================
--- lucene/dev/branches/branch_4x/lucene/suggest/src/java/org/apache/lucene/search/suggest/fst/FSTCompletionBuilder.java (original)
+++ lucene/dev/branches/branch_4x/lucene/suggest/src/java/org/apache/lucene/search/suggest/fst/FSTCompletionBuilder.java Fri Sep 21 02:01:27 2012
@@ -152,6 +152,7 @@ public class FSTCompletionBuilder {
}
/**
+ * Creates an FSTCompletion with the specified options.
* @param buckets
* The number of buckets for weight discretization. Buckets are used
* in {@link #add(BytesRef, int)} and must be smaller than the number
Modified: lucene/dev/branches/branch_4x/lucene/suggest/src/java/org/apache/lucene/search/suggest/fst/FSTCompletionLookup.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_4x/lucene/suggest/src/java/org/apache/lucene/search/suggest/fst/FSTCompletionLookup.java?rev=1388299&r1=1388298&r2=1388299&view=diff
==============================================================================
--- lucene/dev/branches/branch_4x/lucene/suggest/src/java/org/apache/lucene/search/suggest/fst/FSTCompletionLookup.java (original)
+++ lucene/dev/branches/branch_4x/lucene/suggest/src/java/org/apache/lucene/search/suggest/fst/FSTCompletionLookup.java Fri Sep 21 02:01:27 2012
@@ -249,6 +249,10 @@ public class FSTCompletionLookup extends
return results;
}
+ /**
+ * Returns the bucket (weight) as a Long for the provided key if it exists,
+ * otherwise null if it does not.
+ */
public Object get(CharSequence key) {
final int bucket = normalCompletion.getBucket(key);
return bucket == -1 ? null : Long.valueOf(bucket);
Modified: lucene/dev/branches/branch_4x/lucene/suggest/src/java/org/apache/lucene/search/suggest/fst/InMemorySorter.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_4x/lucene/suggest/src/java/org/apache/lucene/search/suggest/fst/InMemorySorter.java?rev=1388299&r1=1388298&r2=1388299&view=diff
==============================================================================
--- lucene/dev/branches/branch_4x/lucene/suggest/src/java/org/apache/lucene/search/suggest/fst/InMemorySorter.java (original)
+++ lucene/dev/branches/branch_4x/lucene/suggest/src/java/org/apache/lucene/search/suggest/fst/InMemorySorter.java Fri Sep 21 02:01:27 2012
@@ -33,6 +33,10 @@ public final class InMemorySorter implem
private boolean closed = false;
private final Comparator<BytesRef> comparator;
+ /**
+ * Creates an InMemorySorter, sorting entries by the
+ * provided comparator.
+ */
public InMemorySorter(Comparator<BytesRef> comparator) {
this.comparator = comparator;
}
Modified: lucene/dev/branches/branch_4x/lucene/suggest/src/java/org/apache/lucene/search/suggest/fst/Sort.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_4x/lucene/suggest/src/java/org/apache/lucene/search/suggest/fst/Sort.java?rev=1388299&r1=1388298&r2=1388299&view=diff
==============================================================================
--- lucene/dev/branches/branch_4x/lucene/suggest/src/java/org/apache/lucene/search/suggest/fst/Sort.java (original)
+++ lucene/dev/branches/branch_4x/lucene/suggest/src/java/org/apache/lucene/search/suggest/fst/Sort.java Fri Sep 21 02:01:27 2012
@@ -37,7 +37,9 @@ import org.apache.lucene.util.PriorityQu
* @lucene.internal
*/
public final class Sort {
+ /** Convenience constant for megabytes */
public final static long MB = 1024 * 1024;
+ /** Convenience constant for gigabytes */
public final static long GB = MB * 1024;
/**
@@ -148,6 +150,7 @@ public final class Sort {
private int maxTempFiles;
private final Comparator<BytesRef> comparator;
+ /** Default comparator: sorts in binary (codepoint) order */
public static final Comparator<BytesRef> DEFAULT_COMPARATOR = BytesRef.getUTF8SortedAsUnicodeComparator();
/**
@@ -160,6 +163,12 @@ public final class Sort {
this(DEFAULT_COMPARATOR, BufferSize.automatic(), defaultTempDir(), MAX_TEMPFILES);
}
+ /**
+ * Defaults constructor with a custom comparator.
+ *
+ * @see #defaultTempDir()
+ * @see BufferSize#automatic()
+ */
public Sort(Comparator<BytesRef> comparator) throws IOException {
this(comparator, BufferSize.automatic(), defaultTempDir(), MAX_TEMPFILES);
}
@@ -401,25 +410,41 @@ public final class Sort {
public static class ByteSequencesWriter implements Closeable {
private final DataOutput os;
+ /** Constructs a ByteSequencesWriter to the provided File */
public ByteSequencesWriter(File file) throws IOException {
this(new DataOutputStream(
new BufferedOutputStream(
new FileOutputStream(file))));
}
+ /** Constructs a ByteSequencesWriter to the provided DataOutput */
public ByteSequencesWriter(DataOutput os) {
this.os = os;
}
+ /**
+ * Writes a BytesRef.
+ * @see #write(byte[], int, int)
+ */
public void write(BytesRef ref) throws IOException {
assert ref != null;
write(ref.bytes, ref.offset, ref.length);
}
+ /**
+ * Writes a byte array.
+ * @see #write(byte[], int, int)
+ */
public void write(byte [] bytes) throws IOException {
write(bytes, 0, bytes.length);
}
+ /**
+ * Writes a byte array.
+ * <p>
+ * The length is written as a <code>short</code>, followed
+ * by the bytes.
+ */
public void write(byte [] bytes, int off, int len) throws IOException {
assert bytes != null;
assert off >= 0 && off + len <= bytes.length;
@@ -446,12 +471,14 @@ public final class Sort {
public static class ByteSequencesReader implements Closeable {
private final DataInput is;
+ /** Constructs a ByteSequencesReader from the provided File */
public ByteSequencesReader(File file) throws IOException {
this(new DataInputStream(
new BufferedInputStream(
new FileInputStream(file))));
}
+ /** Constructs a ByteSequencesReader from the provided DataInput */
public ByteSequencesReader(DataInput is) {
this.is = is;
}
@@ -513,6 +540,7 @@ public final class Sort {
}
}
+ /** Returns the comparator in use to sort entries */
public Comparator<BytesRef> getComparator() {
return comparator;
}
Modified: lucene/dev/branches/branch_4x/lucene/suggest/src/java/org/apache/lucene/search/suggest/fst/WFSTCompletionLookup.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_4x/lucene/suggest/src/java/org/apache/lucene/search/suggest/fst/WFSTCompletionLookup.java?rev=1388299&r1=1388298&r2=1388299&view=diff
==============================================================================
--- lucene/dev/branches/branch_4x/lucene/suggest/src/java/org/apache/lucene/search/suggest/fst/WFSTCompletionLookup.java (original)
+++ lucene/dev/branches/branch_4x/lucene/suggest/src/java/org/apache/lucene/search/suggest/fst/WFSTCompletionLookup.java Fri Sep 21 02:01:27 2012
@@ -52,10 +52,9 @@ import org.apache.lucene.util.fst.Util.M
* then walks the <i>n</i> shortest paths to retrieve top-ranked
* suggestions.
* <p>
- * <b>NOTE</b>: Although the {@link TermFreqIterator} API specifies
- * floating point weights, input weights should be whole numbers.
- * Input weights will be cast to a java integer, and any
- * negative, infinite, or NaN values will be rejected.
+ * <b>NOTE</b>:
+ * Input weights must be between 0 and {@link Integer#MAX_VALUE}, any
+ * other values will be rejected.
*
* @see Util#shortestPaths(FST, FST.Arc, Comparator, int)
* @lucene.experimental