Apache
/
lucene
mirror of https://github.com/apache/lucene.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

javadocs 

git-svn-id: https://svn.apache.org/repos/asf/lucene/dev/trunk@1384348 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Robert Muir 2012-09-13 14:45:29 +00:00
parent e8a16e028a
commit 5d32662e99
2 changed files with 24 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
lucene/core/src/java/org/apache/lucene/document/Document.java
View File

@ -134,7 +134,7 @@ public final class Document implements IndexDocument {
* returns null.
*
* @param name the name of the field
* @return a <code>byte[][]</code> of binary field values
* @return a <code>BytesRef[]</code> of binary field values
*/
public final BytesRef[] getBinaryValues(String name) {
final List<BytesRef> result = new ArrayList<BytesRef>();
@ -160,7 +160,7 @@ public final class Document implements IndexDocument {
* There may be non-binary fields with the same name.
*
* @param name the name of the field.
* @return a <code>byte[]</code> containing the binary field value or <code>null</code>
* @return a <code>BytesRef</code> containing the binary field value or <code>null</code>
*/
public final BytesRef getBinaryValue(String name) {
Iterator<Field> it = storedFieldsIterator();
@ -196,7 +196,7 @@ public final class Document implements IndexDocument {
* matching fields. It never returns null.
*
* @param name the name of the field
* @return a <code>Fieldable[]</code> array
* @return a <code>Field[]</code> array
*/
public Field[] getFields(String name) {
List<Field> result = new ArrayList<Field>();
@ -215,7 +215,7 @@ public final class Document implements IndexDocument {
* index, e.g. {@link IndexSearcher#doc(int)} or {@link
* IndexReader#document(int)}.
*
* @return an immutable <code>List[Field]</code>
* @return an immutable <code>List&lt;Field&gt;</code>
*/
public final List<Field> getFields() {
return Collections.unmodifiableList(fields);

29
lucene/core/src/java/org/apache/lucene/index/StoredDocument.java
View File

@ -18,33 +18,44 @@ package org.apache.lucene.index;
*/
import java.util.ArrayList;
import java.util.Collections;
import java.util.Iterator;
import java.util.List;
import org.apache.lucene.document.Document;
import org.apache.lucene.document.DoubleField;
import org.apache.lucene.document.Field;
import org.apache.lucene.document.FieldType;
import org.apache.lucene.document.FloatField;
import org.apache.lucene.document.IntField;
import org.apache.lucene.document.LongField;
import org.apache.lucene.search.IndexSearcher;
import org.apache.lucene.search.ScoreDoc;
import org.apache.lucene.util.BytesRef;
/**
* StoredDocument is retrieved from IndexReader containing only stored fields from indexed {@link IndexDocument}.
*/
// TODO: shouldn't this really be in the .document package?
public class StoredDocument implements Iterable<StorableField>{
private final List<StorableField> fields = new ArrayList<StorableField>();
/**
* Adds a field to a document.
* <p> This method supports construction of a StoredDocument from a
* {@link StoredFieldVisitor}. This method cannot
* be used to change the content of an existing index! In order to achieve this,
* a document has to be deleted from an index and a new changed version of that
* document has to be added.</p>
*/
public final void add(StorableField field) {
fields.add(field);
}
/**
* Returns an array of {@link StorableField}s with the given name.
* This method returns an empty array when there are no
* matching fields. It never returns null.
*
* @param name the name of the field
* @return a <code>StorableField[]</code> array
*/
public StorableField[] getFields(String name) {
List<StorableField> result = new ArrayList<StorableField>();
for (StorableField field : fields) {
@ -76,7 +87,7 @@ public class StoredDocument implements Iterable<StorableField>{
* index, e.g. {@link IndexSearcher#doc(int)} or {@link
* IndexReader#document(int)}.
*
* @return an immutable <code>List[StorableField]</code>
* @return an immutable <code>List&lt;StorableField&gt;</code>
*/
public final List<StorableField> getFields() {
return fields;
@ -94,7 +105,7 @@ public class StoredDocument implements Iterable<StorableField>{
* returns null.
*
* @param name the name of the field
* @return a <code>byte[][]</code> of binary field values
* @return a <code>BytesRef[]</code> of binary field values
*/
public final BytesRef[] getBinaryValues(String name) {
final List<BytesRef> result = new ArrayList<BytesRef>();
@ -117,7 +128,7 @@ public class StoredDocument implements Iterable<StorableField>{
* There may be non-binary fields with the same name.
*
* @param name the name of the field.
* @return a <code>byte[]</code> containing the binary field value or <code>null</code>
* @return a <code>BytesRef</code> containing the binary field value or <code>null</code>
*/
public final BytesRef getBinaryValue(String name) {
for (StorableField field : fields) {