com.gpudb.protocol

Class FilterByStringRequest

java.lang.Object

com.gpudb.protocol.FilterByStringRequest

All Implemented Interfaces:

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

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

A set of parameters for GPUdb.filterByString(FilterByStringRequest).

Calculates which objects from a table, collection, or view match a string expression for the given string columns. The options 'case_sensitive' can be used to modify the behavior for all modes except 'search'. For 'search' mode details and limitations, see Full Text Search.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FilterByStringRequest.Mode The string filtering mode to apply.
static class	FilterByStringRequest.Options Optional parameters.

Constructor Summary

Constructors

Constructor and Description
FilterByStringRequest() Constructs a FilterByStringRequest object with default parameters.
FilterByStringRequest(String tableName, String viewName, String expression, String mode, List<String> columnNames, Map<String,String> options) Constructs a FilterByStringRequest 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.
List<String>	getColumnNames()
String	getExpression()
String	getMode()
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()
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.
FilterByStringRequest	setColumnNames(List<String> columnNames)
FilterByStringRequest	setExpression(String expression)
FilterByStringRequest	setMode(String mode)
FilterByStringRequest	setOptions(Map<String,String> options)
FilterByStringRequest	setTableName(String tableName)
FilterByStringRequest	setViewName(String viewName)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

FilterByStringRequest

public FilterByStringRequest()

Constructs a FilterByStringRequest object with default parameters.

FilterByStringRequest

public FilterByStringRequest(String tableName,
                             String viewName,
                             String expression,
                             String mode,
                             List<String> columnNames,
                             Map<String,String> options)

Constructs a FilterByStringRequest object with the specified parameters.

Parameters:

tableName - Name of the table on which the filter operation will be performed. Must be an existing table, collection or view.

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

expression - The expression with which to filter the table.

mode - The string filtering mode to apply. See below for details. Supported values:

• SEARCH: Full text search query with wildcards and boolean operators. Note that for this mode, no column can be specified in columnNames; all string columns of the table that have text search enabled will be searched.
• EQUALS: Exact whole-string match (accelerated).
• CONTAINS: Partial substring match (not accelerated). If the column is a string type (non-charN) and the number of records is too large, it will return 0.
• STARTS_WITH: Strings that start with the given expression (not accelerated). If the column is a string type (non-charN) and the number of records is too large, it will return 0.
• REGEX: Full regular expression search (not accelerated). If the column is a string type (non-charN) and the number of records is too large, it will return 0.

columnNames - List of columns on which to apply the filter. Ignored for 'search' mode.

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.
• CASE_SENSITIVE: If 'false' then string filtering will ignore case. Does not apply to 'search' mode. Supported values:
  • TRUE
  • FALSE
  The default value is TRUE.

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 operation will be performed. Must be an existing table, collection or view.

setTableName

public FilterByStringRequest setTableName(String tableName)

Parameters:

tableName - Name of the table on which the filter operation will be performed. Must be an existing table, collection or view.

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

getExpression

public String getExpression()

Returns:

The expression with which to filter the table.

setExpression

public FilterByStringRequest setExpression(String expression)

Parameters:

expression - The expression with which to filter the table.

Returns:

this to mimic the builder pattern.

getMode

public String getMode()

Returns:

The string filtering mode to apply. See below for details. Supported values:

• SEARCH: Full text search query with wildcards and boolean operators. Note that for this mode, no column can be specified in columnNames; all string columns of the table that have text search enabled will be searched.
• EQUALS: Exact whole-string match (accelerated).
• CONTAINS: Partial substring match (not accelerated). If the column is a string type (non-charN) and the number of records is too large, it will return 0.
• STARTS_WITH: Strings that start with the given expression (not accelerated). If the column is a string type (non-charN) and the number of records is too large, it will return 0.
• REGEX: Full regular expression search (not accelerated). If the column is a string type (non-charN) and the number of records is too large, it will return 0.

setMode

public FilterByStringRequest setMode(String mode)

Parameters:

mode - The string filtering mode to apply. See below for details. Supported values:

• SEARCH: Full text search query with wildcards and boolean operators. Note that for this mode, no column can be specified in columnNames; all string columns of the table that have text search enabled will be searched.
• EQUALS: Exact whole-string match (accelerated).
• CONTAINS: Partial substring match (not accelerated). If the column is a string type (non-charN) and the number of records is too large, it will return 0.
• STARTS_WITH: Strings that start with the given expression (not accelerated). If the column is a string type (non-charN) and the number of records is too large, it will return 0.
• REGEX: Full regular expression search (not accelerated). If the column is a string type (non-charN) and the number of records is too large, it will return 0.

Returns:

this to mimic the builder pattern.

getColumnNames

public List<String> getColumnNames()

Returns:

List of columns on which to apply the filter. Ignored for 'search' mode.

setColumnNames

public FilterByStringRequest setColumnNames(List<String> columnNames)

Parameters:

columnNames - List of columns on which to apply the filter. Ignored for 'search' mode.

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.
• CASE_SENSITIVE: If 'false' then string filtering will ignore case. Does not apply to 'search' mode. Supported values:
  • TRUE
  • FALSE
  The default value is TRUE.

The default value is an empty Map.

setOptions

public FilterByStringRequest 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.
• CASE_SENSITIVE: If 'false' then string filtering will ignore case. Does not apply to 'search' mode. Supported values:
  • TRUE
  • FALSE
  The default value is TRUE.

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