A C E F G H I J O Q S T

A

addCriteria(String, String) - Method in class com.strategicgains.restexpress.common.query.QueryFilter

Add a filter criteria to this QueryFilter instance.

addSort(String...) - Method in class com.strategicgains.restexpress.common.query.QueryOrder

Add sort order(s) to this QueryOrder instance.

asContentRange(long) - Method in class com.strategicgains.restexpress.common.query.QueryRange

Creates a string in the form "items 0-24/66" using the values from this QueryRange along with the maximum number of items available.

C

com.strategicgains.restexpress.common.query - package com.strategicgains.restexpress.common.query

com.strategicgains.restexpress.common.util - package com.strategicgains.restexpress.common.util

E

EMPTY_STRING - Static variable in class com.strategicgains.restexpress.common.util.StringUtils

extendsBeyond(int, long) - Method in class com.strategicgains.restexpress.common.query.QueryRange

F

FilterCallback - Interface in com.strategicgains.restexpress.common.query

Called by QueryFilter.iterate() at query construction time to modify the persistence query (or other query) to reduce the number of results returned.

FilterComponent - Class in com.strategicgains.restexpress.common.query

FilterComponent(String, String) - Constructor for class com.strategicgains.restexpress.common.query.FilterComponent

filterOn(FilterComponent) - Method in interface com.strategicgains.restexpress.common.query.FilterCallback

G

getEnd() - Method in class com.strategicgains.restexpress.common.query.QueryRange

Returns an 'end' value calculated from the offset and limit values set on this QueryRange.

getField() - Method in class com.strategicgains.restexpress.common.query.FilterComponent

getFieldName() - Method in class com.strategicgains.restexpress.common.query.OrderComponent

getLimit() - Method in class com.strategicgains.restexpress.common.query.QueryRange

Returns the limit value or zero if no limit is set.

getOffset() - Method in class com.strategicgains.restexpress.common.query.QueryRange

getStart() - Method in class com.strategicgains.restexpress.common.query.QueryRange

getStart() is a synonym for getOffset().

getValue() - Method in class com.strategicgains.restexpress.common.query.FilterComponent

H

hasFilters() - Method in class com.strategicgains.restexpress.common.query.QueryFilter

Returns true if this QueryFilter instance would affect the query (has effective filters).

hasLimit() - Method in class com.strategicgains.restexpress.common.query.QueryRange

Answers whether a limit is set on this QueryRange.

hasOffset() - Method in class com.strategicgains.restexpress.common.query.QueryRange

I

isAscending() - Method in class com.strategicgains.restexpress.common.query.OrderComponent

isDescending() - Method in class com.strategicgains.restexpress.common.query.OrderComponent

isInitialized() - Method in class com.strategicgains.restexpress.common.query.QueryRange

Returns true if setLimit(int) and setOffset(long) were both called successfully, or the constructor QueryRange(long, int) was successfully called.

isInside(int, long) - Method in class com.strategicgains.restexpress.common.query.QueryRange

isOutside(int, long) - Method in class com.strategicgains.restexpress.common.query.QueryRange

isSorted() - Method in class com.strategicgains.restexpress.common.query.QueryOrder

Returns true if this QueryOrder contains sort criteria.

isValid() - Method in class com.strategicgains.restexpress.common.query.QueryRange

Validates the range.

iterate(FilterCallback) - Method in class com.strategicgains.restexpress.common.query.QueryFilter

Iterate the filter criteria within this QueryFilter, invoking the FilterCallback to presumably construct a query.

iterate(OrderCallback) - Method in class com.strategicgains.restexpress.common.query.QueryOrder

J

join(String, Collection<? extends Object>) - Static method in class com.strategicgains.restexpress.common.util.StringUtils

join(String, Object...) - Static method in class com.strategicgains.restexpress.common.util.StringUtils

O

orderBy(OrderComponent) - Method in interface com.strategicgains.restexpress.common.query.OrderCallback

OrderCallback - Interface in com.strategicgains.restexpress.common.query

Called by QueryOrder.iterate() at query construction time to modify the persistence query (or other query) to impose a sort order on the results returned.

OrderComponent - Class in com.strategicgains.restexpress.common.query

OrderComponent(String, boolean) - Constructor for class com.strategicgains.restexpress.common.query.OrderComponent

Q

QueryFilter - Class in com.strategicgains.restexpress.common.query

Supports the concept of filtering a result based on the 'filter' query parameter.

QueryFilter() - Constructor for class com.strategicgains.restexpress.common.query.QueryFilter

QueryFilter(Map<String, String>) - Constructor for class com.strategicgains.restexpress.common.query.QueryFilter

Create a QueryFilter instance from a Map of name/value pairs.

QueryOrder - Class in com.strategicgains.restexpress.common.query

Supports the concept of sorting a result based on the 'sort' query parameter.

QueryOrder() - Constructor for class com.strategicgains.restexpress.common.query.QueryOrder

QueryOrder(String...) - Constructor for class com.strategicgains.restexpress.common.query.QueryOrder

Create a QueryOrder instance from an array of property names to order on, prefixed with '-' to sort descending.

QueryRange - Class in com.strategicgains.restexpress.common.query

Supports the concept of 'pagination' via request 'Range' header or 'limit' and 'offset' parameters.

QueryRange() - Constructor for class com.strategicgains.restexpress.common.query.QueryRange

QueryRange(long, int) - Constructor for class com.strategicgains.restexpress.common.query.QueryRange

S

setField(String) - Method in class com.strategicgains.restexpress.common.query.FilterComponent

setLimit(int) - Method in class com.strategicgains.restexpress.common.query.QueryRange

Set the query limit, which represents the maximum number of results returned in a query.

setLimitViaEnd(long) - Method in class com.strategicgains.restexpress.common.query.QueryRange

Sets the limit of this range by calculating the difference between the already-set offset and the given 'end' value.

setOffset(long) - Method in class com.strategicgains.restexpress.common.query.QueryRange

setStart(long) - Method in class com.strategicgains.restexpress.common.query.QueryRange

setStart() is a synonym for setOffset().

setValue(String) - Method in class com.strategicgains.restexpress.common.query.FilterComponent

spans(int, long) - Method in class com.strategicgains.restexpress.common.query.QueryRange

StringUtils - Class in com.strategicgains.restexpress.common.util

T

toString() - Method in class com.strategicgains.restexpress.common.query.QueryRange

A C E F G H I J O Q S T