com.gpudb.protocol

Class FilterBySeriesRequest

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.

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 A set of string constants for the FilterBySeriesRequest parameter options.

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

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() 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 track operation will be performed, in [schema_name.]table_name format, using standard	List<String>	getTargetTrackIds() Up to one track ID to intersect with the "filter" track.
String	getTrackId() The ID of the track which will act as the filtering points.
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.
FilterBySeriesRequest	setOptions(Map<String,String> options) Optional parameters.
FilterBySeriesRequest	setTableName(String tableName) Name of the table on which the filter by track operation will be performed, in [schema_name.]table_name format, using standard	FilterBySeriesRequest	setTargetTrackIds(List<String> targetTrackIds) Up to one track ID to intersect with the "filter" track.
FilterBySeriesRequest	setTrackId(String trackId) The ID of the track which will act as the filtering points.
FilterBySeriesRequest	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

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, in [schema_name.]table_name format, using standard name resolution rules. 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, 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 ''.

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.

• 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 is non-existent, it will be automatically created.
• 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. The minimum allowed value is '0'.
• 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. The minimum allowed value is '0'.
• 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()

Name of the table on which the filter by track operation will be performed, in [schema_name.]table_name format, using standard name resolution rules. Must be a currently existing table with a track present.

Returns:

The current value of tableName.

setTableName

public FilterBySeriesRequest setTableName(String tableName)

Name of the table on which the filter by track operation will be performed, in [schema_name.]table_name format, using standard name resolution rules. Must be a currently existing table with a track present.

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

getTrackId

public String getTrackId()

The ID of the track which will act as the filtering points. Must be an existing track within the given table.

Returns:

The current value of trackId.

setTrackId

public FilterBySeriesRequest setTrackId(String trackId)

The ID of the track which will act as the filtering points. Must be an existing track within the given table.

Parameters:

trackId - The new value for trackId.

Returns:

this to mimic the builder pattern.

getTargetTrackIds

public List<String> getTargetTrackIds()

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:

The current value of targetTrackIds.

setTargetTrackIds

public FilterBySeriesRequest setTargetTrackIds(List<String> 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.

Parameters:

targetTrackIds - The new value for targetTrackIds.

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 is non-existent, it will be automatically created.
• 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. The minimum allowed value is '0'.
• 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. The minimum allowed value is '0'.
• 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:

The current value of options.

setOptions

public FilterBySeriesRequest 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 is non-existent, it will be automatically created.
• 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. The minimum allowed value is '0'.
• 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. The minimum allowed value is '0'.
• 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.

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