X-Git-Url: https://git.mdrn.pl/pylucene.git/blobdiff_plain/a2e61f0c04805cfcb8706176758d1283c7e3a55c..aaeed5504b982cf3545252ab528713250aa33eed:/lucene-java-3.4.0/lucene/src/java/org/apache/lucene/document/Document.java diff --git a/lucene-java-3.4.0/lucene/src/java/org/apache/lucene/document/Document.java b/lucene-java-3.4.0/lucene/src/java/org/apache/lucene/document/Document.java deleted file mode 100644 index b0dbac3..0000000 --- a/lucene-java-3.4.0/lucene/src/java/org/apache/lucene/document/Document.java +++ /dev/null @@ -1,319 +0,0 @@ -package org.apache.lucene.document; - -/** - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright ownership. - * The ASF licenses this file to You under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance with - * the License. You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -import java.util.*; // for javadoc -import org.apache.lucene.search.ScoreDoc; // for javadoc -import org.apache.lucene.search.Searcher; // for javadoc -import org.apache.lucene.index.IndexReader; // for javadoc - -/** Documents are the unit of indexing and search. - * - * A Document is a set of fields. Each field has a name and a textual value. - * A field may be {@link Fieldable#isStored() stored} with the document, in which - * case it is returned with search hits on the document. Thus each document - * should typically contain one or more stored fields which uniquely identify - * it. - * - *
Note that fields which are not {@link Fieldable#isStored() stored} are
- * not available in documents retrieved from the index, e.g. with {@link
- * ScoreDoc#doc}, {@link Searcher#doc(int)} or {@link
- * IndexReader#document(int)}.
- */
-
-public final class Document implements java.io.Serializable {
- List The default value is 1.0.
- *
- * Values are multiplied into the value of {@link Fieldable#getBoost()} of
- * each field in this document. Thus, this method in effect sets a default
- * boost for the fields of this document.
- *
- * @see Fieldable#setBoost(float)
- */
- public void setBoost(float boost) {
- this.boost = boost;
- }
-
- /** Returns, at indexing time, the boost factor as set by {@link #setBoost(float)}.
- *
- * Note that once a document is indexed this value is no longer available
- * from the index. At search time, for retrieved documents, this method always
- * returns 1. This however does not mean that the boost value set at indexing
- * time was ignored - it was just combined with other indexing time factors and
- * stored elsewhere, for better indexing and search performance. (For more
- * information see the "norm(t,d)" part of the scoring formula in
- * {@link org.apache.lucene.search.Similarity Similarity}.)
- *
- * @see #setBoost(float)
- */
- public float getBoost() {
- return boost;
- }
-
- /**
- * Adds a field to a document. Several fields may be added with
- * the same name. In this case, if the fields are indexed, their text is
- * treated as though appended for the purposes of search. Note that add like the removeField(s) methods only makes sense
- * prior to adding a document to an index. These methods 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. Removes field with the specified name from the document.
- * If multiple fields exist with this name, this method removes the first field that has been added.
- * If there is no field with the specified name, the document remains unchanged. Note that the removeField(s) methods like the add method only make sense
- * prior to adding a document to an index. These methods 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. Removes all fields with the given name from the document.
- * If there is no field with the specified name, the document remains unchanged. Note that the removeField(s) methods like the add method only make sense
- * prior to adding a document to an index. These methods 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. Note that fields which are not {@link Fieldable#isStored() stored} are
- * not available in documents retrieved from the
- * index, e.g. {@link Searcher#doc(int)} or {@link
- * IndexReader#document(int)}.
- */
- public final ListField[]
array
- * @deprecated use {@link #getFieldable} instead and cast depending on
- * data type.
- * @throws ClassCastException if you try to retrieve a numerical or
- * lazy loaded field.
- */
- @Deprecated
- public final Field[] getFields(String name) {
- ListFieldable[]
array
- */
- public Fieldable[] getFieldables(String name) {
- ListString[]
of field values
- */
- public final String[] getValues(String name) {
- Listbyte[][]
of binary field values
- */
- public final byte[][] getBinaryValues(String name) {
- Listnull
- * if no binary fields with the specified name are available.
- * There may be non-binary fields with the same name.
- *
- * @param name the name of the field.
- * @return a byte[]
containing the binary field value or null
- */
- public final byte[] getBinaryValue(String name) {
- for (Fieldable field : fields) {
- if (field.name().equals(name) && (field.isBinary()))
- return field.getBinaryValue();
- }
- return null;
- }
-
- /** Prints the fields of a document for human consumption. */
- @Override
- public final String toString() {
- StringBuilder buffer = new StringBuilder();
- buffer.append("Document<");
- for (int i = 0; i < fields.size(); i++) {
- Fieldable field = fields.get(i);
- buffer.append(field.toString());
- if (i != fields.size()-1)
- buffer.append(" ");
- }
- buffer.append(">");
- return buffer.toString();
- }
-}