mirror of https://github.com/apache/lucene.git
spellling & typos
git-svn-id: https://svn.apache.org/repos/asf/incubator/solr/trunk@409907 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
parent
e42880a5dc
commit
1501cc364c
|
@ -21,7 +21,7 @@ import org.apache.solr.util.*;
|
|||
|
||||
/**
|
||||
* MBean interface for getting various ui friendly strings and URLs
|
||||
* for use by objects which are 'plugable' to make server administration
|
||||
* for use by objects which are 'pluggable' to make server administration
|
||||
* easier.
|
||||
*
|
||||
* @author ronp
|
||||
|
@ -50,7 +50,7 @@ public interface SolrInfoMBean {
|
|||
* Documentation URL list.
|
||||
*
|
||||
* <p>
|
||||
* Suggested documentaion URLs: Homepage for sponsoring project,
|
||||
* Suggested documentation URLs: Homepage for sponsoring project,
|
||||
* FAQ on class usage, Design doc for class, Wiki, bug reporting URL, etc...
|
||||
* </p>
|
||||
*/
|
||||
|
|
|
@ -43,7 +43,7 @@ public interface SolrQueryRequest {
|
|||
|
||||
/**
|
||||
* Returns the input parameter values for the specified name
|
||||
* @return the values; may be null or empty depending on implimentation
|
||||
* @return the values; may be null or empty depending on implementation
|
||||
*/
|
||||
public String[] getParams(String name);
|
||||
|
||||
|
|
|
@ -23,9 +23,9 @@ import org.apache.solr.core.SolrCore;
|
|||
import org.apache.solr.core.SolrException;
|
||||
|
||||
/**
|
||||
* Base implimentation of <code>SolrQueryRequest</code> that provides some
|
||||
* convinience methods for accessing parameters, and manages an IndexSearcher
|
||||
* refrence.
|
||||
* Base implementation of <code>SolrQueryRequest</code> that provides some
|
||||
* convenience methods for accessing parameters, and manages an IndexSearcher
|
||||
* reference.
|
||||
*
|
||||
* <p>
|
||||
* The <code>close()</code> method must be called on any instance of this
|
||||
|
|
|
@ -30,14 +30,15 @@ import java.util.Iterator;
|
|||
* @version $Id$
|
||||
*/
|
||||
public interface DocIterator extends Iterator<Integer> {
|
||||
// allready declared in superclass, redeclaring prevents javadoc inheritence
|
||||
// already declared in superclass, redeclaring prevents javadoc inheritance
|
||||
//public boolean hasNext();
|
||||
|
||||
/**
|
||||
* Returns the next document id if hasNext()==true
|
||||
*
|
||||
* <code>
|
||||
* This method is functionally equivilent to <code>next()</code>
|
||||
* This method is equivalent to <code>next()</code>, but avoids the creation
|
||||
* of an Integer Object.
|
||||
* @see #next()
|
||||
*/
|
||||
public int nextDoc();
|
||||
|
|
|
@ -67,7 +67,7 @@ public interface DocList extends DocSet {
|
|||
public DocList subset(int offset, int len);
|
||||
|
||||
/**
|
||||
* Returns an interator that may be used to iterate over the documents in this DocList
|
||||
* Returns an iterator that may be used to iterate over the documents in this DocList
|
||||
*
|
||||
* <p>
|
||||
* The order of the documents returned by this iterator is based on the
|
||||
|
|
|
@ -39,20 +39,21 @@ public interface DocSet /* extends Collection<Integer> */ {
|
|||
* (optional operation).
|
||||
*
|
||||
* @see #addUnique
|
||||
* @throws SolrException if the implimentation does not allow modifications
|
||||
* @throws SolrException if the implementation does not allow modifications
|
||||
*/
|
||||
public void add(int doc);
|
||||
|
||||
/**
|
||||
* Adds a document the caller knows is not currently in the DocSet
|
||||
* (optional operation).
|
||||
*
|
||||
* <p>
|
||||
* This method may be faster then <code>add(doc)</code> in some
|
||||
* implimentaions provided the caller is certain of the precondition.
|
||||
* implementaions provided the caller is certain of the precondition.
|
||||
* </p>
|
||||
*
|
||||
* @see #add
|
||||
* @throws SolrException if the implimentation does not allow modifications
|
||||
* @throws SolrException if the implementation does not allow modifications
|
||||
*/
|
||||
public void addUnique(int doc);
|
||||
|
||||
|
@ -67,7 +68,7 @@ public interface DocSet /* extends Collection<Integer> */ {
|
|||
public boolean exists(int docid);
|
||||
|
||||
/**
|
||||
* Returns an interator that may be used to iterate over all of the documents in the set.
|
||||
* Returns an iterator that may be used to iterate over all of the documents in the set.
|
||||
*
|
||||
* <p>
|
||||
* The order of the documents returned by this iterator is
|
||||
|
@ -124,7 +125,7 @@ public interface DocSet /* extends Collection<Integer> */ {
|
|||
|
||||
}
|
||||
|
||||
/** A base class that may be usefull for implimenting DocSets */
|
||||
/** A base class that may be usefull for implementing DocSets */
|
||||
abstract class DocSetBase implements DocSet {
|
||||
|
||||
// Not implemented efficiently... for testing purposes only
|
||||
|
@ -149,14 +150,14 @@ abstract class DocSetBase implements DocSet {
|
|||
}
|
||||
|
||||
/**
|
||||
* @throws SolrException Base implimentation does not allow modifications
|
||||
* @throws SolrException Base implementation does not allow modifications
|
||||
*/
|
||||
public void add(int doc) {
|
||||
throw new SolrException(500,"Unsupported Operation");
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws SolrException Base implimentation does not allow modifications
|
||||
* @throws SolrException Base implementation does not allow modifications
|
||||
*/
|
||||
public void addUnique(int doc) {
|
||||
throw new SolrException(500,"Unsupported Operation");
|
||||
|
|
|
@ -38,7 +38,7 @@ public class DocSlice extends DocSetBase implements DocList {
|
|||
* @param offset starting offset for this range of docs
|
||||
* @param len length of results
|
||||
* @param docs array of docids starting at position 0
|
||||
* @param scores array of scores that corrisponds to docs, may be null
|
||||
* @param scores array of scores that corresponds to docs, may be null
|
||||
* @param matches total number of matches for the query
|
||||
*/
|
||||
public DocSlice(int offset, int len, int[] docs, float[] scores, int matches, float maxScore) {
|
||||
|
|
|
@ -55,7 +55,7 @@ public class NamedList implements Cloneable, Serializable {
|
|||
* Creates an instance backed by an explicitly specified list of
|
||||
* pairwise names/values.
|
||||
*
|
||||
* @param nameValuePairs underlying List which should be used to impliment a NamedList; modifying this List will affect the NamedList.
|
||||
* @param nameValuePairs underlying List which should be used to implement a NamedList; modifying this List will affect the NamedList.
|
||||
*/
|
||||
public NamedList(List nameValuePairs) {
|
||||
nvPairs=nameValuePairs;
|
||||
|
@ -107,7 +107,7 @@ public class NamedList implements Cloneable, Serializable {
|
|||
}
|
||||
|
||||
/**
|
||||
* Scans the list sequentially begining at the specified index and
|
||||
* Scans the list sequentially beginning at the specified index and
|
||||
* returns the index of the first pair with the specified name.
|
||||
*
|
||||
* @param name name to look for, may be null
|
||||
|
|
Loading…
Reference in New Issue