com.scaleoutsoftware.soss.client

Class NamedCacheFilter

java.lang.Object

com.scaleoutsoftware.soss.client.NamedCacheFilter

All Implemented Interfaces:

Query, java.io.Serializable

public class NamedCacheFilter
extends java.lang.Object
implements Query

This class represents a filter used in NamedCache.query()

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
NamedCacheFilter() Creates a filter that matches all objects.
NamedCacheFilter(IndexCollection ic) Creates a filter for queries.
NamedCacheFilter(IndexCollection ic, boolean matchAll) Creates a filter for queries.

Method Summary

Modifier and Type	Method and Description
IndexCollection	getIndexCollection() Gets the IndexCollection
boolean	getMatchOptions() Gets matchAll boolean.

Methods inherited from class java.lang.Object

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

Constructor Detail

NamedCacheFilter

public NamedCacheFilter(IndexCollection ic,
                        boolean matchAll)

Creates a filter for queries.

Parameters:

ic - IndexCollection containing query criteria.

matchAll - If matchAll is true returned objects must match every IndexValue. If matchAll is false, objects can match any IndexValue.

NamedCacheFilter

public NamedCacheFilter(IndexCollection ic)

Creates a filter for queries.

Parameters:

ic - IndexCollection containing query criteria.

NamedCacheFilter

public NamedCacheFilter()

Creates a filter that matches all objects.

Method Detail

getIndexCollection

public IndexCollection getIndexCollection()

Gets the IndexCollection

Specified by:

getIndexCollection in interface Query

Returns:

IndexCollection containing query criteria.

getMatchOptions

public boolean getMatchOptions()

Gets matchAll boolean.

Specified by:

getMatchOptions in interface Query

Returns:

If matchAll is true returned objects must match every IndexValue. If matchAll is false, objects can match any IndexValue.