FilterByBoxGeometryRequest (Kinetica Java API 7.2.3.0 API)

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

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

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

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

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.
`double`	`getMaxX()` Upper bound for the x-coordinate of the rectangular box.
`double`	`getMaxY()` Upper bound for the y-coordinate of the rectangular box.
`double`	`getMinX()` Lower bound for the x-coordinate of the rectangular box.
`double`	`getMinY()` Lower bound for the y-coordinate of the rectangular box.
`Map<String,String>`	`getOptions()` Optional parameters.
`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 bounding box 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	`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)` Name of the geospatial geometry column to be filtered.
`FilterByBoxGeometryRequest`	`setMaxX(double maxX)` Upper bound for the x-coordinate of the rectangular box.
`FilterByBoxGeometryRequest`	`setMaxY(double maxY)` Upper bound for the y-coordinate of the rectangular box.
`FilterByBoxGeometryRequest`	`setMinX(double minX)` Lower bound for the x-coordinate of the rectangular box.
`FilterByBoxGeometryRequest`	`setMinY(double minY)` Lower bound for the y-coordinate of the rectangular box.
`FilterByBoxGeometryRequest`	`setOptions(Map<String,String> options)` Optional parameters.
`FilterByBoxGeometryRequest`	`setTableName(String tableName)` Name of the table on which the bounding box operation will be performed, in [schema_name.]table_name format, using standard	`FilterByBoxGeometryRequest`	`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	`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, 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.
    
    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.
    
    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 bounding box 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 FilterByBoxGeometryRequest setTableName(String tableName)
```
    Name of the table on which the bounding box 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 FilterByBoxGeometryRequest 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 FilterByBoxGeometryRequest 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.
  - getMinX
```
public double getMinX()
```
    Lower bound for the x-coordinate of the rectangular box. Must be less than or equal to maxX.
    
    Returns:
    
    The current value of minX.
  - setMinX
```
public FilterByBoxGeometryRequest setMinX(double minX)
```
    Lower bound for the x-coordinate of the rectangular box. Must be less than or equal to maxX.
    
    Parameters:
    
    minX - The new value for minX.
    
    Returns:
    
    this to mimic the builder pattern.
  - getMaxX
```
public double getMaxX()
```
    Upper bound for the x-coordinate of the rectangular box. Must be greater than or equal to minX.
    
    Returns:
    
    The current value of maxX.
  - setMaxX
```
public FilterByBoxGeometryRequest setMaxX(double maxX)
```
    Upper bound for the x-coordinate of the rectangular box. Must be greater than or equal to minX.
    
    Parameters:
    
    maxX - The new value for maxX.
    
    Returns:
    
    this to mimic the builder pattern.
  - getMinY
```
public double getMinY()
```
    Lower bound for the y-coordinate of the rectangular box. Must be less than or equal to maxY.
    
    Returns:
    
    The current value of minY.
  - setMinY
```
public FilterByBoxGeometryRequest setMinY(double minY)
```
    Lower bound for the y-coordinate of the rectangular box. Must be less than or equal to maxY.
    
    Parameters:
    
    minY - The new value for minY.
    
    Returns:
    
    this to mimic the builder pattern.
  - getMaxY
```
public double getMaxY()
```
    Upper bound for the y-coordinate of the rectangular box. Must be greater than or equal to minY.
    
    Returns:
    
    The current value of maxY.
  - setMaxY
```
public FilterByBoxGeometryRequest setMaxY(double maxY)
```
    Upper bound for the y-coordinate of the rectangular box. Must be greater than or equal to minY.
    
    Parameters:
    
    maxY - The new value for maxY.
    
    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 FilterByBoxGeometryRequest 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 FilterByBoxGeometryRequest

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FilterByBoxGeometryRequest

FilterByBoxGeometryRequest

Method Detail

getClassSchema

getTableName

setTableName

getViewName

setViewName

getColumnName

setColumnName

getMinX

setMinX

getMaxX

setMaxX

getMinY

setMinY

getMaxY

setMaxY

getOptions

setOptions

getSchema

get

put

equals

toString

hashCode