SpacePredicates (GigaSpaces XAP 14.5.0 API)

java.lang.Object
- com.gigaspaces.internal.query.predicate.SpacePredicates

```
public class SpacePredicates
extends Object
```
Provides methods to easier usage of built-in space predicates.

Since:

7.1

Author:

Niv Ingberg

Field Summary

Fields
Modifier and Type	Field and Description
`static FalseSpacePredicate`	`FALSE`
`static NotNullSpacePredicate`	`NOT_NULL`
`static NullSpacePredicate`	`NULL`
`static TrueSpacePredicate`	`TRUE`

Constructor Summary

Constructors
Constructor and Description

SpacePredicates()

Constructors
Constructor and Description
`SpacePredicates()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static AllSpacePredicate`	`all(ISpacePredicate... predicates)` Creates an ALL predicate wrapping the specified predicates.
`static AndSpacePredicate`	`and(ISpacePredicate leftPredicate, ISpacePredicate rightPredicate)` Creates an AND predicate wrapping the specified predicates.
`static AnySpacePredicate`	`any(ISpacePredicate... predicates)` Creates an ANY predicate wrapping the specified predicates.
`static BetweenSpacePredicate`	`between(Comparable<?> low, Comparable<?> high)` Creates a BETWEEN predicate using the specified expected values.
`static EqualsSpacePredicate`	`equal(Object value)` Creates an EQUALS predicate using the specified expected value.
`static GreaterSpacePredicate`	`greater(Comparable<?> value)` Creates a GREATER predicate using the specified expected value.
`static GreaterEqualsSpacePredicate`	`greaterEqual(Comparable<?> value)` Creates a GREATER-EQUALS predicate using the specified expected value.
`static InSpacePredicate`	`in(Object... values)` Creates an IN predicate using the specified expected values.
`static NotNullSpacePredicate`	`isNotNull()` Creates an IS NOT NULL predicate.
`static NullSpacePredicate`	`isNull()` Creates an IS NULL predicate.
`static LessSpacePredicate`	`less(Comparable<?> value)` Creates a LESS predicate using the specified expected value.
`static LessEqualsSpacePredicate`	`lessEqual(Comparable<?> value)` Creates a LESS-EQUALS predicate using the specified expected value.
`static NotSpacePredicate`	`not(ISpacePredicate predicate)` Creates a NOT predicate wrapping the specified predicate.
`static NotEqualsSpacePredicate`	`notEqual(Object value)` Creates a NOT EQUALS predicate using the specified expected value.
`static OrSpacePredicate`	`or(ISpacePredicate leftPredicate, ISpacePredicate rightPredicate)` Creates an OR predicate wrapping the specified predicates.
`static ValueGetterSpacePredicate<ServerEntry>`	`path(String path, ISpacePredicate predicate)` Creates a predicate to get a property value and test it with another predicate.
`static ValueGetterSpacePredicate<ServerEntry>`	`pathAll(String path, ISpacePredicate... predicates)` Shortcut for path(path, all(predicates)).
`static ValueGetterSpacePredicate<ServerEntry>`	`pathAnd(String path, ISpacePredicate leftPredicate, ISpacePredicate rightPredicate)` Shortcut for path(path, and(leftPredicate, rightPredicate)).
`static ValueGetterSpacePredicate<ServerEntry>`	`pathAny(String path, ISpacePredicate... predicates)` Shortcut for path(path, any(predicates)).
`static ValueGetterSpacePredicate<ServerEntry>`	`pathBetween(String path, Comparable<?> low, Comparable<?> high)` Shortcut for path(path, between(low, high)).
`static ValueGetterSpacePredicate<ServerEntry>`	`pathEqual(String path, Object value)` Shortcut for path(path, equal(value)).
`static ValueGetterSpacePredicate<ServerEntry>`	`pathGreater(String path, Comparable<?> value)` Shortcut for path(path, greater(value)).
`static ValueGetterSpacePredicate<ServerEntry>`	`pathGreaterEqual(String path, Comparable<?> value)` Shortcut for path(path, greaterEqual(value)).
`static ValueGetterSpacePredicate<ServerEntry>`	`pathIn(String path, Object... values)` Shortcut for path(path, in(values)).
`static ValueGetterSpacePredicate<ServerEntry>`	`pathLess(String path, Comparable<?> value)` Shortcut for path(path, less(value)).
`static ValueGetterSpacePredicate<ServerEntry>`	`pathLessEqual(String path, Comparable<?> value)` Shortcut for path(path, lessEqual(value)).
`static ValueGetterSpacePredicate<ServerEntry>`	`pathNot(String path, ISpacePredicate predicate)` Shortcut for path(path, not(predicate)).
`static ValueGetterSpacePredicate<ServerEntry>`	`pathNotEqual(String path, Object value)` Shortcut for path(path, notEqual(value)).
`static ValueGetterSpacePredicate<ServerEntry>`	`pathNotNull(String path)` Shortcut for path(path, isNotNull()).
`static ValueGetterSpacePredicate<ServerEntry>`	`pathNull(String path)` Shortcut for path(path, isNull()).
`static ValueGetterSpacePredicate<ServerEntry>`	`pathOr(String path, ISpacePredicate leftPredicate, ISpacePredicate rightPredicate)` Shortcut for path(path, or(leftPredicate, rightPredicate)).
`static ValueGetterSpacePredicate<ServerEntry>`	`pathXor(String path, ISpacePredicate leftPredicate, ISpacePredicate rightPredicate)` Shortcut for path(path, xor(leftPredicate, rightPredicate)).
`static ValueGetterSpacePredicate<ServerEntry>`	`property(String propertyName, ISpacePredicate predicate)` Creates a predicate to get a property value and test it with another predicate.
`static ValueGetterSpacePredicate<ServerEntry>`	`propertyAll(String propertyName, ISpacePredicate... predicates)` Shortcut for property(propertyName, all(predicates)).
`static ValueGetterSpacePredicate<ServerEntry>`	`propertyAnd(String propertyName, ISpacePredicate leftPredicate, ISpacePredicate rightPredicate)` Shortcut for property(propertyName, and(leftPredicate, rightPredicate)).
`static ValueGetterSpacePredicate<ServerEntry>`	`propertyAny(String propertyName, ISpacePredicate... predicates)` Shortcut for property(propertyName, any(predicates)).
`static ValueGetterSpacePredicate<ServerEntry>`	`propertyBetween(String propertyName, Comparable<?> low, Comparable<?> high)` Shortcut for property(propertyName, between(low, high)).
`static ValueGetterSpacePredicate<ServerEntry>`	`propertyEqual(String propertyName, Object value)` Shortcut for property(propertyName, equal(value)).
`static ValueGetterSpacePredicate<ServerEntry>`	`propertyGreater(String propertyName, Comparable<?> value)` Shortcut for property(propertyName, greater(value)).
`static ValueGetterSpacePredicate<ServerEntry>`	`propertyGreaterEqual(String propertyName, Comparable<?> value)` Shortcut for property(propertyName, greaterEqual(value)).
`static ValueGetterSpacePredicate<ServerEntry>`	`propertyIn(String propertyName, Object... values)` Shortcut for property(propertyName, in(values)).
`static ValueGetterSpacePredicate<ServerEntry>`	`propertyLess(String propertyName, Comparable<?> value)` Shortcut for property(propertyName, less(value)).
`static ValueGetterSpacePredicate<ServerEntry>`	`propertyLessEqual(String propertyName, Comparable<?> value)` Shortcut for property(propertyName, lessEqual(value)).
`static ValueGetterSpacePredicate<ServerEntry>`	`propertyNot(String propertyName, ISpacePredicate predicate)` Shortcut for property(propertyName, not(predicate)).
`static ValueGetterSpacePredicate<ServerEntry>`	`propertyNotEqual(String propertyName, Object value)` Shortcut for property(propertyName, notEqual(value)).
`static ValueGetterSpacePredicate<ServerEntry>`	`propertyNotNull(String propertyName)` Shortcut for property(propertyName, isNotNull()).
`static ValueGetterSpacePredicate<ServerEntry>`	`propertyNull(String propertyName)` Shortcut for property(propertyName, isNull()).
`static ValueGetterSpacePredicate<ServerEntry>`	`propertyOr(String propertyName, ISpacePredicate leftPredicate, ISpacePredicate rightPredicate)` Shortcut for property(propertyName, or(leftPredicate, rightPredicate)).
`static ValueGetterSpacePredicate<ServerEntry>`	`propertyXor(String propertyName, ISpacePredicate leftPredicate, ISpacePredicate rightPredicate)` Shortcut for property(propertyName, xor(leftPredicate, rightPredicate)).
`static RegexSpacePredicate`	`regex(String pattern)` Creates a REGEX predicate using the specified expected value.
`static XorSpacePredicate`	`xor(ISpacePredicate leftPredicate, ISpacePredicate rightPredicate)` Creates an XOR predicate wrapping the specified predicates.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

FALSE

public static final FalseSpacePredicate FALSE

TRUE

public static final TrueSpacePredicate TRUE

NULL

public static final NullSpacePredicate NULL

NOT_NULL

public static final NotNullSpacePredicate NOT_NULL

Constructor Detail
- SpacePredicates
```
public SpacePredicates()
```

Method Detail

not
```
public static NotSpacePredicate not(ISpacePredicate predicate)
```
Creates a NOT predicate wrapping the specified predicate.

Parameters:

predicate - Predicate to wrap.

Returns:

A not predicate wrapping the specified predicate.

and
```
public static AndSpacePredicate and(ISpacePredicate leftPredicate,
                                    ISpacePredicate rightPredicate)
```
Creates an AND predicate wrapping the specified predicates.

Parameters:

leftPredicate - Left operand of AND.

rightPredicate - Right operand of AND.

Returns:

AND predicate wrapping the specified predicates.

or
```
public static OrSpacePredicate or(ISpacePredicate leftPredicate,
                                  ISpacePredicate rightPredicate)
```
Creates an OR predicate wrapping the specified predicates.

Parameters:

leftPredicate - Left operand of OR.

rightPredicate - Right operand of OR.

Returns:

OR predicate wrapping the specified predicates.

xor
```
public static XorSpacePredicate xor(ISpacePredicate leftPredicate,
                                    ISpacePredicate rightPredicate)
```
Creates an XOR predicate wrapping the specified predicates.

Parameters:

leftPredicate - Left operand of XOR.

rightPredicate - Right operand of XOR.

Returns:

XOR predicate wrapping the specified predicates.

all
```
public static AllSpacePredicate all(ISpacePredicate... predicates)
```
Creates an ALL predicate wrapping the specified predicates.

Parameters:

predicates - Predicates to wrap in ALL.

Returns:

ALL predicate wrapping specified predicates.

any
```
public static AnySpacePredicate any(ISpacePredicate... predicates)
```
Creates an ANY predicate wrapping the specified predicates.

Parameters:

predicates - Predicates to wrap in ANY.

Returns:

ANY predicate wrapping specified predicates.

isNull
```
public static NullSpacePredicate isNull()
```
Creates an IS NULL predicate.

Returns:

IS NULL predicate.

isNotNull
```
public static NotNullSpacePredicate isNotNull()
```
Creates an IS NOT NULL predicate.

Returns:

IS NOT NULL predicate.

equal
```
public static EqualsSpacePredicate equal(Object value)
```
Creates an EQUALS predicate using the specified expected value.

Parameters:

value - Expected value for EQUALS predicate.

Returns:

EQUALS predicate with specified expected value.

notEqual
```
public static NotEqualsSpacePredicate notEqual(Object value)
```
Creates a NOT EQUALS predicate using the specified expected value.

Parameters:

value - Expected value for NOT EQUALS predicate.

Returns:

NOT EQUALS predicate with specified expected value.

greater
```
public static GreaterSpacePredicate greater(Comparable<?> value)
```
Creates a GREATER predicate using the specified expected value.

Parameters:

value - Expected value for GREATER predicate.

Returns:

GREATER predicate with specified expected value.

greaterEqual
```
public static GreaterEqualsSpacePredicate greaterEqual(Comparable<?> value)
```
Creates a GREATER-EQUALS predicate using the specified expected value.

Parameters:

value - Expected value for GREATER-EQUALS predicate.

Returns:

GREATER-EQUALS predicate with specified expected value.

less
```
public static LessSpacePredicate less(Comparable<?> value)
```
Creates a LESS predicate using the specified expected value.

Parameters:

value - Expected value for LESS predicate.

Returns:

LESS predicate with specified expected value.

lessEqual
```
public static LessEqualsSpacePredicate lessEqual(Comparable<?> value)
```
Creates a LESS-EQUALS predicate using the specified expected value.

Parameters:

value - Expected value for LESS-EQUALS predicate.

Returns:

LESS-EQUALS predicate with specified expected value.

between
```
public static BetweenSpacePredicate between(Comparable<?> low,
                                            Comparable<?> high)
```
Creates a BETWEEN predicate using the specified expected values.

Parameters:

low - Expected low value for BETWEEN predicate.

high - Expected high value for BETWEEN predicate.

Returns:

BETWEEN predicate with specified expected values.

in
```
public static InSpacePredicate in(Object... values)
```
Creates an IN predicate using the specified expected values.

Parameters:

values - Expected values for IN predicate.

Returns:

IN predicate with specified expected values.

regex
```
public static RegexSpacePredicate regex(String pattern)
```
Creates a REGEX predicate using the specified expected value.

Parameters:

pattern - Expected value for REGEX predicate.

Returns:

REGEX predicate with specified expected value.

property

public static ValueGetterSpacePredicate<ServerEntry> property(String propertyName,
                                                              ISpacePredicate predicate)

Creates a predicate to get a property value and test it with another predicate.

Parameters:: propertyName - Property to test.; predicate - Predicate to apply on property.
Returns:: Property predicate.

propertyNull
```
public static ValueGetterSpacePredicate<ServerEntry> propertyNull(String propertyName)
```
Shortcut for property(propertyName, isNull()).

Parameters:

propertyName - Name of property.

propertyNotNull
```
public static ValueGetterSpacePredicate<ServerEntry> propertyNotNull(String propertyName)
```
Shortcut for property(propertyName, isNotNull()).

Parameters:

propertyName - Name of property.

propertyNot

public static ValueGetterSpacePredicate<ServerEntry> propertyNot(String propertyName,
                                                                 ISpacePredicate predicate)

Shortcut for property(propertyName, not(predicate)).

Parameters:: propertyName - Name of property.; predicate - predicate for not.

propertyAnd

public static ValueGetterSpacePredicate<ServerEntry> propertyAnd(String propertyName,
                                                                 ISpacePredicate leftPredicate,
                                                                 ISpacePredicate rightPredicate)

Shortcut for property(propertyName, and(leftPredicate, rightPredicate)).

Parameters:: propertyName - Name of property.; leftPredicate - leftPredicate for and.; rightPredicate - rightPredicate for and.

propertyXor

public static ValueGetterSpacePredicate<ServerEntry> propertyXor(String propertyName,
                                                                 ISpacePredicate leftPredicate,
                                                                 ISpacePredicate rightPredicate)

Shortcut for property(propertyName, xor(leftPredicate, rightPredicate)).

Parameters:: propertyName - Name of property.; leftPredicate - leftPredicate for xor.; rightPredicate - rightPredicate for xor.

propertyOr

public static ValueGetterSpacePredicate<ServerEntry> propertyOr(String propertyName,
                                                                ISpacePredicate leftPredicate,
                                                                ISpacePredicate rightPredicate)

Shortcut for property(propertyName, or(leftPredicate, rightPredicate)).

Parameters:: propertyName - Name of property.; leftPredicate - leftPredicate for or.; rightPredicate - rightPredicate for or.

propertyAll

public static ValueGetterSpacePredicate<ServerEntry> propertyAll(String propertyName,
                                                                 ISpacePredicate... predicates)

Shortcut for property(propertyName, all(predicates)).

Parameters:: propertyName - Name of property.; predicates - predicates for all.

propertyAny

public static ValueGetterSpacePredicate<ServerEntry> propertyAny(String propertyName,
                                                                 ISpacePredicate... predicates)

Shortcut for property(propertyName, any(predicates)).

Parameters:: propertyName - Name of property.; predicates - predicates for any.

propertyEqual

public static ValueGetterSpacePredicate<ServerEntry> propertyEqual(String propertyName,
                                                                   Object value)

Shortcut for property(propertyName, equal(value)).

Parameters:: propertyName - Name of property.; value - value for equal.

propertyNotEqual

public static ValueGetterSpacePredicate<ServerEntry> propertyNotEqual(String propertyName,
                                                                      Object value)

Shortcut for property(propertyName, notEqual(value)).

Parameters:: propertyName - Name of property.; value - value for notEqual.

propertyGreater

public static ValueGetterSpacePredicate<ServerEntry> propertyGreater(String propertyName,
                                                                     Comparable<?> value)

Shortcut for property(propertyName, greater(value)).

Parameters:: propertyName - Name of property.; value - value for greater.

propertyGreaterEqual

public static ValueGetterSpacePredicate<ServerEntry> propertyGreaterEqual(String propertyName,
                                                                          Comparable<?> value)

Shortcut for property(propertyName, greaterEqual(value)).

Parameters:: propertyName - Name of property.; value - value for greaterEqual.

propertyLess

public static ValueGetterSpacePredicate<ServerEntry> propertyLess(String propertyName,
                                                                  Comparable<?> value)

Shortcut for property(propertyName, less(value)).

Parameters:: propertyName - Name of property.; value - value for less.

propertyLessEqual

public static ValueGetterSpacePredicate<ServerEntry> propertyLessEqual(String propertyName,
                                                                       Comparable<?> value)

Shortcut for property(propertyName, lessEqual(value)).

Parameters:: propertyName - Name of property.; value - value for lessEqual.

propertyBetween

public static ValueGetterSpacePredicate<ServerEntry> propertyBetween(String propertyName,
                                                                     Comparable<?> low,
                                                                     Comparable<?> high)

Shortcut for property(propertyName, between(low, high)).

Parameters:: propertyName - Name of property.; low - Low value for between.; high - High value for between.

propertyIn

public static ValueGetterSpacePredicate<ServerEntry> propertyIn(String propertyName,
                                                                Object... values)

Shortcut for property(propertyName, in(values)).

Parameters:: propertyName - Name of property.; values - Values for in.

path

public static ValueGetterSpacePredicate<ServerEntry> path(String path,
                                                          ISpacePredicate predicate)

Creates a predicate to get a property value and test it with another predicate.

Parameters:: path - Path to test.; predicate - Predicate to apply on property.
Returns:: Property predicate.

pathNull

public static ValueGetterSpacePredicate<ServerEntry> pathNull(String path)

Shortcut for path(path, isNull()).

Parameters:: path - Path to test.

pathNotNull

public static ValueGetterSpacePredicate<ServerEntry> pathNotNull(String path)

Shortcut for path(path, isNotNull()).

Parameters:: path - Path to test.

pathNot

public static ValueGetterSpacePredicate<ServerEntry> pathNot(String path,
                                                             ISpacePredicate predicate)

Shortcut for path(path, not(predicate)).

Parameters:: path - Path to test.; predicate - predicate for not.

pathAnd

public static ValueGetterSpacePredicate<ServerEntry> pathAnd(String path,
                                                             ISpacePredicate leftPredicate,
                                                             ISpacePredicate rightPredicate)

Shortcut for path(path, and(leftPredicate, rightPredicate)).

Parameters:: path - Path to test.; leftPredicate - leftPredicate for and.; rightPredicate - rightPredicate for and.

pathOr

public static ValueGetterSpacePredicate<ServerEntry> pathOr(String path,
                                                            ISpacePredicate leftPredicate,
                                                            ISpacePredicate rightPredicate)

Shortcut for path(path, or(leftPredicate, rightPredicate)).

Parameters:: path - Path to test.; leftPredicate - leftPredicate for or.; rightPredicate - rightPredicate for or.

pathXor

public static ValueGetterSpacePredicate<ServerEntry> pathXor(String path,
                                                             ISpacePredicate leftPredicate,
                                                             ISpacePredicate rightPredicate)

Shortcut for path(path, xor(leftPredicate, rightPredicate)).

Parameters:: path - Path to test.; leftPredicate - leftPredicate for xor.; rightPredicate - rightPredicate for xor.

pathAll

public static ValueGetterSpacePredicate<ServerEntry> pathAll(String path,
                                                             ISpacePredicate... predicates)

Shortcut for path(path, all(predicates)).

Parameters:: path - Path to test.; predicates - predicates for all.

pathAny

public static ValueGetterSpacePredicate<ServerEntry> pathAny(String path,
                                                             ISpacePredicate... predicates)

Shortcut for path(path, any(predicates)).

Parameters:: path - Path to test.; predicates - predicates for any.

pathEqual

public static ValueGetterSpacePredicate<ServerEntry> pathEqual(String path,
                                                               Object value)

Shortcut for path(path, equal(value)).

Parameters:: path - Path to test.; value - value for equal.

pathNotEqual

public static ValueGetterSpacePredicate<ServerEntry> pathNotEqual(String path,
                                                                  Object value)

Shortcut for path(path, notEqual(value)).

Parameters:: path - Path to test.; value - value for notEqual.

pathGreater

public static ValueGetterSpacePredicate<ServerEntry> pathGreater(String path,
                                                                 Comparable<?> value)

Shortcut for path(path, greater(value)).

Parameters:: path - Path to test.; value - value for greater.

pathGreaterEqual

public static ValueGetterSpacePredicate<ServerEntry> pathGreaterEqual(String path,
                                                                      Comparable<?> value)

Shortcut for path(path, greaterEqual(value)).

Parameters:: path - Path to test.; value - value for greaterEqual.

pathLess

public static ValueGetterSpacePredicate<ServerEntry> pathLess(String path,
                                                              Comparable<?> value)

Shortcut for path(path, less(value)).

Parameters:: path - Path to test.; value - value for less.

pathLessEqual

public static ValueGetterSpacePredicate<ServerEntry> pathLessEqual(String path,
                                                                   Comparable<?> value)

Shortcut for path(path, lessEqual(value)).

Parameters:: path - Path to test.; value - value for lessEqual.

pathBetween

public static ValueGetterSpacePredicate<ServerEntry> pathBetween(String path,
                                                                 Comparable<?> low,
                                                                 Comparable<?> high)

Shortcut for path(path, between(low, high)).

Parameters:: path - Path to test.; low - Low value for between.; high - High value for between.

pathIn

public static ValueGetterSpacePredicate<ServerEntry> pathIn(String path,
                                                            Object... values)

Shortcut for path(path, in(values)).

Parameters:: path - Path to test.; values - Values for in.

Class SpacePredicates