FilterByRadiusGeometryRequest (Kinetica Java API 7.2.3.0 API)

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

All Implemented Interfaces:

org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord
```
public class FilterByRadiusGeometryRequest
extends Object
implements org.apache.avro.generic.IndexedRecord
```
A set of parameters for GPUdb.filterByRadiusGeometry.
Calculates which geospatial geometry objects from a table intersect 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.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class FilterByRadiusGeometryRequest.Options
A set of string constants for the FilterByRadiusGeometryRequest parameter options.

Nested Classes
Modifier and Type	Class and Description
`static class`	`FilterByRadiusGeometryRequest.Options` A set of string constants for the `FilterByRadiusGeometryRequest` parameter `options`.

Constructor Summary

Constructors
Constructor and Description
`FilterByRadiusGeometryRequest()` Constructs a FilterByRadiusGeometryRequest object with default parameters.
`FilterByRadiusGeometryRequest(String tableName, String viewName, String columnName, double xCenter, double yCenter, double radius, Map<String,String> options)` Constructs a FilterByRadiusGeometryRequest 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.
`String`	`getColumnName()` Name of the geospatial geometry column to be filtered.
`Map<String,String>`	`getOptions()` Optional parameters.
`double`	`getRadius()` The radius of the circle within which the search will be performed.
`org.apache.avro.Schema`	`getSchema()` This method supports the Avro framework and is not intended to be called directly by the user.
`String`	`getTableName()` Name of the table on which the filter by radius operation will be performed, in [schema_name.]table_name format, using standard	`String`	`getViewName()` If provided, then this will be the name of the view containing the results, in [schema_name.]view_name format, using standard	`double`	`getXCenter()` Value of the longitude of the center.
`double`	`getYCenter()` Value of the latitude of the center.
`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.
`FilterByRadiusGeometryRequest`	`setColumnName(String columnName)` Name of the geospatial geometry column to be filtered.
`FilterByRadiusGeometryRequest`	`setOptions(Map<String,String> options)` Optional parameters.
`FilterByRadiusGeometryRequest`	`setRadius(double radius)` The radius of the circle within which the search will be performed.
`FilterByRadiusGeometryRequest`	`setTableName(String tableName)` Name of the table on which the filter by radius operation will be performed, in [schema_name.]table_name format, using standard	`FilterByRadiusGeometryRequest`	`setViewName(String viewName)` If provided, then this will be the name of the view containing the results, in [schema_name.]view_name format, using standard	`FilterByRadiusGeometryRequest`	`setXCenter(double xCenter)` Value of the longitude of the center.
`FilterByRadiusGeometryRequest`	`setYCenter(double yCenter)` Value of the latitude of the center.
`String`	`toString()`

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

- Constructor Detail
  - FilterByRadiusGeometryRequest
```
public FilterByRadiusGeometryRequest()
```
    Constructs a FilterByRadiusGeometryRequest object with default parameters.
  - FilterByRadiusGeometryRequest
```
public FilterByRadiusGeometryRequest(String tableName,
                                     String viewName,
                                     String columnName,
                                     double xCenter,
                                     double yCenter,
                                     double radius,
                                     Map<String,String> options)
```
    Constructs a FilterByRadiusGeometryRequest object with the specified parameters.
    Parameters:
    
    tableName - Name of the table on which the filter by radius operation will be performed, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing table.
    
    viewName - If provided, then this will be the name of the view containing the results, in [schema_name.]view_name format, using standard name resolution rules and meeting table naming criteria. Must not be an already existing table or view. The default value is ''.
    
    columnName - Name of the geospatial geometry column to be filtered.
    
    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.
    
    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.
    
    CREATE_TEMP_TABLE: If TRUE, a unique temporary table name will be generated in the sys_temp schema and used in place of viewName. This is always allowed even if the caller does not have permission to create tables. The generated name is returned in QUALIFIED_VIEW_NAME. Supported values:
    
    TRUE
    FALSE
    The default value is FALSE.
    COLLECTION_NAME: [DEPRECATED--please specify the containing schema for the view as part of viewName and use GPUdb.createSchema to create the schema if non-existent] Name of a schema for the newly created view. If the schema provided is non-existent, it will be automatically created.
    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()
```
    Name of the table on which the filter by radius operation will be performed, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing table.
    
    Returns:
    
    The current value of tableName.
  - setTableName
```
public FilterByRadiusGeometryRequest setTableName(String tableName)
```
    Name of the table on which the filter by radius operation will be performed, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing table.
    
    Parameters:
    
    tableName - The new value for tableName.
    
    Returns:
    
    this to mimic the builder pattern.
  - getViewName
```
public String getViewName()
```
    If provided, then this will be the name of the view containing the results, in [schema_name.]view_name format, using standard name resolution rules and meeting table naming criteria. Must not be an already existing table or view. The default value is ''.
    
    Returns:
    
    The current value of viewName.
  - setViewName
```
public FilterByRadiusGeometryRequest setViewName(String viewName)
```
    If provided, then this will be the name of the view containing the results, in [schema_name.]view_name format, using standard name resolution rules and meeting table naming criteria. Must not be an already existing table or view. The default value is ''.
    
    Parameters:
    
    viewName - The new value for viewName.
    
    Returns:
    
    this to mimic the builder pattern.
  - getColumnName
```
public String getColumnName()
```
    Name of the geospatial geometry column to be filtered.
    
    Returns:
    
    The current value of columnName.
  - setColumnName
```
public FilterByRadiusGeometryRequest setColumnName(String columnName)
```
    Name of the geospatial geometry column to be filtered.
    
    Parameters:
    
    columnName - The new value for columnName.
    
    Returns:
    
    this to mimic the builder pattern.
  - getXCenter
```
public double getXCenter()
```
    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:
    
    The current value of xCenter.
  - setXCenter
```
public FilterByRadiusGeometryRequest setXCenter(double 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.
    
    Parameters:
    
    xCenter - The new value for xCenter.
    
    Returns:
    
    this to mimic the builder pattern.
  - getYCenter
```
public double getYCenter()
```
    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:
    
    The current value of yCenter.
  - setYCenter
```
public FilterByRadiusGeometryRequest setYCenter(double 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.
    
    Parameters:
    
    yCenter - The new value for yCenter.
    
    Returns:
    
    this to mimic the builder pattern.
  - getRadius
```
public double getRadius()
```
    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:
    
    The current value of radius.
  - setRadius
```
public FilterByRadiusGeometryRequest setRadius(double 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.
    
    Parameters:
    
    radius - The new value for radius.
    
    Returns:
    
    this to mimic the builder pattern.
  - getOptions
```
public Map<String,String> getOptions()
```
    Optional parameters.
    - CREATE_TEMP_TABLE: If TRUE, a unique temporary table name will be generated in the sys_temp schema and used in place of viewName. This is always allowed even if the caller does not have permission to create tables. The generated name is returned in QUALIFIED_VIEW_NAME. Supported values:
      
      TRUE
      FALSE
      The default value is FALSE.
    - COLLECTION_NAME: [DEPRECATED--please specify the containing schema for the view as part of viewName and use GPUdb.createSchema to create the schema if non-existent] Name of a schema for the newly created view. If the schema provided is non-existent, it will be automatically created.
    The default value is an empty Map.
    Returns:
    
    The current value of options.
  - setOptions
```
public FilterByRadiusGeometryRequest setOptions(Map<String,String> options)
```
    Optional parameters.
    - CREATE_TEMP_TABLE: If TRUE, a unique temporary table name will be generated in the sys_temp schema and used in place of viewName. This is always allowed even if the caller does not have permission to create tables. The generated name is returned in QUALIFIED_VIEW_NAME. Supported values:
      
      TRUE
      FALSE
      The default value is FALSE.
    - COLLECTION_NAME: [DEPRECATED--please specify the containing schema for the view as part of viewName and use GPUdb.createSchema to create the schema if non-existent] Name of a schema for the newly created view. If the schema provided is non-existent, it will be automatically created.
    The default value is an empty Map.
    Parameters:
    
    options - The new value for options.
    
    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 FilterByRadiusGeometryRequest

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FilterByRadiusGeometryRequest

FilterByRadiusGeometryRequest

Method Detail

getClassSchema

getTableName

setTableName

getViewName

setViewName

getColumnName

setColumnName

getXCenter

setXCenter

getYCenter

setYCenter

getRadius

setRadius

getOptions

setOptions

getSchema

get

put

equals

toString

hashCode