Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Optimize search for when only one result is required
- Loading branch information
1 parent
ee0e358
commit 663c643
Showing
2 changed files
with
72 additions
and
5 deletions.
There are no files selected for viewing
66 changes: 66 additions & 0 deletions
66
community/lucene-index/src/main/java/org/neo4j/kernel/api/impl/index/FirstHitCollector.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,66 @@ | ||
/* | ||
* Copyright (c) 2002-2015 "Neo Technology," | ||
* Network Engine for Objects in Lund AB [http://neotechnology.com] | ||
* | ||
* This file is part of Neo4j. | ||
* | ||
* Neo4j is free software: you can redistribute it and/or modify | ||
* it under the terms of the GNU General Public License as published by | ||
* the Free Software Foundation, either version 3 of the License, or | ||
* (at your option) any later version. | ||
* | ||
* This program is distributed in the hope that it will be useful, | ||
* but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
* GNU General Public License for more details. | ||
* | ||
* You should have received a copy of the GNU General Public License | ||
* along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
*/ | ||
package org.neo4j.kernel.api.impl.index; | ||
|
||
import org.apache.lucene.search.CollectionTerminatedException; | ||
import org.apache.lucene.search.SimpleCollector; | ||
|
||
import java.io.IOException; | ||
|
||
/** | ||
* A {@code Collector} that terminates the collection after the very first hit. | ||
* As a consequence, additional collectors in this search that require a complete run over the index, | ||
* such as {@code TotalHitCountCollector} or {@link DocValuesCollector}, won't work as expected. | ||
*/ | ||
public final class FirstHitCollector extends SimpleCollector | ||
{ | ||
public static final int NO_MATCH = -1; | ||
|
||
private int result = NO_MATCH; | ||
|
||
/** | ||
* @return true when this collector got a match, otherwise false. | ||
*/ | ||
public boolean hasMatched() | ||
{ | ||
return result != NO_MATCH; | ||
} | ||
|
||
/** | ||
* @return the docId if this collector got a match, otherwise {@link FirstHitCollector#NO_MATCH}. | ||
*/ | ||
public int getMatchedDoc() | ||
{ | ||
return result; | ||
} | ||
|
||
@Override | ||
public void collect( int doc ) throws IOException | ||
{ | ||
result = doc; | ||
throw new CollectionTerminatedException(); | ||
} | ||
|
||
@Override | ||
public boolean needsScores() | ||
{ | ||
return false; | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters