Document.java
001 package gate.creole.annic.apache.lucene.document;
002 
003 /**
004  * Copyright 2004 The Apache Software Foundation
005  *
006  * Licensed under the Apache License, Version 2.0 (the "License");
007  * you may not use this file except in compliance with the License.
008  * You may obtain a copy of the License at
009  *
010  *     http://www.apache.org/licenses/LICENSE-2.0
011  *
012  * Unless required by applicable law or agreed to in writing, software
013  * distributed under the License is distributed on an "AS IS" BASIS,
014  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015  * See the License for the specific language governing permissions and
016  * limitations under the License.
017  */
018 
019 import java.util.Enumeration;
020 import java.util.Iterator;
021 import java.util.List;
022 import java.util.ArrayList;
023 import java.util.Vector;
024 import gate.creole.annic.apache.lucene.index.IndexReader;       // for javadoc
025 import gate.creole.annic.apache.lucene.search.Searcher;         // for javadoc
026 import gate.creole.annic.apache.lucene.search.Hits;             // for javadoc
027 
028 /** Documents are the unit of indexing and search.
029  *
030  * A Document is a set of fields.  Each field has a name and a textual value.
031  * A field may be {@link Field#isStored() stored} with the document, in which
032  * case it is returned with search hits on the document.  Thus each document
033  * should typically contain one or more stored fields which uniquely identify
034  * it.
035  *
036  <p>Note that fields which are <i>not</i> {@link Field#isStored() stored} are
037  <i>not</i> available in documents retrieved from the index, e.g. with {@link
038  * Hits#doc(int)}{@link Searcher#doc(int)} or {@link
039  * IndexReader#document(int)}.
040  */
041 
042 @SuppressWarnings({"serial","rawtypes","unchecked"})
043 public final class Document implements java.io.Serializable {
044   List fields = new Vector();
045   private float boost = 1.0f;
046 
047   /** Constructs a new document with no fields. */
048   public Document() {}
049 
050 
051   /** Sets a boost factor for hits on any field of this document.  This value
052    * will be multiplied into the score of all hits on this document.
053    *
054    <p>Values are multiplied into the value of {@link Field#getBoost()} of
055    * each field in this document.  Thus, this method in effect sets a default
056    * boost for the fields of this document.
057    *
058    @see Field#setBoost(float)
059    */
060   public void setBoost(float boost) {
061     this.boost = boost;
062   }
063 
064   /** Returns the boost factor for hits on any field of this document.
065    *
066    <p>The default value is 1.0.
067    *
068    <p>Note: This value is not stored directly with the document in the index.
069    * Documents returned from {@link IndexReader#document(int)} and
070    {@link Hits#doc(int)} may thus not have the same value present as when
071    * this document was indexed.
072    *
073    @see #setBoost(float)
074    */
075   public float getBoost() {
076     return boost;
077   }
078 
079   /**
080    <p>Adds a field to a document.  Several fields may be added with
081    * the same name.  In this case, if the fields are indexed, their text is
082    * treated as though appended for the purposes of search.</p>
083    <p> Note that add like the removeField(s) methods only makes sense
084    * prior to adding a document to an index. These methods cannot
085    * be used to change the content of an existing index! In order to achieve this,
086    * a document has to be deleted from an index and a new changed version of that
087    * document has to be added.</p>
088    */
089   public final void add(Field field) {
090     fields.add(field);
091   }
092 
093   /**
094    <p>Removes field with the specified name from the document.
095    * If multiple fields exist with this name, this method removes the first field that has been added.
096    * If there is no field with the specified name, the document remains unchanged.</p>
097    <p> Note that the removeField(s) methods like the add method only make sense
098    * prior to adding a document to an index. These methods cannot
099    * be used to change the content of an existing index! In order to achieve this,
100    * a document has to be deleted from an index and a new changed version of that
101    * document has to be added.</p>
102    */
103   public final void removeField(String name) {
104     Iterator it = fields.iterator();
105     while (it.hasNext()) {
106       Field field = (Field)it.next();
107       if (field.name().equals(name)) {
108         it.remove();
109         return;
110       }
111     }
112   }
113 
114   /**
115    <p>Removes all fields with the given name from the document.
116    * If there is no field with the specified name, the document remains unchanged.</p>
117    <p> Note that the removeField(s) methods like the add method only make sense
118    * prior to adding a document to an index. These methods cannot
119    * be used to change the content of an existing index! In order to achieve this,
120    * a document has to be deleted from an index and a new changed version of that
121    * document has to be added.</p>
122    */
123   public final void removeFields(String name) {
124     Iterator it = fields.iterator();
125     while (it.hasNext()) {
126       Field field = (Field)it.next();
127       if (field.name().equals(name)) {
128         it.remove();
129       }
130     }
131   }
132 
133   /** Returns a field with the given name if any exist in this document, or
134    * null.  If multiple fields exists with this name, this method returns the
135    * first value added.
136    */
137   public final Field getField(String name) {
138     for (int i = 0; i < fields.size(); i++) {
139       Field field = (Field)fields.get(i);
140       if (field.name().equals(name))
141   return field;
142     }
143     return null;
144   }
145 
146   /** Returns the string value of the field with the given name if any exist in
147    * this document, or null.  If multiple fields exist with this name, this
148    * method returns the first value added.
149    */
150   public final String get(String name) {
151     Field field = getField(name);
152     if (field != null)
153       return field.stringValue();
154     else
155       return null;
156   }
157 
158   /** Returns an Enumeration of all the fields in a document. */
159   public final Enumeration fields() {
160     return ((Vector)fields).elements();
161   }
162 
163   /**
164    * Returns an array of {@link Field}s with the given name.
165    * This method can return <code>null</code>.
166    *
167    @param name the name of the field
168    @return <code>Field[]</code> array
169    */
170    public final Field[] getFields(String name) {
171      List result = new ArrayList();
172      for (int i = 0; i < fields.size(); i++) {
173        Field field = (Field)fields.get(i);
174        if (field.name().equals(name)) {
175          result.add(field);
176        }
177      }
178 
179      if (result.size() == 0)
180        return null;
181 
182      return (Field[])result.toArray(new Field[result.size()]);
183    }
184 
185   /**
186    * Returns an array of values of the field specified as the method parameter.
187    * This method can return <code>null</code>.
188    *
189    @param name the name of the field
190    @return <code>String[]</code> of field values
191    */
192   public final String[] getValues(String name) {
193     Field[] namedFields = getFields(name);
194     if (namedFields == null)
195       return null;
196     String[] values = new String[namedFields.length];
197     for (int i = 0; i < namedFields.length; i++) {
198       values[i= namedFields[i].stringValue();
199     }
200     return values;
201   }
202 
203   /** Prints the fields of a document for human consumption. */
204   @Override
205   public final String toString() {
206     StringBuffer buffer = new StringBuffer();
207     buffer.append("Document<");
208     for (int i = 0; i < fields.size(); i++) {
209       Field field = (Field)fields.get(i);
210       buffer.append(field.toString());
211       if (i != fields.size()-1)
212         buffer.append(" ");
213     }
214     buffer.append(">");
215     return buffer.toString();
216   }
217 }