FilterBySeriesRequest (Kinetica Java API 7.0.19.0 API)

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

All Implemented Interfaces:

org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord
```
public class FilterBySeriesRequest
extends Object
implements org.apache.avro.generic.IndexedRecord
```
A set of parameters for GPUdb.filterBySeries(FilterBySeriesRequest).
Filters objects matching all points of the given track (works only on track type data). It allows users to specify a particular track to find all other points in the table that fall within specified ranges-spatial and temporal-of all points of the given track. Additionally, the user can specify another track to see if the two intersect (or go close to each other within the specified ranges). The user also has the flexibility of using different metrics for the spatial distance calculation: Euclidean (flat geometry) or Great Circle (spherical geometry to approximate the Earth's surface distances). The filtered points are stored in a newly created result set. The return value of the function is the number of points in the resultant set (view).
This operation is synchronous, meaning that a response will not be returned until all the objects are fully available.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class FilterBySeriesRequest.Options
Optional parameters.

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

Constructor Summary

Constructors
Constructor and Description
`FilterBySeriesRequest()` Constructs a FilterBySeriesRequest object with default parameters.
`FilterBySeriesRequest(String tableName, String viewName, String trackId, List<String> targetTrackIds, Map<String,String> options)` Constructs a FilterBySeriesRequest 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()`
`List<String>`	`getTargetTrackIds()`
`String`	`getTrackId()`
`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.
`FilterBySeriesRequest`	`setOptions(Map<String,String> options)`
`FilterBySeriesRequest`	`setTableName(String tableName)`
`FilterBySeriesRequest`	`setTargetTrackIds(List<String> targetTrackIds)`
`FilterBySeriesRequest`	`setTrackId(String trackId)`
`FilterBySeriesRequest`	`setViewName(String viewName)`
`String`	`toString()`

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

- Constructor Detail
  - FilterBySeriesRequest
```
public FilterBySeriesRequest()
```
    Constructs a FilterBySeriesRequest object with default parameters.
  - FilterBySeriesRequest
```
public FilterBySeriesRequest(String tableName,
                             String viewName,
                             String trackId,
                             List<String> targetTrackIds,
                             Map<String,String> options)
```
    Constructs a FilterBySeriesRequest object with the specified parameters.
    Parameters:
    
    tableName - Name of the table on which the filter by track operation will be performed. Must be a currently existing table with a track present.
    
    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 ''.
    
    trackId - The ID of the track which will act as the filtering points. Must be an existing track within the given table.
    
    targetTrackIds - Up to one track ID to intersect with the "filter" track. If any provided, it must be an valid track ID within the given set.
    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.
    SPATIAL_RADIUS: A positive number passed as a string representing the radius of the search area centered around each track point's geospatial coordinates. The value is interpreted in meters. Required parameter.
    TIME_RADIUS: A positive number passed as a string representing the maximum allowable time difference between the timestamps of a filtered object and the given track's points. The value is interpreted in seconds. Required parameter.
    SPATIAL_DISTANCE_METRIC: A string representing the coordinate system to use for the spatial search criteria. Acceptable values are 'euclidean' and 'great_circle'. Optional parameter; default is 'euclidean'. Supported values:
    
    EUCLIDEAN
    GREAT_CIRCLE
    
    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 track operation will be performed. Must be a currently existing table with a track present.
  - setTableName
```
public FilterBySeriesRequest setTableName(String tableName)
```
    Parameters:
    
    tableName - Name of the table on which the filter by track operation will be performed. Must be a currently existing table with a track present.
    
    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 FilterBySeriesRequest 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.
  - getTrackId
```
public String getTrackId()
```
    Returns:
    
    The ID of the track which will act as the filtering points. Must be an existing track within the given table.
  - setTrackId
```
public FilterBySeriesRequest setTrackId(String trackId)
```
    Parameters:
    
    trackId - The ID of the track which will act as the filtering points. Must be an existing track within the given table.
    
    Returns:
    
    this to mimic the builder pattern.
  - getTargetTrackIds
```
public List<String> getTargetTrackIds()
```
    Returns:
    
    Up to one track ID to intersect with the "filter" track. If any provided, it must be an valid track ID within the given set.
  - setTargetTrackIds
```
public FilterBySeriesRequest setTargetTrackIds(List<String> targetTrackIds)
```
    Parameters:
    
    targetTrackIds - Up to one track ID to intersect with the "filter" track. If any provided, it must be an valid track ID within the given set.
    
    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.
    SPATIAL_RADIUS: A positive number passed as a string representing the radius of the search area centered around each track point's geospatial coordinates. The value is interpreted in meters. Required parameter.
    TIME_RADIUS: A positive number passed as a string representing the maximum allowable time difference between the timestamps of a filtered object and the given track's points. The value is interpreted in seconds. Required parameter.
    SPATIAL_DISTANCE_METRIC: A string representing the coordinate system to use for the spatial search criteria. Acceptable values are 'euclidean' and 'great_circle'. Optional parameter; default is 'euclidean'. Supported values:
    
    EUCLIDEAN
    GREAT_CIRCLE
    
    The default value is an empty Map.
  - setOptions
```
public FilterBySeriesRequest 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.
    SPATIAL_RADIUS: A positive number passed as a string representing the radius of the search area centered around each track point's geospatial coordinates. The value is interpreted in meters. Required parameter.
    TIME_RADIUS: A positive number passed as a string representing the maximum allowable time difference between the timestamps of a filtered object and the given track's points. The value is interpreted in seconds. Required parameter.
    SPATIAL_DISTANCE_METRIC: A string representing the coordinate system to use for the spatial search criteria. Acceptable values are 'euclidean' and 'great_circle'. Optional parameter; default is 'euclidean'. Supported values:
    
    EUCLIDEAN
    GREAT_CIRCLE
    
    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 FilterBySeriesRequest

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FilterBySeriesRequest

FilterBySeriesRequest

Method Detail

getClassSchema

getTableName

setTableName

getViewName

setViewName

getTrackId

setTrackId

getTargetTrackIds

setTargetTrackIds

getOptions

setOptions

getSchema

get

put

equals

toString

hashCode