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 public class FieldDoc
42 extends ScoreDoc {
43
44 /** Expert: The values which are used to sort the referenced document.
45 * The order of these will match the original sort criteria given by a
46 * Sort object. Each Object will be either an Integer, Float or String,
47 * depending on the type of values in the terms of the original field.
48 * @see Sort
49 * @see Searchable#search(Query,Filter,int,Sort)
50 */
51 public Comparable[] fields;
52
53 /** Expert: Creates one of these objects with empty sort information. */
54 public FieldDoc (int doc, float score) {
55 super (doc, score);
56 }
57
58 /** Expert: Creates one of these objects with the given sort information. */
59 public FieldDoc (int doc, float score, Comparable[] fields) {
60 super (doc, score);
61 this.fields = fields;
62 }
63 }
|