01: package org.apache.lucene.search;
02:
03: /**
04: * Licensed to the Apache Software Foundation (ASF) under one or more
05: * contributor license agreements. See the NOTICE file distributed with
06: * this work for additional information regarding copyright ownership.
07: * The ASF licenses this file to You under the Apache License, Version 2.0
08: * (the "License"); you may not use this file except in compliance with
09: * the License. You may obtain a copy of the License at
10: *
11: * http://www.apache.org/licenses/LICENSE-2.0
12: *
13: * Unless required by applicable law or agreed to in writing, software
14: * distributed under the License is distributed on an "AS IS" BASIS,
15: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16: * See the License for the specific language governing permissions and
17: * limitations under the License.
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 472959 2006-11-09 16:21:50Z yonik $
38: * @see ScoreDoc
39: * @see TopFieldDocs
40: */
41: public class FieldDoc extends ScoreDoc {
42:
43: /** Expert: The values which are used to sort the referenced document.
44: * The order of these will match the original sort criteria given by a
45: * Sort object. Each Object will be either an Integer, Float or String,
46: * depending on the type of values in the terms of the original field.
47: * @see Sort
48: * @see Searcher#search(Query,Filter,int,Sort)
49: */
50: public Comparable[] fields;
51:
52: /** Expert: Creates one of these objects with empty sort information. */
53: public FieldDoc(int doc, float score) {
54: super (doc, score);
55: }
56:
57: /** Expert: Creates one of these objects with the given sort information. */
58: public FieldDoc(int doc, float score, Comparable[] fields) {
59: super(doc, score);
60: this.fields = fields;
61: }
62: }
|