Package com.gpudb.protocol

Class FilterByValueRequest

java.lang.Object

com.gpudb.protocol.FilterByValueRequest

All Implemented Interfaces:

org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord

public class FilterByValueRequest
extends Object
implements org.apache.avro.generic.IndexedRecord

A set of parameters for GPUdb.filterByValue.

Calculates which objects from a table has a particular value for a particular column. The input parameters provide a way to specify either a String or a Double valued column and a desired value for the column on which the filter is performed. 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 result view which satisfies the input filter restriction specification is also created with a view name passed in as part of the input payload. Although this functionality can also be accomplished with the standard filter function, it is more efficient.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FilterByValueRequest.Options	A set of string constants for the FilterByValueRequest parameter options.

Constructor Summary

Constructors

Constructor	Description
FilterByValueRequest()	Constructs a FilterByValueRequest object with default parameters.
FilterByValueRequest(String tableName, String viewName, boolean isString, double value, String valueStr, String columnName, Map<String,String> options)	Constructs a FilterByValueRequest object with the specified parameters.

Method Summary

Modifier and Type	Method	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 a column on which the filter by value would be applied.
boolean	getIsString()	Indicates whether the value being searched for is string or numeric.
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 an existing table on which to perform the calculation, in [schema_name.]table_name format, using standard name resolution rules.
double	getValue()	The value to search for.
String	getValueStr()	The string value to search for.
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.
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.
FilterByValueRequest	setColumnName(String columnName)	Name of a column on which the filter by value would be applied.
FilterByValueRequest	setIsString(boolean isString)	Indicates whether the value being searched for is string or numeric.
FilterByValueRequest	setOptions(Map<String,String> options)	Optional parameters.
FilterByValueRequest	setTableName(String tableName)	Name of an existing table on which to perform the calculation, in [schema_name.]table_name format, using standard name resolution rules.
FilterByValueRequest	setValue(double value)	The value to search for.
FilterByValueRequest	setValueStr(String valueStr)	The string value to search for.
FilterByValueRequest	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.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

FilterByValueRequest

public FilterByValueRequest()

Constructs a FilterByValueRequest object with default parameters.

FilterByValueRequest

public FilterByValueRequest(String tableName,
                            String viewName,
                            boolean isString,
                            double value,
                            String valueStr,
                            String columnName,
                            Map<String,String> options)

Constructs a FilterByValueRequest object with the specified parameters.

Parameters:

tableName - Name of an existing table on which to perform the calculation, in [schema_name.]table_name format, using standard name resolution rules.

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

isString - Indicates whether the value being searched for is string or numeric.

value - The value to search for. The default value is 0.

valueStr - The string value to search for. The default value is ''.

columnName - Name of a column on which the filter by value would be applied.

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.

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 an existing table on which to perform the calculation, in [schema_name.]table_name format, using standard name resolution rules.

Returns:

The current value of tableName.

setTableName

public FilterByValueRequest setTableName(String tableName)

Name of an existing table on which to perform the calculation, in [schema_name.]table_name format, using standard name resolution rules.

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

getIsString

public boolean getIsString()

Indicates whether the value being searched for is string or numeric.

Returns:

The current value of isString.

setIsString

public FilterByValueRequest setIsString(boolean isString)

Indicates whether the value being searched for is string or numeric.

Parameters:

isString - The new value for isString.

Returns:

this to mimic the builder pattern.

getValue

public double getValue()

The value to search for. The default value is 0.

Returns:

The current value of value.

setValue

public FilterByValueRequest setValue(double value)

The value to search for. The default value is 0.

Parameters:

value - The new value for value.

Returns:

this to mimic the builder pattern.

getValueStr

public String getValueStr()

The string value to search for. The default value is ''.

Returns:

The current value of valueStr.

setValueStr

public FilterByValueRequest setValueStr(String valueStr)

The string value to search for. The default value is ''.

Parameters:

valueStr - The new value for valueStr.

Returns:

this to mimic the builder pattern.

getColumnName

public String getColumnName()

Name of a column on which the filter by value would be applied.

Returns:

The current value of columnName.

setColumnName

public FilterByValueRequest setColumnName(String columnName)

Name of a column on which the filter by value would be applied.

Parameters:

columnName - The new value for columnName.

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.

The default value is an empty Map.

Returns:

The current value of options.

setOptions

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

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