NOTE: This API is still in - * flux and might change in incompatible ways in the next - * release. + * Shape contains information related to a shape created on a specific cartesian tier. Because the tiers consist + * of a set of boxes, shapes are defined simply by what boxes the shape overlaps, and what tier level the boxes are at. + * Such a simply approximation will result in points being included that are not in the actual shape, but this fine grained + * filtering is left out of the cartesian shape filtering process. + * + *
NOTE: This API is still in flux and might change in incompatible ways in the next release.
*/
-public class Shape implements Serializable{
+public class Shape implements Serializable {
- private List NOTE: This API is still in
- * flux and might change in incompatible ways in the next
- * release.
+ * Builds instances of {@link org.apache.lucene.spatial.tier.CartesianShapeFilter} for a given latitude, longitude and distance
+ *
+ * NOTE: This API is still in flux and might change in incompatible ways in the next release.
*/
public class CartesianPolyFilterBuilder {
- // Finer granularity than 1 mile isn't accurate with
- // standard java math. Also, there's already a 2nd
- // precise filter, if needed, in DistanceQueryBuilder,
- // that will make the filtering exact.
+ // Finer granularity than 1 mile isn't accurate with standard java math.
public static final double MILES_FLOOR = 1.0;
+ private static IProjector PROJECTOR = new SinusoidalProjector();
- private IProjector projector = new SinusoidalProjector();
private final String tierPrefix;
-
+
+ /**
+ * Creates a new CartesianPolyFilterBuilder that will construct instances of CartesianShapeFilter using the given prefix
+ * of the cartesian tier fields
+ *
+ * @param tierPrefix Prefix of the cartesian tier fields in documents. This will be suffixed by the cartesian tier
+ * level id to determine which fields the filter should access in documents
+ */
- public CartesianPolyFilterBuilder( String tierPrefix ) {
+ public CartesianPolyFilterBuilder(String tierPrefix) {
this.tierPrefix = tierPrefix;
}
-
+
- public Shape getBoxShape(double latitude, double longitude, double miles)
- {
+ /**
+ * Creates a new CartesianShapeFilter that will filter out documents outside of the given miles of the point defined by
+ * the given latitude and longitude
+ *
+ * @param latitude Latitude of the point at the centre of the search area
+ * @param longitude Longitude of the point at the centre of the search area
+ * @param miles Radius in miles around the point that documents must be in, in order not to be filtered out
+ * @return CartesianShapeFilter that will filter out documents of the radius of the point
+ */
+ public Filter getBoundingArea(double latitude, double longitude, double miles) {
+ Shape shape = getBoxShape(latitude, longitude, miles);
+ return new CartesianShapeFilter(shape, tierPrefix + shape.getTierID());
+ }
+
+ // ================================================= Helper Methods ================================================
+
+ /**
+ * Creates the CartesianShape that covers a circle with the given latitude and longitude at its centre, and the given
+ * radius in miles
+ *
+ * @param latitude Latitude of the centre of the circle
+ * @param longitude Longitude of the centre of the circle
+ * @param miles Radius of the circle
+ * @return CartesianShape that covers the circle defined by the lat/long and radius
+ */
+ private Shape getBoxShape(double latitude, double longitude, double miles) {
if (miles < MILES_FLOOR) {
miles = MILES_FLOOR;
}
- LLRect box1 = LLRect.createBox( new FloatLatLng( latitude, longitude ), miles, miles );
- LatLng ll = box1.getLowerLeft();
- LatLng ur = box1.getUpperRight();
- double latY = ur.getLat();
- double latX = ll.getLat();
- double longY = ur.getLng();
- double longX = ll.getLng();
- double longX2 = 0.0;
+ LatLngRectangle latLngRectangle = LatLngRectangle.createBox(new LatLng(latitude, longitude), miles);
+ LatLng lowerLeft = latLngRectangle.getLowerLeft();
+ LatLng upperRight = latLngRectangle.getUpperRight();
- if (ur.getLng() < 0.0 && ll.getLng() > 0.0) {
- longX2 = ll.getLng();
- longX = -180.0;
+ double latY = upperRight.getLat();
+ double latX = lowerLeft.getLat();
+
+ double lngY = upperRight.getLng();
+ double lngX = lowerLeft.getLng();
+ double lngX2 = 0.0;
+
+ if (lngY < 0.0 && lngX > 0.0) {
+ lngX2 = lngX;
+ lngX = -180;
}
- if (ur.getLng() > 0.0 && ll.getLng() < 0.0) {
- longX2 = ll.getLng();
- longX = 0.0;
+ if (lngY > 0.0 && lngX < 0.0) {
+ lngX2 = lngX;
+ lngX = 0.0;
}
-
+
- //System.err.println("getBoxShape:"+latY+"," + longY);
- //System.err.println("getBoxShape:"+latX+"," + longX);
- CartesianTierPlotter ctp = new CartesianTierPlotter(2, projector,tierPrefix);
- int bestFit = ctp.bestFit(miles);
+ int bestFit = CartesianTierPlotter.bestFit(miles);
-
+
- ctp = new CartesianTierPlotter(bestFit, projector,tierPrefix);
- Shape shape = new Shape(ctp.getTierFieldName());
+ CartesianTierPlotter tierPlotter = new CartesianTierPlotter(bestFit, PROJECTOR);
+ Shape shape = new Shape(bestFit);
+ addBoxes(shape, tierPlotter, latX, lngX, latY, lngY);
-
+
- // generate shape
- // iterate from startX->endX
- // iterate from startY -> endY
- // shape.add(currentLat.currentLong);
-
- shape = getShapeLoop(shape,ctp,latX,longX,latY,longY);
- if (longX2 != 0.0) {
- if (longX2 != 0.0) {
- if (longX == 0.0) {
- longX = longX2;
- longY = 0.0;
- shape = getShapeLoop(shape,ctp,latX,longX,latY,longY);
+ if (lngX2 != 0.0) {
+ if (lngX == 0.0) {
+ lngX = lngX2;
+ lngY = 0.0;
+ addBoxes(shape, tierPlotter, latX, lngX, latY, lngY);
- } else {
+ } else {
- longX = longX2;
- longY = -180.0;
- shape = getShapeLoop(shape,ctp,latY,longY,latX,longX);
+ lngX = lngX2;
+ lngY = -180.0;
+ addBoxes(shape, tierPlotter, latY, lngY, latX, lngX);
- }
- }
+ }
+ }
- //System.err.println("getBoxShape2:"+latY+"," + longY);
- //System.err.println("getBoxShape2:"+latX+"," + longX);
- }
-
- return shape;
- }
+
+ return shape;
+ }
- public Shape getShapeLoop(Shape shape, CartesianTierPlotter ctp, double latX, double longX, double latY, double longY)
- {
+ private void addBoxes(Shape shape, CartesianTierPlotter tierPlotter, double latX, double lngX, double latY, double lngY) {
+ double beginAt = tierPlotter.getTierBoxId(latX, lngX);
+ double endAt = tierPlotter.getTierBoxId(latY, lngY);
-
+
- //System.err.println("getShapeLoop:"+latY+"," + longY);
- //System.err.println("getShapeLoop:"+latX+"," + longX);
- double beginAt = ctp.getTierBoxId(latX, longX);
- double endAt = ctp.getTierBoxId(latY, longY);
+ double tierVert = tierPlotter.getTierVerticalPosDivider();
-
+
- double tierVert = ctp.getTierVerticalPosDivider();
- //System.err.println(" | "+ beginAt+" | "+ endAt);
-
- double startX = beginAt - (beginAt %1);
+ double startX = beginAt - (beginAt % 1);
- double startY = beginAt - startX ; //should give a whole number
-
- double endX = endAt - (endAt %1);
+ double endX = endAt - (endAt % 1);
- double endY = endAt -endX; //should give a whole number
-
+
- int scale = (int)Math.log10(tierVert);
+ int scale = (int) Math.log10(tierVert);
- endY = new BigDecimal(endY).setScale(scale, RoundingMode.HALF_EVEN).doubleValue();
- startY = new BigDecimal(startY).setScale(scale, RoundingMode.HALF_EVEN).doubleValue();
- double xInc = 1.0d / tierVert;
- xInc = new BigDecimal(xInc).setScale(scale, RoundingMode.HALF_EVEN).doubleValue();
+ double startY = new BigDecimal(beginAt - startX).setScale(scale, RoundingMode.HALF_EVEN).doubleValue();
+ double endY = new BigDecimal(endAt - endX).setScale(scale, RoundingMode.HALF_EVEN).doubleValue();
-
+
- //System.err.println("go from startX:"+startX+" to:" + endX);
- for (; startX <= endX; startX++){
+ double xInc = new BigDecimal(1.0D / tierVert).setScale(scale, RoundingMode.HALF_EVEN).doubleValue();
-
+
+ for (; startX <= endX; startX++) {
double itY = startY;
- //System.err.println("go from startY:"+startY+" to:" + endY);
- while (itY <= endY){
+ while (itY <= endY) {
- //create a boxId
- // startX.startY
- double boxId = startX + itY ;
+ double boxId = startX + itY;
shape.addBox(boxId);
- //System.err.println("----"+startX+" and "+itY);
- //System.err.println("----"+boxId);
- itY += xInc;
-
- // java keeps 0.0001 as 1.0E-1
- // which ends up as 0.00011111
- itY = new BigDecimal(itY).setScale(scale, RoundingMode.HALF_EVEN).doubleValue();
+ // java keeps 0.0001 as 1.0E-1 which ends up as 0.00011111
+ itY = new BigDecimal(itY + xInc).setScale(scale, RoundingMode.HALF_EVEN).doubleValue();
}
}
- return shape;
}
- public Filter getBoundingArea(double latitude, double longitude, double miles)
- {
- Shape shape = getBoxShape(latitude, longitude, miles);
- return new CartesianShapeFilter(shape, shape.getTierId());
+
- }
+}
-}
Index: contrib/spatial/src/java/org/apache/lucene/spatial/tier/CartesianShapeFilter.java
===================================================================
--- contrib/spatial/src/java/org/apache/lucene/spatial/tier/CartesianShapeFilter.java (revision 834847)
+++ contrib/spatial/src/java/org/apache/lucene/spatial/tier/CartesianShapeFilter.java Sun Dec 20 20:04:18 CET 2009
@@ -28,34 +28,43 @@
import org.apache.lucene.util.OpenBitSet;
/**
- * NOTE: This API is still in
- * flux and might change in incompatible ways in the next
- * release.
+ * CartesianShapeFilter is a proper Lucene filter that filters out documents that are not within the boxes that define
+ * a certain CartesianShape overlaps. For example, if a shape overlaps boxes 1, 3 and 6, then a document that has been
+ * plotted to be within box 5 will be filtered out.
+ *
+ * NOTE: This API is still in flux and might change in incompatible ways in the next release.
*/
public class CartesianShapeFilter extends Filter {
private final Shape shape;
private final String fieldName;
-
+
- CartesianShapeFilter(final Shape shape, final String fieldName){
+ /**
+ * Creates a new CartesianShapeFilter that will filter out documents that are not within the boxes defined in the
+ * given Shape.
+ *
+ * @param shape Shape containing boxes that documents must be within, in order not to be filtered out
+ * @param fieldName Name of the field in the documents that will be checked for what boxes the document is in
+ */
+ public CartesianShapeFilter(Shape shape, String fieldName) {
this.shape = shape;
this.fieldName = fieldName;
}
-
+
+ /**
+ * {@inheritDoc}
+ */
@Override
- public DocIdSet getDocIdSet(final IndexReader reader) throws IOException {
- final OpenBitSet bits = new OpenBitSet(reader.maxDoc());
- final TermDocs termDocs = reader.termDocs();
- final List NOTE: This API is still in
- * flux and might change in incompatible ways in the next
- * release.
+ * NOTE: This API is still in flux and might change in incompatible ways in the next release.
*/
public class SinusoidalProjector implements IProjector {
-
- public String coordsAsString(double latitude, double longitude) {
- return null;
- }
-
+ /**
+ * {@inheritDoc}
+ */
public double[] coords(double latitude, double longitude) {
double rlat = Math.toRadians(latitude);
double rlong = Math.toRadians(longitude);
double nlat = rlong * Math.cos(rlat);
- double r[] = {nlat, rlong};
- return r;
+ return new double[]{nlat, rlong};
+ }
-
+
+ /**
+ * {@inheritDoc}
+ */
+ public String coordsAsString(double latitude, double longitude) {
+ return null;
}
-
+
}
Index: contrib/spatial/src/java/org/apache/lucene/spatial/tier/projections/CartesianTierPlotter.java
===================================================================
--- contrib/spatial/src/java/org/apache/lucene/spatial/tier/projections/CartesianTierPlotter.java (revision 821186)
+++ contrib/spatial/src/java/org/apache/lucene/spatial/tier/projections/CartesianTierPlotter.java Sun Dec 20 20:46:10 CET 2009
@@ -18,147 +18,174 @@
package org.apache.lucene.spatial.tier.projections;
/**
- * NOTE: This API is still in
- * flux and might change in incompatible ways in the next
- * release.
+ * CartesianTierPlotter provides functionality for plotting a point defined by a longitude and latitude, in a box thats
+ * part of a cartesian tier.
+ *
+ * NOTE: This API is still in flux and might change in incompatible ways in the next release.
*/
public class CartesianTierPlotter {
+
+ /**
+ * @deprecated This class will not provide a default field prefix in the future as it is not its responsibility
+ */
+ @Deprecated
public static final String DEFALT_FIELD_PREFIX = "_tier_";
-
+
- final int tierLevel;
- int tierLength;
- int tierBoxes;
- int tierVerticalPosDivider;
- final IProjector projector;
- final String fieldPrefix;
- Double idd = Double.valueOf(180);
+ private static final Double idd = 180D;
+ private static final double LOG_2 = Math.log(2);
- public CartesianTierPlotter (int tierLevel, IProjector projector, String fieldPrefix) {
+ private final int tierLevel;
+ private final int tierLength;
+ private final int tierVerticalPosDivider;
+ private final IProjector projector;
-
+
+ private String fieldPrefix;
+
+ /**
+ * Creates a new CartesianTierPlotter that will plot points at the given tier level using the given Projector
+ *
+ * @param tierLevel Tier Level the plotter should plot its points at
+ * @param projector Projector that the plotter should use to project points onto a tier
+ */
+ public CartesianTierPlotter(int tierLevel, IProjector projector) {
this.tierLevel = tierLevel;
this.projector = projector;
- this.fieldPrefix = fieldPrefix;
- setTierLength();
- setTierBoxes();
- setTierVerticalPosDivider();
- }
-
- private void setTierLength (){
- this.tierLength = (int) Math.pow(2 , this.tierLevel);
+ this.tierLength = (int) Math.pow(2, this.tierLevel);
+ this.tierVerticalPosDivider = calculateTierVerticalPosDivider();
}
-
+
- private void setTierBoxes () {
- this.tierBoxes = (int)Math.pow(this.tierLength, 2);
+ /**
+ * Find the tier with the best fit for a bounding box. Best fit is defined as the ceiling of log2 (circumference of
+ * earth / distance) distance is defined as the smallest box fitting the corner between a radius and a bounding box.
+ * Math.log(value) / Math.log(2)
- * @param value
- */
- public double log2(double value) {
-
- return Math.log(value) / Math.log(2);
- }
-}