Package com.apple.foundationdb.record.query.expressions

Class QueryKeyExpression

java.lang.Object

com.apple.foundationdb.record.query.expressions.QueryKeyExpression

@API(EXPERIMENTAL)
public class QueryKeyExpression
extends Object

Allow use of a QueryableKeyExpression in a query.

Constructor Summary

Constructors

Constructor	Description
QueryKeyExpression(QueryableKeyExpression keyExpression)

Method Summary

Modifier and Type	Method	Description
QueryComponent	equalsParameter(String param)	Checks if the key expression has a value equal to the given parameter.
QueryComponent	equalsValue(Object comparand)	Checks if the key expression has a value equal to the given comparand.
QueryComponent	greaterThan(Object comparand)	Checks if the key expression has a value greater than the given comparand.
QueryComponent	greaterThanOrEquals(Object comparand)	Checks if the key expression has a value greater than or equal to the given comparand.
QueryComponent	isNull()	Returns true if the key expression evaluates to null.
QueryComponent	lessThan(Object comparand)	Checks if the key expression has a value less than the given comparand.
QueryComponent	lessThanOrEquals(Object comparand)	Checks if the key expression has a value less than or equal to the given comparand.
QueryComponent	notEquals(Object comparand)	Checks if the key expression has a value not equal to the given comparand.
QueryComponent	notNull()	Returns true if the key expression does not evaluate to null.
QueryComponent	startsWith(String comparand)	Checks if the key expression starts with the given string.

Methods inherited from class java.lang.Object

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

Constructor Detail

QueryKeyExpression

public QueryKeyExpression(@Nonnull
                          QueryableKeyExpression keyExpression)

Method Detail

equalsValue

@Nonnull
public QueryComponent equalsValue(@Nonnull
                                  Object comparand)

Checks if the key expression has a value equal to the given comparand.

Parameters:

comparand - the object to compare with the value in the field

Returns:

a new component for doing the actual evaluation

notEquals

@Nonnull
public QueryComponent notEquals(@Nonnull
                                Object comparand)

Checks if the key expression has a value not equal to the given comparand.

Parameters:

comparand - the object to compare with the value in the field

Returns:

a new component for doing the actual evaluation

greaterThan

@Nonnull
public QueryComponent greaterThan(@Nonnull
                                  Object comparand)

Checks if the key expression has a value greater than the given comparand.

Parameters:

comparand - the object to compare with the value in the field

Returns:

a new component for doing the actual evaluation

greaterThanOrEquals

@Nonnull
public QueryComponent greaterThanOrEquals(@Nonnull
                                          Object comparand)

Checks if the key expression has a value greater than or equal to the given comparand.

Parameters:

comparand - the object to compare with the value in the field

Returns:

a new component for doing the actual evaluation

lessThan

@Nonnull
public QueryComponent lessThan(@Nonnull
                               Object comparand)

Checks if the key expression has a value less than the given comparand.

Parameters:

comparand - the object to compare with the value in the field

Returns:

a new component for doing the actual evaluation

lessThanOrEquals

@Nonnull
public QueryComponent lessThanOrEquals(@Nonnull
                                       Object comparand)

Checks if the key expression has a value less than or equal to the given comparand. Evaluates to null if the field does not have a value.

Parameters:

comparand - the object to compare with the value in the field

Returns:

a new component for doing the actual evaluation

startsWith

@Nonnull
public QueryComponent startsWith(@Nonnull
                                 String comparand)

Checks if the key expression starts with the given string.

Parameters:

comparand - the object to compare with the value in the field

Returns:

a new component for doing the actual evaluation

isNull

@Nonnull
public QueryComponent isNull()

Returns true if the key expression evaluates to null.

Returns:

a new component for doing the actual evaluation

notNull

@Nonnull
public QueryComponent notNull()

Returns true if the key expression does not evaluate to null.

Returns:

a new component for doing the actual evaluation

equalsParameter

@Nonnull
public QueryComponent equalsParameter(@Nonnull
                                      String param)

Checks if the key expression has a value equal to the given parameter.

Parameters:

param - the name of the parameter

Returns:

a new component for doing the actual evaluation