com.gpudb.protocol

Class FilterByRadiusGeometryRequest

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(FilterByRadiusGeometryRequest).

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 Optional parameters.

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

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()
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()
double	getYCenter()
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)
FilterByRadiusGeometryRequest	setOptions(Map<String,String> options)
FilterByRadiusGeometryRequest	setRadius(double radius)
FilterByRadiusGeometryRequest	setTableName(String tableName)
FilterByRadiusGeometryRequest	setViewName(String viewName)
FilterByRadiusGeometryRequest	setXCenter(double xCenter)
FilterByRadiusGeometryRequest	setYCenter(double yCenter)
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(CreateSchemaRequest) 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()

Returns:

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.

setTableName

public FilterByRadiusGeometryRequest setTableName(String tableName)

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.

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, 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 ''.

setViewName

public FilterByRadiusGeometryRequest setViewName(String viewName)

Parameters:

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 ''.

Returns:

this to mimic the builder pattern.

getColumnName

public String getColumnName()

Returns:

Name of the geospatial geometry column to be filtered.

setColumnName

public FilterByRadiusGeometryRequest setColumnName(String columnName)

Parameters:

columnName - Name of the geospatial geometry column to be filtered.

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 FilterByRadiusGeometryRequest 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.

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 FilterByRadiusGeometryRequest 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 FilterByRadiusGeometryRequest 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.

• 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(CreateSchemaRequest) 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.

setOptions

public FilterByRadiusGeometryRequest setOptions(Map<String,String> options)

Parameters:

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(CreateSchemaRequest) 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:

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