FilterByRadiusRequest (Kinetica Java API 6.2.4.0 API)

java.lang.Object
- com.gpudb.protocol.FilterByRadiusRequest

All Implemented Interfaces:

org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord
```
public class FilterByRadiusRequest
extends Object
implements org.apache.avro.generic.IndexedRecord
```
A set of parameters for GPUdb.filterByRadius(FilterByRadiusRequest).
Calculates which objects from a table lie within a circle with the given radius and center point (i.e. circular NAI). The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input circular NAI restriction specification is also created if a viewName is passed in as part of the request.
For track data, all track points that lie within the circle plus one point on either side of the circle (if the track goes beyond the circle) will be included in the result.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class FilterByRadiusRequest.Options
Optional parameters.

Nested Classes
Modifier and Type	Class and Description
`static class`	`FilterByRadiusRequest.Options` Optional parameters.

Constructor Summary

Constructors
Constructor and Description
`FilterByRadiusRequest()` Constructs a FilterByRadiusRequest object with default parameters.
`FilterByRadiusRequest(String tableName, String viewName, String xColumnName, double xCenter, String yColumnName, double yCenter, double radius, Map<String,String> options)` Constructs a FilterByRadiusRequest object with the specified parameters.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`Object`	`get(int index)` This method supports the Avro framework and is not intended to be called directly by the user.
`static org.apache.avro.Schema`	`getClassSchema()` This method supports the Avro framework and is not intended to be called directly by the user.
`Map<String,String>`	`getOptions()`
`double`	`getRadius()`
`org.apache.avro.Schema`	`getSchema()` This method supports the Avro framework and is not intended to be called directly by the user.
`String`	`getTableName()`
`String`	`getViewName()`
`double`	`getXCenter()`
`String`	`getXColumnName()`
`double`	`getYCenter()`
`String`	`getYColumnName()`
`int`	`hashCode()`
`void`	`put(int index, Object value)` This method supports the Avro framework and is not intended to be called directly by the user.
`FilterByRadiusRequest`	`setOptions(Map<String,String> options)`
`FilterByRadiusRequest`	`setRadius(double radius)`
`FilterByRadiusRequest`	`setTableName(String tableName)`
`FilterByRadiusRequest`	`setViewName(String viewName)`
`FilterByRadiusRequest`	`setXCenter(double xCenter)`
`FilterByRadiusRequest`	`setXColumnName(String xColumnName)`
`FilterByRadiusRequest`	`setYCenter(double yCenter)`
`FilterByRadiusRequest`	`setYColumnName(String yColumnName)`
`String`	`toString()`

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

- Constructor Detail
  - FilterByRadiusRequest
```
public FilterByRadiusRequest()
```
    Constructs a FilterByRadiusRequest object with default parameters.
  - FilterByRadiusRequest
```
public FilterByRadiusRequest(String tableName,
                             String viewName,
                             String xColumnName,
                             double xCenter,
                             String yColumnName,
                             double yCenter,
                             double radius,
                             Map<String,String> options)
```
    Constructs a FilterByRadiusRequest object with the specified parameters.
    Parameters:
    
    tableName - Name of the table on which the filter by radius operation will be performed. Must be an existing table.
    
    viewName - If provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables. The default value is ''.
    
    xColumnName - Name of the column to be used for the x-coordinate (the longitude) of the center.
    
    xCenter - Value of the longitude of the center. Must be within [-180.0, 180.0]. The minimum allowed value is -180. The maximum allowed value is 180.
    
    yColumnName - Name of the column to be used for the y-coordinate-the latitude-of the center.
    
    yCenter - Value of the latitude of the center. Must be within [-90.0, 90.0]. The minimum allowed value is -90. The maximum allowed value is 90.
    
    radius - The radius of the circle within which the search will be performed. Must be a non-zero positive value. It is in meters; so, for example, a value of '42000' means 42 km. The minimum allowed value is 0. The maximum allowed value is MAX_INT.
    options - Optional parameters.
    
    COLLECTION_NAME: Name of a collection which is to contain the newly created view. If the collection provided is non-existent, the collection will be automatically created. If empty, then the newly created view will be top-level.
    The default value is an empty Map.
- Method Detail
  - getClassSchema
```
public static org.apache.avro.Schema getClassSchema()
```
    This method supports the Avro framework and is not intended to be called directly by the user.
    
    Returns:
    
    the schema for the class.
  - getTableName
```
public String getTableName()
```
    Returns:
    
    Name of the table on which the filter by radius operation will be performed. Must be an existing table.
  - setTableName
```
public FilterByRadiusRequest setTableName(String tableName)
```
    Parameters:
    
    tableName - Name of the table on which the filter by radius operation will be performed. Must be an existing table.
    
    Returns:
    
    this to mimic the builder pattern.
  - getViewName
```
public String getViewName()
```
    Returns:
    
    If provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables. The default value is ''.
  - setViewName
```
public FilterByRadiusRequest setViewName(String viewName)
```
    Parameters:
    
    viewName - If provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables. The default value is ''.
    
    Returns:
    
    this to mimic the builder pattern.
  - getXColumnName
```
public String getXColumnName()
```
    Returns:
    
    Name of the column to be used for the x-coordinate (the longitude) of the center.
  - setXColumnName
```
public FilterByRadiusRequest setXColumnName(String xColumnName)
```
    Parameters:
    
    xColumnName - Name of the column to be used for the x-coordinate (the longitude) of the center.
    
    Returns:
    
    this to mimic the builder pattern.
  - getXCenter
```
public double getXCenter()
```
    Returns:
    
    Value of the longitude of the center. Must be within [-180.0, 180.0]. The minimum allowed value is -180. The maximum allowed value is 180.
  - setXCenter
```
public FilterByRadiusRequest setXCenter(double xCenter)
```
    Parameters:
    
    xCenter - Value of the longitude of the center. Must be within [-180.0, 180.0]. The minimum allowed value is -180. The maximum allowed value is 180.
    
    Returns:
    
    this to mimic the builder pattern.
  - getYColumnName
```
public String getYColumnName()
```
    Returns:
    
    Name of the column to be used for the y-coordinate-the latitude-of the center.
  - setYColumnName
```
public FilterByRadiusRequest setYColumnName(String yColumnName)
```
    Parameters:
    
    yColumnName - Name of the column to be used for the y-coordinate-the latitude-of the center.
    
    Returns:
    
    this to mimic the builder pattern.
  - getYCenter
```
public double getYCenter()
```
    Returns:
    
    Value of the latitude of the center. Must be within [-90.0, 90.0]. The minimum allowed value is -90. The maximum allowed value is 90.
  - setYCenter
```
public FilterByRadiusRequest setYCenter(double yCenter)
```
    Parameters:
    
    yCenter - Value of the latitude of the center. Must be within [-90.0, 90.0]. The minimum allowed value is -90. The maximum allowed value is 90.
    
    Returns:
    
    this to mimic the builder pattern.
  - getRadius
```
public double getRadius()
```
    Returns:
    
    The radius of the circle within which the search will be performed. Must be a non-zero positive value. It is in meters; so, for example, a value of '42000' means 42 km. The minimum allowed value is 0. The maximum allowed value is MAX_INT.
  - setRadius
```
public FilterByRadiusRequest setRadius(double radius)
```
    Parameters:
    
    radius - The radius of the circle within which the search will be performed. Must be a non-zero positive value. It is in meters; so, for example, a value of '42000' means 42 km. The minimum allowed value is 0. The maximum allowed value is MAX_INT.
    
    Returns:
    
    this to mimic the builder pattern.
  - getOptions
```
public Map<String,String> getOptions()
```
    Returns:
    Optional parameters.
    
    COLLECTION_NAME: Name of a collection which is to contain the newly created view. If the collection provided is non-existent, the collection will be automatically created. If empty, then the newly created view will be top-level.
    The default value is an empty Map.
  - setOptions
```
public FilterByRadiusRequest setOptions(Map<String,String> options)
```
    Parameters:
    options - Optional parameters.
    
    COLLECTION_NAME: Name of a collection which is to contain the newly created view. If the collection provided is non-existent, the collection will be automatically created. If empty, then the newly created view will be top-level.
    The default value is an empty Map.
    Returns:
    
    this to mimic the builder pattern.
  - getSchema
```
public org.apache.avro.Schema getSchema()
```
    This method supports the Avro framework and is not intended to be called directly by the user.
    
    Specified by:
    
    getSchema in interface org.apache.avro.generic.GenericContainer
    
    Returns:
    
    the schema object describing this class.
  - get
```
public Object get(int index)
```
    This method supports the Avro framework and is not intended to be called directly by the user.
    
    Specified by:
    
    get in interface org.apache.avro.generic.IndexedRecord
    
    Parameters:
    
    index - the position of the field to get
    
    Returns:
    
    value of the field with the given index.
    
    Throws:
    
    IndexOutOfBoundsException
  - put
```
public void put(int index,
                Object value)
```
    This method supports the Avro framework and is not intended to be called directly by the user.
    
    Specified by:
    
    put in interface org.apache.avro.generic.IndexedRecord
    
    Parameters:
    
    index - the position of the field to set
    
    value - the value to set
    
    Throws:
    
    IndexOutOfBoundsException
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class FilterByRadiusRequest

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FilterByRadiusRequest

FilterByRadiusRequest

Method Detail

getClassSchema

getTableName

setTableName

getViewName

setViewName

getXColumnName

setXColumnName

getXCenter

setXCenter

getYColumnName

setYColumnName

getYCenter

setYCenter

getRadius

setRadius

getOptions

setOptions

getSchema

get

put

equals

toString

hashCode