Bounds (Lucene 5.3.0 API)

java.lang.Object
- org.apache.lucene.geo3d.Bounds

```
public class Bounds
extends Object
```
An object for accumulating bounds information. The bounds object is initially empty. Bounding points are then applied by supplying (x,y,z) tuples. It is also possible to indicate the following edge cases: (1) No longitude bound possible (2) No upper latitude bound possible (3) No lower latitude bound possible When any of these have been applied, further application of points cannot override that decision.

WARNING: This API is experimental and might change in incompatible ways in the next release.

Field Summary

Fields
Modifier and Type	Field and Description
`protected Double`	`leftLongitude` If non-null, the left longitude bound
`protected Double`	`maxLatitude` If non-null, the maximum latitude bound
`protected Double`	`minLatitude` If non-null, the minimum latitude bound
`protected boolean`	`noBottomLatitudeBound` Set to true if no bottom latitude bound can be stated
`protected boolean`	`noLongitudeBound` Set to true if no longitude bounds can be stated
`protected boolean`	`noTopLatitudeBound` Set to true if no top latitude bound can be stated
`protected Double`	`rightLongitude` If non-null, the right longitude bound

Constructor Summary

Constructors
Constructor and Description

Bounds()
Construct an empty bounds object

Constructors
Constructor and Description
`Bounds()` Construct an empty bounds object

Method Summary

Methods
Modifier and Type	Method and Description
`Bounds`	`addHorizontalCircle(double z)` Add a constraint representing a horizontal circle with a specified z value.
`protected void`	`addLatitudeBound(double latitude)` Update latitude bound.
`Bounds`	`addLatitudeZone(double latitude)` Add a constraint representing a horizontal circle at a specific latitude.
`protected void`	`addLongitudeBound(double longitude)` Update longitude bound.
`protected void`	`addLongitudeBound(double newLeftLongitude, double newRightLongitude)` Update longitude bound.
`Bounds`	`addLongitudeSlice(double newLeftLongitude, double newRightLongitude)` Add a constraint representing a longitude slice.
`Bounds`	`addPoint(double latitude, double longitude)` Add a single point.
`Bounds`	`addPoint(double x, double y, double z)` Add a single point.
`Bounds`	`addPoint(Vector v)` Add a single point.
`boolean`	`checkNoBottomLatitudeBound()` Check if there's no bottom latitude bound.
`boolean`	`checkNoLongitudeBound()` Check if there's no longitude bound.
`boolean`	`checkNoTopLatitudeBound()` Check if there's no top latitude bound.
`Double`	`getLeftLongitude()` Get left longitude, if any.
`Double`	`getMaxLatitude()` Get maximum latitude, if any.
`Double`	`getMinLatitude()` Get minimum latitude, if any.
`Double`	`getRightLongitude()` Get right longitude, if any.
`Bounds`	`noBottomLatitudeBound()` Signal that there is no bottom latitude bound.
`Bounds`	`noLongitudeBound()` Signal that there is no longitude bound.
`Bounds`	`noTopLatitudeBound()` Signal that there is no top latitude bound.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - noLongitudeBound
```
protected boolean noLongitudeBound
```
    Set to true if no longitude bounds can be stated
  - noTopLatitudeBound
```
protected boolean noTopLatitudeBound
```
    Set to true if no top latitude bound can be stated
  - noBottomLatitudeBound
```
protected boolean noBottomLatitudeBound
```
    Set to true if no bottom latitude bound can be stated
  - minLatitude
```
protected Double minLatitude
```
    If non-null, the minimum latitude bound
  - maxLatitude
```
protected Double maxLatitude
```
    If non-null, the maximum latitude bound
  - leftLongitude
```
protected Double leftLongitude
```
    If non-null, the left longitude bound
  - rightLongitude
```
protected Double rightLongitude
```
    If non-null, the right longitude bound
- Constructor Detail
  - Bounds
```
public Bounds()
```
    Construct an empty bounds object
- Method Detail
  - getMaxLatitude
```
public Double getMaxLatitude()
```
    Get maximum latitude, if any.
    
    Returns:
    maximum latitude or null.
  - getMinLatitude
```
public Double getMinLatitude()
```
    Get minimum latitude, if any.
    
    Returns:
    minimum latitude or null.
  - getLeftLongitude
```
public Double getLeftLongitude()
```
    Get left longitude, if any.
    
    Returns:
    left longitude, or null.
  - getRightLongitude
```
public Double getRightLongitude()
```
    Get right longitude, if any.
    
    Returns:
    right longitude, or null.
  - checkNoLongitudeBound
```
public boolean checkNoLongitudeBound()
```
    Check if there's no longitude bound.
    
    Returns:
    true if no longitude bound.
  - checkNoTopLatitudeBound
```
public boolean checkNoTopLatitudeBound()
```
    Check if there's no top latitude bound.
    
    Returns:
    true if no top latitude bound.
  - checkNoBottomLatitudeBound
```
public boolean checkNoBottomLatitudeBound()
```
    Check if there's no bottom latitude bound.
    
    Returns:
    true if no bottom latitude bound.
  - addHorizontalCircle
```
public Bounds addHorizontalCircle(double z)
```
    Add a constraint representing a horizontal circle with a specified z value.
    
    Parameters:
    z - is the z value.
    
    Returns:
    the updated Bounds object.
  - addLatitudeZone
```
public Bounds addLatitudeZone(double latitude)
```
    Add a constraint representing a horizontal circle at a specific latitude.
    
    Parameters:
    latitude - is the latitude.
    
    Returns:
    the updated Bounds object.
  - addLongitudeSlice
```
public Bounds addLongitudeSlice(double newLeftLongitude,
                       double newRightLongitude)
```
    Add a constraint representing a longitude slice.
    
    Parameters:
    newLeftLongitude - is the left longitude value.
    newRightLongitude - is the right longitude value.
    
    Returns:
    the updated Bounds object.
  - addLatitudeBound
```
protected void addLatitudeBound(double latitude)
```
    Update latitude bound.
    
    Parameters:
    latitude - is the latitude.
  - addLongitudeBound
```
protected void addLongitudeBound(double newLeftLongitude,
                     double newRightLongitude)
```
    Update longitude bound.
    
    Parameters:
    newLeftLongitude - is the left longitude.
    newRightLongitude - is the right longitude.
  - addLongitudeBound
```
protected void addLongitudeBound(double longitude)
```
    Update longitude bound.
    
    Parameters:
    longitude - is the new longitude value.
  - addPoint
```
public Bounds addPoint(Vector v)
```
    Add a single point.
    
    Parameters:
    v - is the point vector.
    
    Returns:
    the updated Bounds object.
  - addPoint
```
public Bounds addPoint(double x,
              double y,
              double z)
```
    Add a single point.
    
    Parameters:
    x - is the point x.
    y - is the point y.
    z - is the point z.
    
    Returns:
    the updated Bounds object.
  - addPoint
```
public Bounds addPoint(double latitude,
              double longitude)
```
    Add a single point.
    
    Parameters:
    latitude - is the point's latitude.
    longitude - is the point's longitude.
    
    Returns:
    the updated Bounds object.
  - noLongitudeBound
```
public Bounds noLongitudeBound()
```
    Signal that there is no longitude bound.
    
    Returns:
    the updated Bounds object.
  - noTopLatitudeBound
```
public Bounds noTopLatitudeBound()
```
    Signal that there is no top latitude bound.
    
    Returns:
    the updated Bounds object.
  - noBottomLatitudeBound
```
public Bounds noBottomLatitudeBound()
```
    Signal that there is no bottom latitude bound.
    
    Returns:
    the updated Bounds object.

Class Bounds

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

noLongitudeBound

noTopLatitudeBound

noBottomLatitudeBound

minLatitude

maxLatitude

leftLongitude

rightLongitude

Constructor Detail

Bounds

Method Detail

getMaxLatitude

getMinLatitude

getLeftLongitude

getRightLongitude

checkNoLongitudeBound

checkNoTopLatitudeBound

checkNoBottomLatitudeBound

addHorizontalCircle

addLatitudeZone

addLongitudeSlice

addLatitudeBound

addLongitudeBound

addLongitudeBound

addPoint

addPoint

addPoint

noLongitudeBound

noTopLatitudeBound

noBottomLatitudeBound