FilterByValueRequest (Kinetica Java API 7.0.19.0 API)

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(FilterByValueRequest).
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 and Description

static class FilterByValueRequest.Options
Optional parameters.

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

Constructor Summary

Constructors
Constructor and 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

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()`
`boolean`	`getIsString()`
`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()`
`double`	`getValue()`
`String`	`getValueStr()`
`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.
`FilterByValueRequest`	`setColumnName(String columnName)`
`FilterByValueRequest`	`setIsString(boolean isString)`
`FilterByValueRequest`	`setOptions(Map<String,String> options)`
`FilterByValueRequest`	`setTableName(String tableName)`
`FilterByValueRequest`	`setValue(double value)`
`FilterByValueRequest`	`setValueStr(String valueStr)`
`FilterByValueRequest`	`setViewName(String viewName)`
`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.
    
    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 ''.
    
    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.
    
    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 an existing table on which to perform the calculation.
  - setTableName
```
public FilterByValueRequest setTableName(String tableName)
```
    Parameters:
    
    tableName - Name of an existing table on which to perform the calculation.
    
    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 FilterByValueRequest 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.
  - getIsString
```
public boolean getIsString()
```
    Returns:
    
    Indicates whether the value being searched for is string or numeric.
  - setIsString
```
public FilterByValueRequest setIsString(boolean isString)
```
    Parameters:
    
    isString - Indicates whether the value being searched for is string or numeric.
    
    Returns:
    
    this to mimic the builder pattern.
  - getValue
```
public double getValue()
```
    Returns:
    
    The value to search for. The default value is 0.
  - setValue
```
public FilterByValueRequest setValue(double value)
```
    Parameters:
    
    value - The value to search for. The default value is 0.
    
    Returns:
    
    this to mimic the builder pattern.
  - getValueStr
```
public String getValueStr()
```
    Returns:
    
    The string value to search for. The default value is ''.
  - setValueStr
```
public FilterByValueRequest setValueStr(String valueStr)
```
    Parameters:
    
    valueStr - The string value to search for. The default value is ''.
    
    Returns:
    
    this to mimic the builder pattern.
  - getColumnName
```
public String getColumnName()
```
    Returns:
    
    Name of a column on which the filter by value would be applied.
  - setColumnName
```
public FilterByValueRequest setColumnName(String columnName)
```
    Parameters:
    
    columnName - Name of a column on which the filter by value would be applied.
    
    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 FilterByValueRequest 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 FilterByValueRequest

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FilterByValueRequest

FilterByValueRequest

Method Detail

getClassSchema

getTableName

setTableName

getViewName

setViewName

getIsString

setIsString

getValue

setValue

getValueStr

setValueStr

getColumnName

setColumnName

getOptions

setOptions

getSchema

get

put

equals

toString

hashCode