FilterByGeometryRequest (Kinetica Java API 7.2.3.0 API)

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

All Implemented Interfaces:

org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord
```
public class FilterByGeometryRequest
extends Object
implements org.apache.avro.generic.IndexedRecord
```
A set of parameters for GPUdb.filterByGeometry.
Applies a geometry filter against a geospatial geometry column in a given table or view. The filtering geometry is provided by inputWkt.

Nested Class Summary

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

Constructor Summary

Constructors
Constructor and Description
`FilterByGeometryRequest()` Constructs a FilterByGeometryRequest object with default parameters.
`FilterByGeometryRequest(String tableName, String viewName, String columnName, String inputWkt, String operation, Map<String,String> options)` Constructs a FilterByGeometryRequest 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 column to be used in the filter.
`String`	`getInputWkt()` A geometry in WKT format that will be used to filter the objects in `tableName`.
`String`	`getOperation()` The geometric filtering operation to perform.
`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 filter by geometry 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.
`FilterByGeometryRequest`	`setColumnName(String columnName)` Name of the column to be used in the filter.
`FilterByGeometryRequest`	`setInputWkt(String inputWkt)` A geometry in WKT format that will be used to filter the objects in `tableName`.
`FilterByGeometryRequest`	`setOperation(String operation)` The geometric filtering operation to perform.
`FilterByGeometryRequest`	`setOptions(Map<String,String> options)` Optional parameters.
`FilterByGeometryRequest`	`setTableName(String tableName)` Name of the table on which the filter by geometry will be performed, in [schema_name.]table_name format, using standard	`FilterByGeometryRequest`	`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
  - FilterByGeometryRequest
```
public FilterByGeometryRequest()
```
    Constructs a FilterByGeometryRequest object with default parameters.
  - FilterByGeometryRequest
```
public FilterByGeometryRequest(String tableName,
                               String viewName,
                               String columnName,
                               String inputWkt,
                               String operation,
                               Map<String,String> options)
```
    Constructs a FilterByGeometryRequest object with the specified parameters.
    Parameters:
    
    tableName - Name of the table on which the filter by geometry will be performed, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing table or view containing a geospatial geometry column.
    
    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 column to be used in the filter. Must be a geospatial geometry column.
    
    inputWkt - A geometry in WKT format that will be used to filter the objects in tableName. The default value is ''.
    operation - The geometric filtering operation to perform. Supported values:
    
    CONTAINS: Matches records that contain the given WKT in inputWkt, i.e. the given WKT is within the bounds of a record's geometry.
    CROSSES: Matches records that cross the given WKT.
    DISJOINT: Matches records that are disjoint from the given WKT.
    EQUALS: Matches records that are the same as the given WKT.
    INTERSECTS: Matches records that intersect the given WKT.
    OVERLAPS: Matches records that overlap the given WKT.
    TOUCHES: Matches records that touch the given WKT.
    WITHIN: Matches records that are within the given WKT.
    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 geometry will be performed, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing table or view containing a geospatial geometry column.
    
    Returns:
    
    The current value of tableName.
  - setTableName
```
public FilterByGeometryRequest setTableName(String tableName)
```
    Name of the table on which the filter by geometry will be performed, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing table or view containing a geospatial geometry column.
    
    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 FilterByGeometryRequest 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 column to be used in the filter. Must be a geospatial geometry column.
    
    Returns:
    
    The current value of columnName.
  - setColumnName
```
public FilterByGeometryRequest setColumnName(String columnName)
```
    Name of the column to be used in the filter. Must be a geospatial geometry column.
    
    Parameters:
    
    columnName - The new value for columnName.
    
    Returns:
    
    this to mimic the builder pattern.
  - getInputWkt
```
public String getInputWkt()
```
    A geometry in WKT format that will be used to filter the objects in tableName. The default value is ''.
    
    Returns:
    
    The current value of inputWkt.
  - setInputWkt
```
public FilterByGeometryRequest setInputWkt(String inputWkt)
```
    A geometry in WKT format that will be used to filter the objects in tableName. The default value is ''.
    
    Parameters:
    
    inputWkt - The new value for inputWkt.
    
    Returns:
    
    this to mimic the builder pattern.
  - getOperation
```
public String getOperation()
```
    The geometric filtering operation to perform. Supported values:
    - CONTAINS: Matches records that contain the given WKT in inputWkt, i.e. the given WKT is within the bounds of a record's geometry.
    - CROSSES: Matches records that cross the given WKT.
    - DISJOINT: Matches records that are disjoint from the given WKT.
    - EQUALS: Matches records that are the same as the given WKT.
    - INTERSECTS: Matches records that intersect the given WKT.
    - OVERLAPS: Matches records that overlap the given WKT.
    - TOUCHES: Matches records that touch the given WKT.
    - WITHIN: Matches records that are within the given WKT.
    Returns:
    
    The current value of operation.
  - setOperation
```
public FilterByGeometryRequest setOperation(String operation)
```
    The geometric filtering operation to perform. Supported values:
    - CONTAINS: Matches records that contain the given WKT in inputWkt, i.e. the given WKT is within the bounds of a record's geometry.
    - CROSSES: Matches records that cross the given WKT.
    - DISJOINT: Matches records that are disjoint from the given WKT.
    - EQUALS: Matches records that are the same as the given WKT.
    - INTERSECTS: Matches records that intersect the given WKT.
    - OVERLAPS: Matches records that overlap the given WKT.
    - TOUCHES: Matches records that touch the given WKT.
    - WITHIN: Matches records that are within the given WKT.
    Parameters:
    
    operation - The new value for operation.
    
    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 FilterByGeometryRequest 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 FilterByGeometryRequest

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FilterByGeometryRequest

FilterByGeometryRequest

Method Detail

getClassSchema

getTableName

setTableName

getViewName

setViewName

getColumnName

setColumnName

getInputWkt

setInputWkt

getOperation

setOperation

getOptions

setOptions

getSchema

get

put

equals

toString

hashCode