FilterByStringRequest (Kinetica Java API 5.2.0 API)

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 'mode' may be:

* search : full text search query with wildcards and boolean operators, e.g. '(bob* OR sue) AND NOT jane'. Note that for this mode, no column can be specified in columnNames; GPUdb will search through all string columns of the table that have text search enabled. Also, the first character of a search term cannot be a wildcard (* or ?), and search terms cannot be any of the following: "a", "an", "and", "are", "as", "at", "be", "but", "by", "for", "if", "in", "into", "is", "it", "no", "not", "of", "on", "or", "such", "that", "the", "their", "then", "there", "these", "they", "this", "to", "was", "will", "with".
     Search query types:
          * Multiple search terms
               ex. perfect union - will match any record containing "perfect", "union", or both.
          * Exact phrases
               ex. "Perfect Union" - will only match the exact phrase "Perfect Union"
          * Boolean (NOT, AND, OR, parentheses. OR assumed if no operator specified)
               ex. justice AND tranquility - will match only those records containing both justice and tranquility
          * XOR (specified with -)
               ex. justice - peace - will match records containing "justice" or "peace", but not both
          * Zero or more char wildcard - (specified with *)
               ex, est*is* - will match any records containing a word that starts with "est" and ends with "sh", such as "establish", "establishable", and "establishment"
          * Exactly one char wildcard - (specified with ?)
               ex. est???is* - will only match strings that start with "est", followed by exactly three letters, followed by "is", followed by one more letter. This would only match "establish"
          * Fuzzy search (term~)
               ex. rear~ will match rear,fear,bear,read,etc.
          * Proximity - match two words within a specified distance of eachother
               ex. "Union Tranquility"~10 will match any record that has the words Union and Tranquility within 10 words of eachother
          * Range - inclusive [ TO ] and exclusive { TO }. Note: This is a string search, so numbers will be seen as a string of numeric characters, not as a number. Ex. 2 > 123
               ex. [100 TO 200] will find all strings between 100 and 200 inclusive.
               ex. {alpha to beta} will find all strings between alpha and beta, but not the words alpha or beta
          * escaping special characters - Special characters are escaped with a backslash(\), special characters are: + - && || ! ( ) { } [ ] ^ " ~ * ? : \

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

The options 'case_sensitive' can be used to modify the behavior for all modes except '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

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.
`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 a valid GPUdb table, collection or view.
    
    viewName - If provided, then this will be the name of the view containing the results. Must not be an already existing collection, table or view.
    
    expression - The expression with which to filter the table.
    
    mode - The string filtering mode to apply. See above for details. Values: search, equals, contains, starts_with, regex.
    
    columnNames - List of columns on which to apply the filter. Ignored for 'search' mode.
    options - Optional parameters.
    
    case_sensitive: If 'false' then string filtering will ignore case. Does not apply to 'search' mode. Values: true, false.
- 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 a valid GPUdb 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 a valid GPUdb 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. Must not be an already existing collection, table or view.
  - setViewName
```
public FilterByStringRequest setViewName(String viewName)
```
    Parameters:
    
    viewName - If provided, then this will be the name of the view containing the results. Must not be an already existing collection, table or view.
    
    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 above for details. Values: search, equals, contains, starts_with, regex.
  - setMode
```
public FilterByStringRequest setMode(String mode)
```
    Parameters:
    
    mode - The string filtering mode to apply. See above for details. Values: search, equals, contains, starts_with, regex.
    
    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.
    
    case_sensitive: If 'false' then string filtering will ignore case. Does not apply to 'search' mode. Values: true, false.
  - setOptions
```
public FilterByStringRequest setOptions(Map<String,String> options)
```
    Parameters:
    options - Optional parameters.
    
    case_sensitive: If 'false' then string filtering will ignore case. Does not apply to 'search' mode. Values: true, false.
    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 FilterByStringRequest

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FilterByStringRequest

FilterByStringRequest

Method Detail

getClassSchema

getTableName

setTableName

getViewName

setViewName

getExpression

setExpression

getMode

setMode

getColumnNames

setColumnNames

getOptions

setOptions

getSchema

get

put

equals

toString

hashCode