Class KeyAssociatedFilter

Filter which limits the scope of another filter according to the key association information.

Remarks

Note 1: This filter must be the outermost filter and cannot be used as a part of any composite filter (AndFilter, OrFilter, etc.) Note 2: This filter is intended to be processed only on the client side of the partitioned cache service.

Example:

var filter = Filter.less('age', 40).associatedWith(10);
map.values(filter).then(values => {
  for (const entry of values) {
    console.log(JSON.stringify(entry, null, 4));
  }
});

Hierarchy

Constructors

constructor

Properties

@class filter hostKey

Methods

and associatedWith forKeys or xor

Constructors

constructor

  • Filter which limits the scope of another filter according to the key association information.

    Parameters

    • filter: Filter

      the other filter whose scope to limit

    • hostKey: any

      the filter argument will only be applied to cache service nodes that contain this key.

    Returns KeyAssociatedFilter

Properties

@class

@class: string

Server-side Filter implementation type identifier.

Protected filter

filter: Filter

The underlying filter.

hostKey

hostKey: any

The association host key.

Methods

and

  • Return a composed filter that represents a short-circuiting logical AND of this filter and another. When evaluating the composed filter, if this filter is `false, then the other filter is not evaluated.

    Any exceptions thrown during evaluation of either filter are relayed to the caller; if evaluation of this filter throws an exception, the *other* filter will not be evaluated.

    @param other a filter that will be logically-ANDed with this filter

    @return a composed filter that represents the short-circuiting logical AND of this filter and the other filter

    Parameters

    Returns Filter

associatedWith

forKeys

  • Return a filter that will only be evaluated within specified key set.

    Returns

    a key set-limited filter

    Type Parameters

    • K = any

    Parameters

    • keys: Set<K>

      the set of keys to limit the filter evaluation to

    Returns InKeySetFilter<K>

or

  • Return a composed predicate that represents a short-circuiting logical OR of this predicate and another. When evaluating the composed predicate, if this predicate is true, then the other predicate is not evaluated.

    Any exceptions thrown during evaluation of either predicate are relayed to the caller; if evaluation of this predicate throws an exception, the *other* predicate will not be evaluated.

    Returns

    a composed predicate that represents the short-circuiting logical OR of this predicate and the other predicate

    Parameters

    • other: Filter

      a predicate that will be logically-ORed with this predicate

    Returns Filter

xor

  • Return a composed predicate that represents a logical XOR of this predicate and another.

    Any exceptions thrown during evaluation of either predicate are relayed to the caller; if evaluation of this predicate throws an exception, the other predicate will not be evaluated.

    Returns

    a composed predicate that represents the logical XOR of this predicate and the 'other' predicate

    Parameters

    • other: Filter

      a predicate that will be logically-XORed with this predicate

    Returns Filter

Settings

Member Visibility

Theme