Apache
/
lucene
mirror of https://github.com/apache/lucene.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

LUCENE-4169 LUCENE-4175 mark Lucene spatial classes as @lucene.experimental or @lucene.internal and did a little javadoc enhancement 

git-svn-id: https://svn.apache.org/repos/asf/lucene/dev/trunk@1355126 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
David Wayne Smiley 2012-06-28 19:32:24 +00:00
parent 699b7c7843
commit 9418494277
6 changed files with 17 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
lucene/spatial/src/java/org/apache/lucene/spatial/bbox/AreaSimilarity.java
View File

@ -39,8 +39,11 @@ import com.spatial4j.core.shape.Rectangle;
* <br/> targetFactor = Math.pow(targetRatio,targetPower);
* <br/> score = queryFactor * targetFactor;
* <p/>
* original:
* http://geoportal.svn.sourceforge.net/svnroot/geoportal/Geoportal/trunk/src/com/esri/gpt/catalog/lucene/SpatialRankingValueSource.java
* Based on Geoportal's
* <a href="http://geoportal.svn.sourceforge.net/svnroot/geoportal/Geoportal/trunk/src/com/esri/gpt/catalog/lucene/SpatialRankingValueSource.java">
* SpatialRankingValueSource</a>.
*
* @lucene.experimental
*/
public class AreaSimilarity implements BBoxSimilarity {
/**

4
lucene/spatial/src/java/org/apache/lucene/spatial/bbox/BBoxFieldInfo.java
View File

@ -21,7 +21,9 @@ import org.apache.lucene.spatial.SpatialFieldInfo;
/**
* The Bounding Box gets stored as four fields for x/y min/max and a flag
* that says if the box crosses the dateline (xdl)
* that says if the box crosses the dateline (xdl).
*
* @lucene.experimental
*/
public class BBoxFieldInfo implements SpatialFieldInfo {

5
lucene/spatial/src/java/org/apache/lucene/spatial/bbox/BBoxSimilarity.java
View File

@ -20,8 +20,9 @@ import org.apache.lucene.search.Explanation;
import com.spatial4j.core.shape.Rectangle;
/**
* @lucene.experimental
*/
public interface BBoxSimilarity {
public double score(Rectangle extent, Explanation exp);

2
lucene/spatial/src/java/org/apache/lucene/spatial/bbox/BBoxSimilarityValueSource.java
View File

@ -32,6 +32,8 @@ import com.spatial4j.core.shape.simple.RectangleImpl;
/**
* An implementation of the Lucene ValueSource model to support spatial relevance ranking.
*
* @lucene.experimental
*/
public class BBoxSimilarityValueSource extends ValueSource {

6
lucene/spatial/src/java/org/apache/lucene/spatial/bbox/BBoxStrategy.java
View File

@ -44,8 +44,10 @@ import com.spatial4j.core.shape.*;
/**
* original:
* http://geoportal.svn.sourceforge.net/svnroot/geoportal/Geoportal/trunk/src/com/esri/gpt/catalog/lucene/SpatialClauseAdapter.java
* Based on GeoPortal's
* <a href="http://geoportal.svn.sourceforge.net/svnroot/geoportal/Geoportal/trunk/src/com/esri/gpt/catalog/lucene/SpatialClauseAdapter.java">SpatialClauseAdapter</a>.
*
* @lucene.experimental
*/
public class BBoxStrategy extends SpatialStrategy<BBoxFieldInfo> {
public double queryPower = 1.0;

18
lucene/spatial/src/java/org/apache/lucene/spatial/bbox/package-info.java
View File

@ -1,21 +1,3 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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.
*/
/**
* Bounding Box Spatial Strategy
*