java.lang.Object

com.mysql.cj.xdevapi.AbstractFilterParams

All Implemented Interfaces:: FilterParams

Direct Known Subclasses:: DocFilterParams, TableFilterParams

public abstract class AbstractFilterParams
extends java.lang.Object
implements FilterParams

Abstract implementation of FilterParams.

Nested Class Summary

Nested classes/interfaces inherited from interface com.mysql.cj.xdevapi.FilterParams
FilterParams.RowLock, FilterParams.RowLockOptions

Field Summary

Fields
Modifier and Type	Field	Description
`protected MysqlxDatatypes.Scalar[]`	`args`
`protected MysqlxCrud.Collection`	`collection`
`protected java.lang.String`	`criteriaStr`
`protected java.util.List<MysqlxCrud.Projection>`	`fields`
`protected java.lang.String[]`	`groupBy`
`protected boolean`	`isRelational`
`protected java.lang.Long`	`limit`
`protected FilterParams.RowLock`	`lock`
`protected FilterParams.RowLockOptions`	`lockOption`
`protected java.lang.Long`	`offset`
`protected java.lang.String[]`	`orderExpr`
`protected java.lang.String[]`	`projection`
`protected boolean`	`supportsOffset`

Constructor Summary

Constructors

Constructor Description

AbstractFilterParams(java.lang.String schemaName, java.lang.String collectionName, boolean supportsOffset, boolean isRelational)
Constructor.

Method Summary

Modifier and Type	Method	Description
`void`	`addArg(java.lang.String name, java.lang.Object value)`	Set binding.
`void`	`clearArgs()`	Remove all current bindings.
`java.lang.Object`	`getArgs()`	Get binding arguments.
`java.lang.Object`	`getCollection()`	Get X Protocol Collection object.
`java.lang.Object`	`getCriteria()`	Get the search criteria.
`java.lang.Object`	`getFields()`	Get X Protocol Projection objects.
`java.lang.Object`	`getGrouping()`	Get X Protocol Expr objects for groupBy.
`java.lang.Object`	`getGroupingCriteria()`	Get X Protocol Expr objects for grouping criteria.
`java.lang.Long`	`getLimit()`	Get max number of rows to filter.
`FilterParams.RowLock`	`getLock()`	Get `FilterParams.RowLock` value.
`FilterParams.RowLockOptions`	`getLockOption()`	Get `FilterParams.RowLockOptions` value.
`java.lang.Long`	`getOffset()`	Get number of rows to skip before finding others.
`java.lang.Object`	`getOrder()`	Get X Protocol Order objects.
`boolean`	`isRelational()`	Are relational columns identifiers allowed?
`void`	`setCriteria(java.lang.String criteriaString)`	Parse criteriaString into X Protocol Expr object.
`abstract void`	`setFields(java.lang.String... projection)`	Parse projection expressions into X Protocol Projection objects.
`void`	`setGrouping(java.lang.String... groupBy)`	Parse groupBy expressions into X Protocol Expr objects.
`void`	`setGroupingCriteria(java.lang.String having)`	Parse having expressions into X Protocol Expr objects.
`void`	`setLimit(java.lang.Long limit)`	Set maximum rows to find.
`void`	`setLock(FilterParams.RowLock rowLock)`	Set `FilterParams.RowLock` value.
`void`	`setLockOption(FilterParams.RowLockOptions lockOption)`	Set `FilterParams.RowLockOptions` value.
`void`	`setOffset(java.lang.Long offset)`	Set number of rows to skip before finding others.
`void`	`setOrder(java.lang.String... orderExpression)`	Parse order expressions into X Protocol Order objects.
`boolean`	`supportsOffset()`	Whether offset clause is supported in the statement or not.
`void`	`verifyAllArgsBound()`	Verify that all arguments are bound.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details
- collection
  
  protected MysqlxCrud.Collection collection
- limit
  
  protected java.lang.Long limit
- offset
  
  protected java.lang.Long offset
- supportsOffset
  
  protected boolean supportsOffset
- orderExpr
  
  protected java.lang.String[] orderExpr
- criteriaStr
  
  protected java.lang.String criteriaStr
- args
  
  protected MysqlxDatatypes.Scalar[] args
- isRelational
  
  protected boolean isRelational
- groupBy
  
  protected java.lang.String[] groupBy
- projection
  
  protected java.lang.String[] projection
- fields
  
  protected java.util.List<MysqlxCrud.Projection> fields
- lock
  
  protected FilterParams.RowLock lock
- lockOption
  
  protected FilterParams.RowLockOptions lockOption
Constructor Details
- AbstractFilterParams
  
  public AbstractFilterParams(java.lang.String schemaName, java.lang.String collectionName, boolean supportsOffset, boolean isRelational)
  
  Constructor.
  
  Parameters:
  
  schemaName - Schema name
  
  collectionName - Collection name
  
  supportsOffset - Whether offset is supported or not
  
  isRelational - Are relational columns identifiers allowed?
Method Details
- getCollection
  
  public java.lang.Object getCollection()
  
  Description copied from interface: FilterParams
  
  Get X Protocol Collection object.
  
  Specified by:
  
  getCollection in interface FilterParams
  
  Returns:
  
  X Protocol Collection object
- getOrder
  
  public java.lang.Object getOrder()
  
  Description copied from interface: FilterParams
  
  Get X Protocol Order objects.
  
  Specified by:
  
  getOrder in interface FilterParams
  
  Returns:
  
  List of X Protocol Order objects
- setOrder
  
  public void setOrder(java.lang.String... orderExpression)
  
  Description copied from interface: FilterParams
  Parse order expressions into X Protocol Order objects.
  DocResult docs = this.collection.find().orderBy("$._id").execute(); docs = this.collection.find().sort("$.x", "$.y").execute();
  Specified by:
  
  setOrder in interface FilterParams
  
  Parameters:
  
  orderExpression - order expressions
- getLimit
  
  public java.lang.Long getLimit()
  
  Description copied from interface: FilterParams
  
  Get max number of rows to filter.
  
  Specified by:
  
  getLimit in interface FilterParams
  
  Returns:
  
  limit
- setLimit
  
  public void setLimit(java.lang.Long limit)
  
  Description copied from interface: FilterParams
  Set maximum rows to find.
  For example, to find the 3 first rows:
  
  docs = this.collection.find().orderBy("$._id").limit(3).execute();
  Specified by:
  
  setLimit in interface FilterParams
  
  Parameters:
  
  limit - maximum rows to find
- getOffset
  
  public java.lang.Long getOffset()
  
  Description copied from interface: FilterParams
  
  Get number of rows to skip before finding others.
  
  Specified by:
  
  getOffset in interface FilterParams
  
  Returns:
  
  maximum rows to skip
- setOffset
  
  public void setOffset(java.lang.Long offset)
  
  Description copied from interface: FilterParams
  Set number of rows to skip before finding others.
  For example, to skip 1 row and find other 3 rows:
  
  docs = this.collection.find().orderBy("$._id").limit(3).skip(1).execute();
  Specified by:
  
  setOffset in interface FilterParams
  
  Parameters:
  
  offset - maximum rows to skip
- supportsOffset
  
  public boolean supportsOffset()
  
  Description copied from interface: FilterParams
  
  Whether offset clause is supported in the statement or not.
  Note that setting offset values is always possible, even if they are not supported.
  
  Specified by:
  
  supportsOffset in interface FilterParams
  
  Returns:
  
  true if offset clause is supported
- getCriteria
  
  public java.lang.Object getCriteria()
  
  Description copied from interface: FilterParams
  
  Get the search criteria.
  
  Specified by:
  
  getCriteria in interface FilterParams
  
  Returns:
  
  X Protocol Expr object
- setCriteria
  
  public void setCriteria(java.lang.String criteriaString)
  
  Description copied from interface: FilterParams
  Parse criteriaString into X Protocol Expr object.
  docs = this.collection.find("$.x1 = 29 | 15").execute(); table.delete().where("age == 13").execute();
  Specified by:
  
  setCriteria in interface FilterParams
  
  Parameters:
  
  criteriaString - expression
- getArgs
  
  public java.lang.Object getArgs()
  
  Description copied from interface: FilterParams
  
  Get binding arguments.
  
  Specified by:
  
  getArgs in interface FilterParams
  
  Returns:
  
  List of X Protocol Scalar object
- addArg
  
  public void addArg(java.lang.String name, java.lang.Object value)
  
  Description copied from interface: FilterParams
  Set binding.
  this.collection.find("a = :arg1 or b = :arg2").bind("arg1", 1).bind("arg2", 2).execute();
  Specified by:
  
  addArg in interface FilterParams
  
  Parameters:
  
  name - bind key
  
  value - bind value
- verifyAllArgsBound
  
  public void verifyAllArgsBound()
  
  Description copied from interface: FilterParams
  
  Verify that all arguments are bound. Throws WrongArgumentException if any placeholder argument is not bound.
  
  Specified by:
  
  verifyAllArgsBound in interface FilterParams
- clearArgs
  
  public void clearArgs()
  
  Description copied from interface: FilterParams
  
  Remove all current bindings.
  
  Specified by:
  
  clearArgs in interface FilterParams
- isRelational
  
  public boolean isRelational()
  
  Description copied from interface: FilterParams
  
  Are relational columns identifiers allowed?
  
  Specified by:
  
  isRelational in interface FilterParams
  
  Returns:
  
  true if allowed
- setFields
  
  public abstract void setFields(java.lang.String... projection)
  
  Description copied from interface: FilterParams
  Parse projection expressions into X Protocol Projection objects.
  collection.find().fields("CAST($.x as SIGNED) as x").execute(); table.select("_id, name, birthday, age").execute(); table.select("age as age_group, count(name) as cnt, something").execute();
  Specified by:
  
  setFields in interface FilterParams
  
  Parameters:
  
  projection - projection expression
- getFields
  
  public java.lang.Object getFields()
  
  Description copied from interface: FilterParams
  
  Get X Protocol Projection objects.
  
  Specified by:
  
  getFields in interface FilterParams
  
  Returns:
  
  List of X Protocol Projection objects.
- setGrouping
  
  public void setGrouping(java.lang.String... groupBy)
  
  Description copied from interface: FilterParams
  Parse groupBy expressions into X Protocol Expr objects.
  SelectStatement stmt = table.select("age as age_group, count(name) as cnt, something"); stmt.groupBy("something", "age_group");
  Specified by:
  
  setGrouping in interface FilterParams
  
  Parameters:
  
  groupBy - groupBy expression
- getGrouping
  
  public java.lang.Object getGrouping()
  
  Description copied from interface: FilterParams
  
  Get X Protocol Expr objects for groupBy.
  
  Specified by:
  
  getGrouping in interface FilterParams
  
  Returns:
  
  List of X Protocol Expr objects
- setGroupingCriteria
  
  public void setGroupingCriteria(java.lang.String having)
  
  Description copied from interface: FilterParams
  Parse having expressions into X Protocol Expr objects.
  SelectStatement stmt = table.select("age as age_group, count(name) as cnt, something"); stmt.groupBy("something", "age_group"); stmt.having("cnt > 1");
  Specified by:
  
  setGroupingCriteria in interface FilterParams
  
  Parameters:
  
  having - having expression
- getGroupingCriteria
  
  public java.lang.Object getGroupingCriteria()
  
  Description copied from interface: FilterParams
  
  Get X Protocol Expr objects for grouping criteria.
  
  Specified by:
  
  getGroupingCriteria in interface FilterParams
  
  Returns:
  
  List of X Protocol Expr objects
- getLock
  
  public FilterParams.RowLock getLock()
  
  Description copied from interface: FilterParams
  
  Get FilterParams.RowLock value.
  
  Specified by:
  
  getLock in interface FilterParams
  
  Returns:
  
  FilterParams.RowLock
- setLock
  
  public void setLock(FilterParams.RowLock rowLock)
  
  Description copied from interface: FilterParams
  
  Set FilterParams.RowLock value.
  
  Specified by:
  
  setLock in interface FilterParams
  
  Parameters:
  
  rowLock - FilterParams.RowLock
- getLockOption
  
  public FilterParams.RowLockOptions getLockOption()
  
  Description copied from interface: FilterParams
  
  Get FilterParams.RowLockOptions value.
  
  Specified by:
  
  getLockOption in interface FilterParams
  
  Returns:
  
  FilterParams.RowLockOptions
- setLockOption
  
  public void setLockOption(FilterParams.RowLockOptions lockOption)
  
  Description copied from interface: FilterParams
  
  Set FilterParams.RowLockOptions value.
  
  Specified by:
  
  setLockOption in interface FilterParams
  
  Parameters:
  
  lockOption - FilterParams.RowLockOptions

Class AbstractFilterParams

Nested Class Summary

Nested classes/interfaces inherited from interface com.mysql.cj.xdevapi.FilterParams

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Details

Constructor Details

Method Details