SingleColumnValueFilter (AliCloud TableStore SDK for Java 5.17.7 API)

java.lang.Object
- com.alicloud.openservices.tablestore.model.filter.ColumnValueFilter
- - com.alicloud.openservices.tablestore.model.filter.SingleColumnValueFilter

所有已实现的接口:

Filter
```
public class SingleColumnValueFilter
extends ColumnValueFilter
```
TableStore filter used during query operations. SingleColumnValueFilter is used to represent the comparison relationship between a data column and its value within the queried row.
Possible column-value comparison relationships include: EQUAL(=), NOT_EQUAL(!=), GREATER_THAN(>), GREATER_EQUAL(>=), LESS_THAN(<), and LESS_EQUAL(<=).

Since the attribute columns in a TableStore row are not fixed, it's possible that a column specified in the filter condition may not exist in that row. In such cases, the passIfMissing parameter controls the filtering result for that row.
If passIfMissing is set to true, then if the column does not exist in the row, the row will be returned; If passIfMissing is set to false, then if the column does not exist in the row, the row will not be returned. The default value is true.
Since TableStore attribute columns may have multiple versions, there might be cases where one version of the column matches the given value while another version does not.
In such cases, the latestVersionsOnly parameter controls the filtering result for that row. If latestVersionsOnly is set to true, only the latest version of the value will be compared. Otherwise, all versions (the latest max_versions) of the column will be compared, and if any version matches, the condition is considered satisfied. The default value is true.

嵌套类概要

嵌套类
限定符和类型类和说明

static class SingleColumnValueFilter.CompareOperator

嵌套类
限定符和类型	类和说明
`static class`	`SingleColumnValueFilter.CompareOperator`

构造器概要

构造器
构造器和说明
`SingleColumnValueFilter(String columnName, SingleColumnValueFilter.CompareOperator operator, ColumnValue columnValue)` Constructor.

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`String`	`getColumnName()` Get the column name.
`ColumnValue`	`getColumnValue()` Get the comparison value of the column.
`FilterType`	`getFilterType()`
`SingleColumnValueFilter.CompareOperator`	`getOperator()` Get the comparison operator for the column.
`boolean`	`isLatestVersionsOnly()` Returns the value of the set latestVersionsOnly.
`boolean`	`isPassIfMissing()` Returns the value of the set passIfMissing.
`com.aliyun.ots.thirdparty.com.google.protobuf.ByteString`	`serialize()`
`SingleColumnValueFilter`	`setColumnName(String columnName)` Sets the name of the column.
`SingleColumnValueFilter`	`setColumnValue(ColumnValue columnValue)` Sets the comparison value for the column.
`SingleColumnValueFilter`	`setLatestVersionsOnly(boolean latestVersionsOnly)` Set latestVersionsOnly.
`SingleColumnValueFilter`	`setOperator(SingleColumnValueFilter.CompareOperator operator)` Sets the column comparison operator.
`SingleColumnValueFilter`	`setPassIfMissing(boolean passIfMissing)` Set passIfMissing.
`SingleColumnValueCondition`	`toCondition()`

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - SingleColumnValueFilter
```
public SingleColumnValueFilter(String columnName,
                               SingleColumnValueFilter.CompareOperator operator,
                               ColumnValue columnValue)
```
    Constructor.
    
    参数:
    
    columnName - The name of the column
    
    operator - The comparison function
    
    columnValue - The value of the column
- 方法详细资料
  - getOperator
```
public SingleColumnValueFilter.CompareOperator getOperator()
```
    Get the comparison operator for the column.
    
    返回:
    
    The comparison operator.
  - setOperator
```
public SingleColumnValueFilter setOperator(SingleColumnValueFilter.CompareOperator operator)
```
    Sets the column comparison operator.
    
    参数:
    
    operator - The comparison operator
    
    返回:
    
    this for chain invocation
  - getColumnName
```
public String getColumnName()
```
    Get the column name.
    
    返回:
    
    The name of the column.
  - setColumnName
```
public SingleColumnValueFilter setColumnName(String columnName)
```
    Sets the name of the column.
    
    参数:
    
    columnName - the name of the column
    
    返回:
    
    this for chain invocation
  - getColumnValue
```
public ColumnValue getColumnValue()
```
    Get the comparison value of the column.
    
    返回:
    
    The comparison value of the column.
  - setColumnValue
```
public SingleColumnValueFilter setColumnValue(ColumnValue columnValue)
```
    Sets the comparison value for the column.
    
    参数:
    
    columnValue - The comparison value for the column.
    
    返回:
    
    this for chain invocation
  - isPassIfMissing
```
public boolean isPassIfMissing()
```
    Returns the value of the set passIfMissing.
    
    返回:
    
    The value of passIfMissing.
  - setPassIfMissing
```
public SingleColumnValueFilter setPassIfMissing(boolean passIfMissing)
```
    Set passIfMissing.
    Since the attribute columns of a row in TableStore are not fixed, there might be cases where the column with a filter condition does not exist in that row. In such cases, the passIfMissing parameter controls the filtering result for that row.
    
    If passIfMissing is set to true, the row will be returned if the column does not exist in that row;
    
    If passIfMissing is set to false, the row will not be returned if the column does not exist in that row.
    
    The default value is true.
    
    参数:
    
    passIfMissing -
    
    返回:
    
    this for chain invocation
  - isLatestVersionsOnly
```
public boolean isLatestVersionsOnly()
```
    Returns the value of the set latestVersionsOnly.
    
    返回:
    
    The value of latestVersionsOnly.
  - setLatestVersionsOnly
```
public SingleColumnValueFilter setLatestVersionsOnly(boolean latestVersionsOnly)
```
    Set latestVersionsOnly.
    Since property columns in TableStore may have multiple versions, there might be cases where one version's value matches the given value while another version's does not,
    at this point, the latestVersionsOnly parameter controls the filtering result for such cases.
    If latestVersionsOnly is set to true, only the latest version will be compared. Otherwise, all versions (the latest max_versions) of that column will be compared,
    
    and if any version matches, the filter condition is considered met. The default value is true.
    
    参数:
    
    latestVersionsOnly -
    
    返回:
  - toCondition
```
public SingleColumnValueCondition toCondition()
```
  - getFilterType
```
public FilterType getFilterType()
```
  - serialize
```
public com.aliyun.ots.thirdparty.com.google.protobuf.ByteString serialize()
```

类 SingleColumnValueFilter

嵌套类概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

SingleColumnValueFilter

方法详细资料

getOperator

setOperator

getColumnName

setColumnName

getColumnValue

setColumnValue

isPassIfMissing

setPassIfMissing

isLatestVersionsOnly

setLatestVersionsOnly

toCondition

getFilterType

serialize