FilterByAreaRequest (Kinetica Java API 7.0.19.0 API)

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

All Implemented Interfaces:

org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord
```
public class FilterByAreaRequest
extends Object
implements org.apache.avro.generic.IndexedRecord
```
A set of parameters for GPUdb.filterByArea(FilterByAreaRequest).
Calculates which objects from a table are within a named area of interest (NAI/polygon). The operation is synchronous, meaning that a response will not be returned until all the matching objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input NAI restriction specification is created with the name viewName passed in as part of the input.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class FilterByAreaRequest.Options
Optional parameters.

Nested Classes
Modifier and Type	Class and Description
`static class`	`FilterByAreaRequest.Options` Optional parameters.

Constructor Summary

Constructors
Constructor and Description
`FilterByAreaRequest()` Constructs a FilterByAreaRequest object with default parameters.
`FilterByAreaRequest(String tableName, String viewName, String xColumnName, List<Double> xVector, String yColumnName, List<Double> yVector, Map<String,String> options)` Constructs a FilterByAreaRequest 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.
`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()`
`String`	`getXColumnName()`
`List<Double>`	`getXVector()`
`String`	`getYColumnName()`
`List<Double>`	`getYVector()`
`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.
`FilterByAreaRequest`	`setOptions(Map<String,String> options)`
`FilterByAreaRequest`	`setTableName(String tableName)`
`FilterByAreaRequest`	`setViewName(String viewName)`
`FilterByAreaRequest`	`setXColumnName(String xColumnName)`
`FilterByAreaRequest`	`setXVector(List<Double> xVector)`
`FilterByAreaRequest`	`setYColumnName(String yColumnName)`
`FilterByAreaRequest`	`setYVector(List<Double> yVector)`
`String`	`toString()`

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

- Constructor Detail
  - FilterByAreaRequest
```
public FilterByAreaRequest()
```
    Constructs a FilterByAreaRequest object with default parameters.
  - FilterByAreaRequest
```
public FilterByAreaRequest(String tableName,
                           String viewName,
                           String xColumnName,
                           List<Double> xVector,
                           String yColumnName,
                           List<Double> yVector,
                           Map<String,String> options)
```
    Constructs a FilterByAreaRequest object with the specified parameters.
    Parameters:
    
    tableName - Name of the table to filter. This may be the name of a collection, a table, or a view (when chaining queries). If filtering a collection, all child tables where the filter expression is valid will be filtered; the filtered result tables will then be placed in a collection specified by viewName.
    
    viewName - If provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables. The default value is ''.
    
    xColumnName - Name of the column containing the x values to be filtered.
    
    xVector - List of x coordinates of the vertices of the polygon representing the area to be filtered.
    
    yColumnName - Name of the column containing the y values to be filtered.
    
    yVector - List of y coordinates of the vertices of the polygon representing the area to be filtered.
    options - Optional parameters.
    
    COLLECTION_NAME: Name of a collection which is to contain the newly created view. If the collection provided is non-existent, the collection will be automatically created. If empty, then the newly created view will be top-level.
    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 to filter. This may be the name of a collection, a table, or a view (when chaining queries). If filtering a collection, all child tables where the filter expression is valid will be filtered; the filtered result tables will then be placed in a collection specified by viewName.
  - setTableName
```
public FilterByAreaRequest setTableName(String tableName)
```
    Parameters:
    
    tableName - Name of the table to filter. This may be the name of a collection, a table, or a view (when chaining queries). If filtering a collection, all child tables where the filter expression is valid will be filtered; the filtered result tables will then be placed in a collection specified by viewName.
    
    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. Has the same naming restrictions as tables. The default value is ''.
  - setViewName
```
public FilterByAreaRequest setViewName(String viewName)
```
    Parameters:
    
    viewName - If provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables. The default value is ''.
    
    Returns:
    
    this to mimic the builder pattern.
  - getXColumnName
```
public String getXColumnName()
```
    Returns:
    
    Name of the column containing the x values to be filtered.
  - setXColumnName
```
public FilterByAreaRequest setXColumnName(String xColumnName)
```
    Parameters:
    
    xColumnName - Name of the column containing the x values to be filtered.
    
    Returns:
    
    this to mimic the builder pattern.
  - getXVector
```
public List<Double> getXVector()
```
    Returns:
    
    List of x coordinates of the vertices of the polygon representing the area to be filtered.
  - setXVector
```
public FilterByAreaRequest setXVector(List<Double> xVector)
```
    Parameters:
    
    xVector - List of x coordinates of the vertices of the polygon representing the area to be filtered.
    
    Returns:
    
    this to mimic the builder pattern.
  - getYColumnName
```
public String getYColumnName()
```
    Returns:
    
    Name of the column containing the y values to be filtered.
  - setYColumnName
```
public FilterByAreaRequest setYColumnName(String yColumnName)
```
    Parameters:
    
    yColumnName - Name of the column containing the y values to be filtered.
    
    Returns:
    
    this to mimic the builder pattern.
  - getYVector
```
public List<Double> getYVector()
```
    Returns:
    
    List of y coordinates of the vertices of the polygon representing the area to be filtered.
  - setYVector
```
public FilterByAreaRequest setYVector(List<Double> yVector)
```
    Parameters:
    
    yVector - List of y coordinates of the vertices of the polygon representing the area to be filtered.
    
    Returns:
    
    this to mimic the builder pattern.
  - getOptions
```
public Map<String,String> getOptions()
```
    Returns:
    Optional parameters.
    
    COLLECTION_NAME: Name of a collection which is to contain the newly created view. If the collection provided is non-existent, the collection will be automatically created. If empty, then the newly created view will be top-level.
    The default value is an empty Map.
  - setOptions
```
public FilterByAreaRequest setOptions(Map<String,String> options)
```
    Parameters:
    options - Optional parameters.
    
    COLLECTION_NAME: Name of a collection which is to contain the newly created view. If the collection provided is non-existent, the collection will be automatically created. If empty, then the newly created view will be top-level.
    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

Class FilterByAreaRequest

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FilterByAreaRequest

FilterByAreaRequest

Method Detail

getClassSchema

getTableName

setTableName

getViewName

setViewName

getXColumnName

setXColumnName

getXVector

setXVector

getYColumnName

setYColumnName

getYVector

setYVector

getOptions

setOptions

getSchema

get

put

equals

toString

hashCode