public interface

QueryFilter

com.kinvey.java.query.QueryFilter
Known Indirect Subclasses

Class Overview

A mechanism to filter resultsets within a query

Summary

Nested Classes
interface QueryFilter.QueryFilterBuilder Builder for Query object  
Public Methods
abstract Object get(String key)
Get a value within the current filter based on a specified key
abstract LinkedHashMap<String, Object> getFilter()
Get the current filter
abstract void joinFilters(String operation, LinkedHashMap<String, Object> newFilter)
Join two filters together with a logical and/or
abstract void put(String operation, String key, Object value)
Put a value in the QueryFilter
abstract void put(String key, Object value)
Put a value in the QueryFilter
abstract void put(String operation, String key, Object[] value)
Put a value in the QueryFilter
abstract void reset()
Resets the current filter

Public Methods

public abstract Object get (String key)

Get a value within the current filter based on a specified key

Returns
  • value

public abstract LinkedHashMap<String, Object> getFilter ()

Get the current filter

Returns
  • Current filter

public abstract void joinFilters (String operation, LinkedHashMap<String, Object> newFilter)

Join two filters together with a logical and/or

Parameters
operation and/or operator
newFilter new filter to join to the current filter

public abstract void put (String operation, String key, Object value)

Put a value in the QueryFilter

Parameters
operation operator
key field
value value

public abstract void put (String key, Object value)

Put a value in the QueryFilter

Parameters
key field
value value

public abstract void put (String operation, String key, Object[] value)

Put a value in the QueryFilter

Parameters
operation operator
key field
value value

public abstract void reset ()

Resets the current filter