alvinalexander.com | career | drupal | java | mac | mysql | perl | scala | uml | unix  

What this is

This file is included in the DevDaily.com "Java Source Code Warehouse" project. The intent of this project is to help you "Learn Java by Example" TM.

Other links

The source code

package org.apache.lucene.search;

/**
 * Copyright 2004 The Apache Software Foundation
 *
 * Licensed 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.
 */


/**
 * Expert: Compares two ScoreDoc objects for sorting.
 *
 * 

Created: Feb 3, 2004 9:00:16 AM * * @author Tim Jones (Nacimiento Software) * @since lucene 1.4 * @version $Id: ScoreDocComparator.java,v 1.5 2004/05/19 23:05:27 tjones Exp $ */ public interface ScoreDocComparator { /** Special comparator for sorting hits according to computed relevance (document score). */ static final ScoreDocComparator RELEVANCE = new ScoreDocComparator() { public int compare (ScoreDoc i, ScoreDoc j) { if (i.score > j.score) return -1; if (i.score < j.score) return 1; return 0; } public Comparable sortValue (ScoreDoc i) { return new Float (i.score); } public int sortType() { return SortField.SCORE; } }; /** Special comparator for sorting hits according to index order (document number). */ static final ScoreDocComparator INDEXORDER = new ScoreDocComparator() { public int compare (ScoreDoc i, ScoreDoc j) { if (i.doc < j.doc) return -1; if (i.doc > j.doc) return 1; return 0; } public Comparable sortValue (ScoreDoc i) { return new Integer (i.doc); } public int sortType() { return SortField.DOC; } }; /** * Compares two ScoreDoc objects and returns a result indicating their * sort order. * @param i First ScoreDoc * @param j Second ScoreDoc * @return -1 if i should come before j
1 if i should come after j
0 if they are equal * @see java.util.Comparator */ int compare (ScoreDoc i, ScoreDoc j); /** * Returns the value used to sort the given document. The * object returned must implement the java.io.Serializable * interface. This is used by multisearchers to determine how to collate results from their searchers. * @see FieldDoc * @param i Document * @return Serializable object */ Comparable sortValue (ScoreDoc i); /** * Returns the type of sort. Should return SortField.SCORE, SortField.DOC, SortField.STRING, SortField.INTEGER, * SortField.FLOAT or SortField.CUSTOM. It is not valid to return SortField.AUTO. * This is used by multisearchers to determine how to collate results from their searchers. * @return One of the constants in SortField. * @see SortField */ int sortType(); }

... this post is sponsored by my books ...

#1 New Release!

FP Best Seller

 

new blog posts

 

Copyright 1998-2024 Alvin Alexander, alvinalexander.com
All Rights Reserved.

A percentage of advertising revenue from
pages under the /java/jwarehouse URI on this website is
paid back to open source projects.