com.gpudb.protocol

Class FilterByBoxGeometryRequest

java.lang.Object

com.gpudb.protocol.FilterByBoxGeometryRequest

All Implemented Interfaces:

org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord

public class FilterByBoxGeometryRequest
extends Object
implements org.apache.avro.generic.IndexedRecord

A set of parameters for GPUdb.filterByBoxGeometry(FilterByBoxGeometryRequest).

Calculates which geospatial geometry objects from a table intersect a rectangular box. 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 which satisfies the input NAI restriction specification is also created when a viewName is passed in as part of the input payload.

Constructor Summary

Constructors

Constructor and Description
FilterByBoxGeometryRequest() Constructs a FilterByBoxGeometryRequest object with default parameters.
FilterByBoxGeometryRequest(String tableName, String viewName, String columnName, double minX, double maxX, double minY, double maxY, Map<String,String> options) Constructs a FilterByBoxGeometryRequest object with the specified parameters.

Method Summary

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()
double	getMaxX()
double	getMaxY()
double	getMinX()
double	getMinY()
Map<String,String>	getOptions()
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()
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.
FilterByBoxGeometryRequest	setColumnName(String columnName)
FilterByBoxGeometryRequest	setMaxX(double maxX)
FilterByBoxGeometryRequest	setMaxY(double maxY)
FilterByBoxGeometryRequest	setMinX(double minX)
FilterByBoxGeometryRequest	setMinY(double minY)
FilterByBoxGeometryRequest	setOptions(Map<String,String> options)
FilterByBoxGeometryRequest	setTableName(String tableName)
FilterByBoxGeometryRequest	setViewName(String viewName)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

FilterByBoxGeometryRequest

public FilterByBoxGeometryRequest()

Constructs a FilterByBoxGeometryRequest object with default parameters.

FilterByBoxGeometryRequest

public FilterByBoxGeometryRequest(String tableName,
                          String viewName,
                          String columnName,
                          double minX,
                          double maxX,
                          double minY,
                          double maxY,
                          Map<String,String> options)

Constructs a FilterByBoxGeometryRequest object with the specified parameters.

Parameters:

tableName - Name of the table on which the bounding box operation will be performed. Must be an existing table.

viewName - Optional name of the result view that will be created containing the results of the query. Must not be an already existing collection, table or view.

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

minX - Lower bound for the x-coordinate of the rectangular box. Must be less than or equal to maxX.

maxX - Upper bound for the x-coordinate of the rectangular box. Must be greater than or equal to minX.

minY - Lower bound for the y-coordinate of the rectangular box. Must be less than or equal to maxY.

maxY - Upper bound for the y-coordinate of the rectangular box. Must be greater than or equal to minY.

options - Optional parameters.

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 bounding box operation will be performed. Must be an existing table.

setTableName

public FilterByBoxGeometryRequest setTableName(String tableName)

Parameters:

tableName - Name of the table on which the bounding box operation will be performed. Must be an existing table.

Returns:

this to mimic the builder pattern.

getViewName

public String getViewName()

Returns:

Optional name of the result view that will be created containing the results of the query. Must not be an already existing collection, table or view.

setViewName

public FilterByBoxGeometryRequest setViewName(String viewName)

Parameters:

viewName - Optional name of the result view that will be created containing the results of the query. Must not be an already existing collection, table or view.

Returns:

this to mimic the builder pattern.

getColumnName

public String getColumnName()

Returns:

Name of the geospatial geometry column to be filtered.

setColumnName

public FilterByBoxGeometryRequest setColumnName(String columnName)

Parameters:

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

Returns:

this to mimic the builder pattern.

getMinX

public double getMinX()

Returns:

Lower bound for the x-coordinate of the rectangular box. Must be less than or equal to maxX.

setMinX

public FilterByBoxGeometryRequest setMinX(double minX)

Parameters:

minX - Lower bound for the x-coordinate of the rectangular box. Must be less than or equal to maxX.

Returns:

this to mimic the builder pattern.

getMaxX

public double getMaxX()

Returns:

Upper bound for the x-coordinate of the rectangular box. Must be greater than or equal to minX.

setMaxX

public FilterByBoxGeometryRequest setMaxX(double maxX)

Parameters:

maxX - Upper bound for the x-coordinate of the rectangular box. Must be greater than or equal to minX.

Returns:

this to mimic the builder pattern.

getMinY

public double getMinY()

Returns:

Lower bound for the y-coordinate of the rectangular box. Must be less than or equal to maxY.

setMinY

public FilterByBoxGeometryRequest setMinY(double minY)

Parameters:

minY - Lower bound for the y-coordinate of the rectangular box. Must be less than or equal to maxY.

Returns:

this to mimic the builder pattern.

getMaxY

public double getMaxY()

Returns:

Upper bound for the y-coordinate of the rectangular box. Must be greater than or equal to minY.

setMaxY

public FilterByBoxGeometryRequest setMaxY(double maxY)

Parameters:

maxY - Upper bound for the y-coordinate of the rectangular box. Must be greater than or equal to minY.

Returns:

this to mimic the builder pattern.

getOptions

public Map<String,String> getOptions()

Returns:

Optional parameters.

setOptions

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

Parameters:

options - Optional parameters.

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