Lucene 中自定义排序的实现
使用Lucene来搜索内容,搜索结果的显示顺序当然是比较重要的.Lucene中Build-in的几个排序定义在大多数情况下是不适合我们使用的.要适合自己的应用程序的场景,就只能自定义排序功能,本节我们就来看看在Lucene中如何实现自定义排序功能.
Lucene中的自定义排序功能和Java集合中的自定义排序的实现方法差不多,都要实现一下比较接口.
在Java中只要实现Comparable接口就可以了.但是在Lucene中要实现SortComparatorSource接口和
ScoreDocComparator接口.在了解具体实现方法之前先来看看这两个接口的定义吧.
SortComparatorSource接口的功能是返回一个用来排序ScoreDocs的comparator(Expert: returns a comparator for sorting ScoreDocs).该接口只定义了一个方法.如下:
- /**
- * Creates a comparator for the field in the given index.
- * @param reader - Index to create comparator for.
- * @param fieldname - Field to create comparator for.
- * @return Comparator of ScoreDoc objects.
- * @throws IOException - If an error occurs reading the index.
- */
- public ScoreDocComparator newComparator(IndexReader reader,String fieldname) throws IOException
- /**
- * Creates a comparator for the field in the given index.
- * @param reader - Index to create comparator for.
- * @param fieldname - Field to create comparator for.
- * @return Comparator of ScoreDoc objects.
- * @throws IOException - If an error occurs reading the index.
- */
- public ScoreDocComparator newComparator(IndexReader reader,String fieldname) throws IOException
该方法只是创造一个ScoreDocComparator
实例用来实现排序.所以我们还要实现ScoreDocComparator 接口.来看看ScoreDocComparator
接口.功能是比较来两个ScoreDoc 对象来排序(Compares two ScoreDoc objects for sorting)
里面定义了两个Lucene实现的静态实例.如下:
- //Special comparator for sorting hits according to computed relevance (document score).
- public static final ScoreDocComparator RELEVANCE;
- //Special comparator for sorting hits according to index order (document number).
- public static final ScoreDocComparator INDEXORDER;
- //Special comparator for sorting hits according to computed relevance (document score).
- public static final ScoreDocComparator RELEVANCE;
- //Special comparator for sorting hits according to index order (document number).
- public static final ScoreDocComparator INDEXORDER;
有3个方法与排序相关,需要我们实现 分别如下:
- /**
- * 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
- */
- public 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.
- * @param i Document
- * @return Serializable object
- */
- public 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.
- */
- public int sortType();
- /**
- * 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
- */
- public 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.
- * @param i Document
- * @return Serializable object
- */
- public 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.
- */
- public int sortType();
看个例子吧!
该例子为Lucene in Action中的一个实现,用来搜索距你最近的餐馆的名字. 餐馆坐标用字符串"x,y"来存储.
- package com.nikee.lucene;
- import java.io.IOException;
- import org.apache.lucene.index.IndexReader;
- import org.apache.lucene.index.Term;
- import org.apache.lucene.index.TermDocs;
- import org.apache.lucene.index.TermEnum;
- import org.apache.lucene.search.ScoreDoc;
- import org.apache.lucene.search.ScoreDocComparator;
- import org.apache.lucene.search.SortComparatorSource;
- import org.apache.lucene.search.SortField;
- //实现了搜索距你最近的餐馆的名字. 餐馆坐标用字符串"x,y"来存储
- //DistanceComparatorSource 实现了SortComparatorSource接口
- public class DistanceComparatorSource implements SortComparatorSource {
- private static final long serialVersionUID = 1L;
- // x y 用来保存 坐标位置
- private int x;
- private int y;
- public DistanceComparatorSource(int x, int y) {
- this.x = x;
- this.y = y;
- }
- // 返回ScoreDocComparator 用来实现排序功能
- public ScoreDocComparator newComparator(IndexReader reader, String fieldname) throws IOException {
- return new DistanceScoreDocLookupComparator(reader, fieldname, x, y);
- }
- //DistanceScoreDocLookupComparator 实现了ScoreDocComparator 用来排序
- private static class DistanceScoreDocLookupComparator implements ScoreDocComparator {
- private float[] distances; // 保存每个餐馆到指定点的距离
- // 构造函数 , 构造函数在这里几乎完成所有的准备工作.
- public DistanceScoreDocLookupComparator(IndexReader reader, String fieldname, int x, int y) throws IOException {
- System.out.println("fieldName2="+fieldname);
- final TermEnum enumerator = reader.terms(new Term(fieldname, ""));
- System.out.println("maxDoc="+reader.maxDoc());
- distances = new float[reader.maxDoc()]; // 初始化distances
- if (distances.length > 0) {
- TermDocs termDocs = reader.termDocs();
- try {
- if (enumerator.term() == null) {
- throw new RuntimeException("no terms in field " + fieldname);
- }
- int i = 0,j = 0;
- do {
- System.out.println("in do-while :" + i ++);
- Term term = enumerator.term(); // 取出每一个Term
- if (term.field() != fieldname) // 与给定的域不符合则比较下一个
- break;
- //Sets this to the data for the current term in a TermEnum.
- //This may be optimized in some implementations.
- termDocs.seek(enumerator); //参考TermDocs Doc
- while (termDocs.next()) {
- System.out.println(" in while :" + j ++);
- System.out.println(" in while ,Term :" + term.toString());
- String[] xy = term.text().split(","); // 去处x y
- int deltax = Integer.parseInt(xy[0]) - x;
- int deltay = Integer.parseInt(xy[1]) - y;
- // 计算距离
- distances[termDocs.doc()] = (float) Math.sqrt(deltax * deltax + deltay * deltay);
- }
- }
- while (enumerator.next());
- } finally {
- termDocs.close();
- }
- }
- }
- //有上面的构造函数的准备 这里就比较简单了
- public int compare(ScoreDoc i, ScoreDoc j) {
- if (distances[i.doc] < distances[j.doc])
- return -1;
- if (distances[i.doc] > distances[j.doc])
- return 1;
- return 0;
- }
- // 返回距离
- public Comparable sortValue(ScoreDoc i) {
- return new Float(distances[i.doc]);
- }
- //指定SortType
- public int sortType() {
- return SortField.FLOAT;
- }
- }
- public String toString() {
- return "Distance from (" + x + "," + y + ")";
- }
- }
- package com.nikee.lucene;
- import java.io.IOException;
- import org.apache.lucene.index.IndexReader;
- import org.apache.lucene.index.Term;
- import org.apache.lucene.index.TermDocs;
- import org.apache.lucene.index.TermEnum;
- import org.apache.lucene.search.ScoreDoc;
- import org.apache.lucene.search.ScoreDocComparator;
- import org.apache.lucene.search.SortComparatorSource;
- import org.apache.lucene.search.SortField;
- //实现了搜索距你最近的餐馆的名字. 餐馆坐标用字符串"x,y"来存储
- //DistanceComparatorSource 实现了SortComparatorSource接口
- public class DistanceComparatorSource implements SortComparatorSource {
- private static final long serialVersionUID = 1L;
- // x y 用来保存 坐标位置
- private int x;
- private int y;
- public DistanceComparatorSource(int x, int y) {
- this.x = x;
- this.y = y;
- }
- // 返回ScoreDocComparator 用来实现排序功能
- public ScoreDocComparator newComparator(IndexReader reader, String fieldname) throws IOException {
- return new DistanceScoreDocLookupComparator(reader, fieldname, x, y);
- }
- //DistanceScoreDocLookupComparator 实现了ScoreDocComparator 用来排序
- private static class DistanceScoreDocLookupComparator implements ScoreDocComparator {
- private float[] distances; // 保存每个餐馆到指定点的距离
- // 构造函数 , 构造函数在这里几乎完成所有的准备工作.
- public DistanceScoreDocLookupComparator(IndexReader reader, String fieldname, int x, int y) throws IOException {
- System.out.println("fieldName2="+fieldname);
- final TermEnum enumerator = reader.terms(new Term(fieldname, ""));
- System.out.println("maxDoc="+reader.maxDoc());
- distances = new float[reader.maxDoc()]; // 初始化distances
- if (distances.length > 0) {
- TermDocs termDocs = reader.termDocs();
- try {
- if (enumerator.term() == null) {
- throw new RuntimeException("no terms in field " + fieldname);
- }
- int i = 0,j = 0;
- do {
- System.out.println("in do-while :" + i ++);
- Term term = enumerator.term(); // 取出每一个Term
- if (term.field() != fieldname) // 与给定的域不符合则比较下一个
- break;
- //Sets this to the data for the current term in a TermEnum.
- //This may be optimized in some implementations.
- termDocs.seek(enumerator); //参考TermDocs Doc
- while (termDocs.next()) {
- System.out.println(" in while :" + j ++);
- System.out.println(" in while ,Term :" + term.toString());
- String[] xy = term.text().split(","); // 去处x y
- int deltax = Integer.parseInt(xy[0]) - x;
- int deltay = Integer.parseInt(xy[1]) - y;
- // 计算距离
- distances[termDocs.doc()] = (float) Math.sqrt(deltax * deltax + deltay * deltay);
- }
- }
- while (enumerator.next());
- } finally {
- termDocs.close();
- }
- }
- }
- //有上面的构造函数的准备 这里就比较简单了
- public int compare(ScoreDoc i, ScoreDoc j) {
- if (distances[i.doc] < distances[j.doc])
- return -1;
- if (distances[i.doc] > distances[j.doc])
- return 1;
- return 0;
- }
- // 返回距离
- public Comparable sortValue(ScoreDoc i) {
- return new Float(distances[i.doc]);
- }
- //指定SortType
- public int sortType() {
- return SortField.FLOAT;
- }
- }
- public String toString() {
- return "Distance from (" + x + "," + y + ")";
- }
- }
这是一个实现了上面两个接口的两个类, 里面带有详细注释, 可以看出 自定义排序并不是很难的. 该实现能否正确实现,我们来看看测试代码能否通过吧.
- package com.nikee.lucene.test;
- import java.io.IOException;
- import junit.framework.TestCase;
- import org.apache.lucene.analysis.WhitespaceAnalyzer;
- import org.apache.lucene.document.Document;
- import org.apache.lucene.document.Field;
- import org.apache.lucene.index.IndexWriter;
- import org.apache.lucene.index.Term;
- import org.apache.lucene.search.FieldDoc;
- import org.apache.lucene.search.Hits;
- import org.apache.lucene.search.IndexSearcher;
- import org.apache.lucene.search.Query;
- import org.apache.lucene.search.ScoreDoc;
- import org.apache.lucene.search.Sort;
- import org.apache.lucene.search.SortField;
- import org.apache.lucene.search.TermQuery;
- import org.apache.lucene.search.TopFieldDocs;
- import org.apache.lucene.store.RAMDirectory;
- import com.nikee.lucene.DistanceComparatorSource;
- public class DistanceComparatorSourceTest extends TestCase {
- private RAMDirectory directory;
- private IndexSearcher searcher;
- private Query query;
- //建立测试环境
- protected void setUp() throws Exception {
- directory = new RAMDirectory();
- IndexWriter writer = new IndexWriter(directory, new WhitespaceAnalyzer(), true);
- addPoint(writer, "El Charro", "restaurant", 1, 2);
- addPoint(writer, "Cafe Poca Cosa", "restaurant", 5, 9);
- addPoint(writer, "Los Betos", "restaurant", 9, 6);
- addPoint(writer, "Nico's Taco Shop", "restaurant", 3, 8);
- writer.close();
- searcher = new IndexSearcher(directory);
- query = new TermQuery(new Term("type", "restaurant"));
- }
- private void addPoint(IndexWriter writer, String name, String type, int x, int y) throws IOException {
- Document doc = new Document();
- doc.add(new Field("name", name, Field.Store.YES, Field.Index.TOKENIZED));
- doc.add(new Field("type", type, Field.Store.YES, Field.Index.TOKENIZED));
- doc.add(new Field("location", x + "," + y, Field.Store.YES, Field.Index.UN_TOKENIZED));
- writer.addDocument(doc);
- }
- public void testNearestRestaurantToHome() throws Exception {
- //使用DistanceComparatorSource来构造一个SortField
- Sort sort = new Sort(new SortField("location", new DistanceComparatorSource(0, 0)));
- Hits hits = searcher.search(query, sort); // 搜索
- //测试
- assertEquals("closest", "El Charro", hits.doc(0).get("name"));
- assertEquals("furthest", "Los Betos", hits.doc(3).get("name"));
- }
- public void testNeareastRestaurantToWork() throws Exception {
- Sort sort = new Sort(new SortField("location", new DistanceComparatorSource(10, 10))); // 工作的坐标 10,10
- //上面的测试实现了自定义排序,但是并不能访问自定义排序的更详细信息,利用
- //TopFieldDocs 可以进一步访问相关信息
- TopFieldDocs docs = searcher.search(query, null, 3, sort);
- assertEquals(4, docs.totalHits);
- assertEquals(3, docs.scoreDocs.length);
- //取得FieldDoc 利用FieldDoc可以取得关于排序的更详细信息 请查看FieldDoc Doc
- FieldDoc fieldDoc = (FieldDoc) docs.scoreDocs[0];
- assertEquals("(10,10) -> (9,6) = sqrt(17)", new Float(Math.sqrt(17)), fieldDoc.fields[0]);
- Document document = searcher.doc(fieldDoc.doc);
- assertEquals("Los Betos", document.get("name"));
- dumpDocs(sort, docs); // 显示相关信息
- }
- // 显示有关排序的信息
- private void dumpDocs(Sort sort, TopFieldDocs docs) throws IOException {
- System.out.println("Sorted by: " + sort);
- ScoreDoc[] scoreDocs = docs.scoreDocs;
- for (int i = 0; i < scoreDocs.length; i++) {
- FieldDoc fieldDoc = (FieldDoc) scoreDocs[i];
- Float distance = (Float) fieldDoc.fields[0];
- Document doc = searcher.doc(fieldDoc.doc);
- System.out.println(" " + doc.get("name") + " @ (" + doc.get("location") + ") -> " + distance);
- }
- }
- }
- package com.nikee.lucene.test;
- import java.io.IOException;
- import junit.framework.TestCase;
- import org.apache.lucene.analysis.WhitespaceAnalyzer;
- import org.apache.lucene.document.Document;
- import org.apache.lucene.document.Field;
- import org.apache.lucene.index.IndexWriter;
- import org.apache.lucene.index.Term;
- import org.apache.lucene.search.FieldDoc;
- import org.apache.lucene.search.Hits;
- import org.apache.lucene.search.IndexSearcher;
- import org.apache.lucene.search.Query;
- import org.apache.lucene.search.ScoreDoc;
- import org.apache.lucene.search.Sort;
- import org.apache.lucene.search.SortField;
- import org.apache.lucene.search.TermQuery;
- import org.apache.lucene.search.TopFieldDocs;
- import org.apache.lucene.store.RAMDirectory;
- import com.nikee.lucene.DistanceComparatorSource;
- public class DistanceComparatorSourceTest extends TestCase {
- private RAMDirectory directory;
- private IndexSearcher searcher;
- private Query query;
- //建立测试环境
- protected void setUp() throws Exception {
- directory = new RAMDirectory();
- IndexWriter writer = new IndexWriter(directory, new WhitespaceAnalyzer(), true);
- addPoint(writer, "El Charro", "restaurant", 1, 2);
- addPoint(writer, "Cafe Poca Cosa", "restaurant", 5, 9);
- addPoint(writer, "Los Betos", "restaurant", 9, 6);
- addPoint(writer, "Nico's Taco Shop", "restaurant", 3, 8);
- writer.close();
- searcher = new IndexSearcher(directory);
- query = new TermQuery(new Term("type", "restaurant"));
- }
- private void addPoint(IndexWriter writer, String name, String type, int x, int y) throws IOException {
- Document doc = new Document();
- doc.add(new Field("name", name, Field.Store.YES, Field.Index.TOKENIZED));
- doc.add(new Field("type", type, Field.Store.YES, Field.Index.TOKENIZED));
- doc.add(new Field("location", x + "," + y, Field.Store.YES, Field.Index.UN_TOKENIZED));
- writer.addDocument(doc);
- }
- public void testNearestRestaurantToHome() throws Exception {
- //使用DistanceComparatorSource来构造一个SortField
- Sort sort = new Sort(new SortField("location", new DistanceComparatorSource(0, 0)));
- Hits hits = searcher.search(query, sort); // 搜索
- //测试
- assertEquals("closest", "El Charro", hits.doc(0).get("name"));
- assertEquals("furthest", "Los Betos", hits.doc(3).get("name"));
- }
- public void testNeareastRestaurantToWork() throws Exception {
- Sort sort = new Sort(new SortField("location", new DistanceComparatorSource(10, 10))); // 工作的坐标 10,10
- //上面的测试实现了自定义排序,但是并不能访问自定义排序的更详细信息,利用
- //TopFieldDocs 可以进一步访问相关信息
- TopFieldDocs docs = searcher.search(query, null, 3, sort);
- assertEquals(4, docs.totalHits);
- assertEquals(3, docs.scoreDocs.length);
- //取得FieldDoc 利用FieldDoc可以取得关于排序的更详细信息 请查看FieldDoc Doc
- FieldDoc fieldDoc = (FieldDoc) docs.scoreDocs[0];
- assertEquals("(10,10) -> (9,6) = sqrt(17)", new Float(Math.sqrt(17)), fieldDoc.fields[0]);
- Document document = searcher.doc(fieldDoc.doc);
- assertEquals("Los Betos", document.get("name"));
- dumpDocs(sort, docs); // 显示相关信息
- }
- // 显示有关排序的信息
- private void dumpDocs(Sort sort, TopFieldDocs docs) throws IOException {
- System.out.println("Sorted by: " + sort);
- ScoreDoc[] scoreDocs = docs.scoreDocs;
- for (int i = 0; i < scoreDocs.length; i++) {
- FieldDoc fieldDoc = (FieldDoc) scoreDocs[i];
- Float distance = (Float) fieldDoc.fields[0];
- Document doc = searcher.doc(fieldDoc.doc);
- System.out.println(" " + doc.get("name") + " @ (" + doc.get("location") + ") -> " + distance);
- }
- }
- }
转载 http://zhxmyself.iteye.com/blog/478638
Lucene 中自定义排序的实现的更多相关文章
- Lucene - CustomScoreQuery 自定义排序
在某些场景需要做自定义排序(非单值字段排序.非文本相关度排序),除了自己重写collect.weight,可以借助CustomScoreQuery. 场景:根据tag字段中标签的数量进行排序(tag字 ...
- python中自定义排序函数
Python内置的 sorted()函数可对list进行排序: >>>sorted([36, 5, 12, 9, 21]) [5, 9, 12, 21, 36] 但 sorted() ...
- MySQL中自定义排序
在开发时候,我们经常使用的是默认的排序规则,但在某些特殊情况下,通过指定顺序来进行排序 -- fileld自定义排序时,应该是非主键的,否则主键是无效 SELECT * FROM customer W ...
- Java 中List集合中自定义排序
/* 集合框架的工具类. Collections:集合框架的工具类.里面定义的都是静态方法. Collections和Collection有什么区别? Collection是集合框架中的一个顶层接口, ...
- SQL server中自定义排序
select * from OrderPolicyDetail order by ( case Project when 'C' then 1, when 'A' then 2, when 'D' t ...
- CCF CSP 201503-2 数字排序 (map+自定义排序)
题目链接:http://118.190.20.162/view.page?gpid=T26 返回试题列表 问题描述 试题编号: 201503-2 试题名称: 数字排序 时间限制: 1.0s 内存限制: ...
- C# - List.Sort()自定义排序方法
本文通过示例介绍了C#中典型容器List.Sort()的自定义排序方法,进而引出了C#中自定义排序的核心接口及方法 项目地址:自定义Sort方法 - SouthBegonia's Github Lis ...
- Python:Base4(map,reduce,filter,自定义排序函数(sorted),返回函数,闭包,匿名函数(lambda) )
1.python把函数作为参数: 在2.1小节中,我们讲了高阶函数的概念,并编写了一个简单的高阶函数: def add(x, y, f): return f(x) + f(y) 如果传入abs作为参数 ...
- LeetCode1029 两地调度(贪心+java自定义排序回顾)
题目: 公司计划面试 2N 人.第 i 人飞往 A 市的费用为 costs[i][0],飞往 B 市的费用为 costs[i][1]. 返回将每个人都飞到某座城市的最低费用,要求每个城市都有 N 人抵 ...
随机推荐
- Game2048
using System; using System.Collections.Generic; using System.Linq; using System.Text; using System.T ...
- Genetics in geographically structured populations: defining, estimating and interpreting FST
摘要:Wright’s F‑statistics, and especially FST, provide important insights into the evolutionary proce ...
- Linux Tomcat重新启动
在Linux系统下,重启Tomcat使用命令操作的! 首先,进入Tomcat下的bin目录 cd /usr/local/tomcat/bin 使用Tomcat关闭命令 ./shutdown.sh 查看 ...
- datagrid数据表格的维护
想想刚开始学jsp, 用application做一个简单的数据库, 简单的注册页面, 跟这个相比就是过家家 <%@ page language="java" contentT ...
- mysql数据类型长度
1个字节= 8位 tinyint 为一个字节 2的8次方= 256 所以最多存储到256 日期和时间数据类型 MySQL数据类型 含义 date 3字节,日期,格式:2014-09-18 time ...
- np.identity()
二.np.identity()这个函数和之前的区别在于,这个只能创建方阵,也就是N=M 函数的原型:np.identity(n,dtype=None) 参数:n,int型表示的是输出的矩阵的行数和列数 ...
- centos7 源码编译安装TensorFlow CPU 版本
一.前言 我们都知道,普通使用pip安装的TensorFlow是万金油版本,当你运行的时候,会提示你不是当前电脑中最优的版本,特别是CPU版本,没有使用指令集优化会让TensorFlow用起来更慢. ...
- 18-javaweb-ssm 开发中错误总结
由于web课设于是,写了几天的javaweb,在写的过程中总会遇到奇奇怪怪的一些bug, 一般都得花很多时间解决. 但是解决多了,后面碰到类似的简单多了. 总结下: 一.前端错误: 1.js错误,看前 ...
- Developing ADF PageTemplates
Developing ADF PageTemplates In this hands-on, you learn how to create a page template and use this ...
- Mysql的内存优化
老师 vi mysqld_safe# executing mysqld_safe 后面增加export LD_PRELOAD=/usr/local/lib/libtcmalloc.so 可以做一 ...