FieldDoc.java
01 package gate.creole.annic.apache.lucene.search;
02 
03 /**
04  * Copyright 2004 The Apache Software Foundation
05  *
06  * Licensed under the Apache License, Version 2.0 (the "License");
07  * you may not use this file except in compliance with the License.
08  * You may obtain a copy of the License at
09  *
10  *     http://www.apache.org/licenses/LICENSE-2.0
11  *
12  * Unless required by applicable law or agreed to in writing, software
13  * distributed under the License is distributed on an "AS IS" BASIS,
14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15  * See the License for the specific language governing permissions and
16  * limitations under the License.
17  */
18 
19 
20 /**
21  * Expert: A ScoreDoc which also contains information about
22  * how to sort the referenced document.  In addition to the
23  * document number and score, this object contains an array
24  * of values for the document from the field(s) used to sort.
25  * For example, if the sort criteria was to sort by fields
26  * "a", "b" then "c", the <code>fields</code> object array
27  * will have three elements, corresponding respectively to
28  * the term values for the document in fields "a", "b" and "c".
29  * The class of each element in the array will be either
30  * Integer, Float or String depending on the type of values
31  * in the terms of each field.
32  *
33  <p>Created: Feb 11, 2004 1:23:38 PM
34  *
35  @author  Tim Jones (Nacimiento Software)
36  @since   lucene 1.4
37  @version $Id: FieldDoc.java 529 2004-10-05 11:55:26Z niraj $
38  @see ScoreDoc
39  @see TopFieldDocs
40  */
41 @SuppressWarnings({"serial","rawtypes"})
42 public class FieldDoc
43 extends ScoreDoc {
44 
45   /** Expert: The values which are used to sort the referenced document.
46    * The order of these will match the original sort criteria given by a
47    * Sort object.  Each Object will be either an Integer, Float or String,
48    * depending on the type of values in the terms of the original field.
49    @see Sort
50    @see Searchable#search(Query,Filter,int,Sort)
51    */
52   public Comparable[] fields;
53 
54   /** Expert: Creates one of these objects with empty sort information. */
55   public FieldDoc (int doc, float score) {
56     super (doc, score);
57   }
58 
59   /** Expert: Creates one of these objects with the given sort information. */
60   public FieldDoc (int doc, float score, Comparable[] fields) {
61     super (doc, score);
62     this.fields = fields;
63   }
64 }