er.rest

Class ERXRestFetchSpecification<T extends EOEnterpriseObject>

java.lang.Object

er.rest.ERXRestFetchSpecification<T>

Type Parameters:

T - the type of the objects being returned

public class ERXRestFetchSpecification<T extends EOEnterpriseObject>
extends Object

ERXRestFetchSpecification provides a wrapper around fetching objects with batching, sort orderings, and (optionally) qualifiers configured in the WORequest.

Example query string parameters:

• sort=lastName|asc,firstName|desc
• batchSize=25&batch=1 (Note that batch number is a zero-based index)
• qualifier=firstName%3D'Mike'
• Range=items%3D10-19 (Note that the index values for Range items are zero-based)

Because request EOQualifiers could possibly pose a security risk, you must explicitly enable request qualifiers by calling enableRequestQualifiers(baseQualifier) or by using the longer constructor that takes an optional base qualifier. A base qualifier is prepended (AND'd) to whatever qualifier is passed on the query string to restrict the results of the user's query.

An example use:

 public WOActionResults indexAction() throws Throwable {
        ERXRestFetchSpecification<Task> fetchSpec = new ERXRestFetchSpecification<Task>(Task.ENTITY_NAME, null, null, queryFilter(), Task.CREATION_DATE.descs(), 25);
        NSArray<Task> tasks = fetchSpec.objects(editingContext(), options());
        return response(editingContext(), Task.ENTITY_NAME, tasks, showFilter());
 }
 

In this example, we are fetching the "Task" entity, sorted by creation date, with a default batch size of 25, and with request qualifiers enable (meaning, we allow users to pass in a qualifier in the query string), filtering the qualifier with the ERXKeyFilter returned by the queryFilter() method. We then fetch the resulting tasks and return the response to the user.

Author:

mschrag

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ERXRestFetchSpecification.Results<T> Encapsulates the results of a fetch along with some fetch metadata.

Constructor Summary

Constructors

Constructor and Description
ERXRestFetchSpecification(String entityName, EOQualifier defaultQualifier, EOQualifier baseQualifier, ERXKeyFilter qualifierFilter, NSArray<EOSortOrdering> defaultSortOrderings, int defaultBatchSize) Creates a new ERXRestFetchSpecification with a maximum batch size of 100 and with request qualifiers enabled.
ERXRestFetchSpecification(String entityName, EOQualifier defaultQualifier, NSArray<EOSortOrdering> defaultSortOrderings) Creates a new ERXRestFetchSpecification with a maximum batch size of 100, but with batching turned off by default.
ERXRestFetchSpecification(String entityName, EOQualifier defaultQualifier, NSArray<EOSortOrdering> defaultSortOrderings, int defaultBatchSize) Creates a new ERXRestFetchSpecification with a maximum batch size of 100.

Method Summary

Modifier and Type	Method and Description
int	batchNumber(NSKeyValueCoding options) Returns the effective batch number.
int	batchSize(NSKeyValueCoding options) Returns the effective batch size.
int	defaultBatchSize() Returns the default batch size (defaults to -1 = off).
void	enableRequestQualifiers(EOQualifier baseQualifier, ERXKeyFilter qualifierFilter) Enables qualifiers in the request, but will be AND'd to the given base qualifier (in case you need to perform security restrictions)
String	entityName() Returns the name of the entity used in this fetch.
int	maxBatchSize() Returns the maximum batch size (defaults to 100).
NSArray<T>	objects(EOEditingContext editingContext, NSKeyValueCoding options) Fetches the objects into the given editing context with the effective attributes of this fetch specification.
NSArray<T>	objects(EOEditingContext editingContext, WORequest request) Fetches the objects into the given editing context with the effective attributes of this fetch specification.
NSArray<T>	objects(NSArray<T> objects, EOEditingContext editingContext, NSKeyValueCoding options) Applies the effective attributes of this fetch specification to the given array, filtering, sorting, and cutting into batches accordingly.
NSArray<T>	objects(NSArray<T> objects, EOEditingContext editingContext, WORequest request) Applies the effective attributes of this fetch specification to the given array, filtering, sorting, and cutting into batches accordingly.
EOQualifier	qualifier(EOEditingContext editingContext, NSKeyValueCoding options) Returns the effective qualifier.
NSRange	range(NSKeyValueCoding options) Returns the range of this fetch.
ERXRestFetchSpecification.Results<T>	results(EOEditingContext editingContext, NSKeyValueCoding options) Fetches the objects into the given editing context with the effective attributes of this fetch specification.
void	setDefaultBatchSize(int defaultBatchSize) Sets the default batch size
void	setMaxBatchSize(int maxBatchSize) Sets the maximum batch size.
NSArray<EOSortOrdering>	sortOrderings(EOEditingContext editingContext, NSKeyValueCoding options) Returns the effective sort orderings.

Methods inherited from class java.lang.Object

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

Constructor Detail

ERXRestFetchSpecification

public ERXRestFetchSpecification(String entityName,
                                 EOQualifier defaultQualifier,
                                 NSArray<EOSortOrdering> defaultSortOrderings)

Creates a new ERXRestFetchSpecification with a maximum batch size of 100, but with batching turned off by default.

Parameters:

entityName - the name of the entity being fetched

defaultQualifier - the default qualifiers (if none are specified in the request)

defaultSortOrderings - the default sort orderings (if none are specified in the request)

ERXRestFetchSpecification

public ERXRestFetchSpecification(String entityName,
                                 EOQualifier defaultQualifier,
                                 NSArray<EOSortOrdering> defaultSortOrderings,
                                 int defaultBatchSize)

Creates a new ERXRestFetchSpecification with a maximum batch size of 100. default.

Parameters:

entityName - the name of the entity being fetched

defaultQualifier - the default qualifiers (if none are specified in the request)

defaultSortOrderings - the default sort orderings (if none are specified in the request)

defaultBatchSize - the default batch size (-1 to disable)

ERXRestFetchSpecification

public ERXRestFetchSpecification(String entityName,
                                 EOQualifier defaultQualifier,
                                 EOQualifier baseQualifier,
                                 ERXKeyFilter qualifierFilter,
                                 NSArray<EOSortOrdering> defaultSortOrderings,
                                 int defaultBatchSize)

Creates a new ERXRestFetchSpecification with a maximum batch size of 100 and with request qualifiers enabled. default.

Parameters:

entityName - the name of the entity being fetched

defaultQualifier - the default qualifiers (if none are specified in the request)

baseQualifier - the base qualifier (see enableRequestQualifiers)

qualifierFilter - the key filter to apply against the query qualifier

defaultSortOrderings - the default sort orderings (if none are specified in the request)

defaultBatchSize - the default batch size (-1 to disable)

Method Detail

entityName

public String entityName()

Returns the name of the entity used in this fetch.

Returns:

the name of the entity used in this fetch

maxBatchSize

public int maxBatchSize()

Returns the maximum batch size (defaults to 100).

Returns:

the maximum batch size

setMaxBatchSize

public void setMaxBatchSize(int maxBatchSize)

Sets the maximum batch size.

Parameters:

maxBatchSize - the maximum batch size

defaultBatchSize

public int defaultBatchSize()

Returns the default batch size (defaults to -1 = off).

Returns:

the default batch size

setDefaultBatchSize

public void setDefaultBatchSize(int defaultBatchSize)

Sets the default batch size

Parameters:

defaultBatchSize - the default batch size

enableRequestQualifiers

public void enableRequestQualifiers(EOQualifier baseQualifier,
                                    ERXKeyFilter qualifierFilter)

Enables qualifiers in the request, but will be AND'd to the given base qualifier (in case you need to perform security restrictions)

Parameters:

baseQualifier - the base qualifier to and with

qualifierFilter - the key filter to apply against the query qualifier

sortOrderings

public NSArray<EOSortOrdering> sortOrderings(EOEditingContext editingContext,
                                             NSKeyValueCoding options)

Returns the effective sort orderings.

Parameters:

editingContext - the editing context

options - the current options

Returns:

the effective sort orderings

qualifier

public EOQualifier qualifier(EOEditingContext editingContext,
                             NSKeyValueCoding options)

Returns the effective qualifier.

Parameters:

editingContext - the editing context

options - the current options

Returns:

the effective qualifier

batchNumber

public int batchNumber(NSKeyValueCoding options)

Returns the effective batch number.

Parameters:

options - the current options

Returns:

the effective batch number

range

public NSRange range(NSKeyValueCoding options)

Returns the range of this fetch.

Parameters:

options - the current options

Returns:

the effective batch number

batchSize

public int batchSize(NSKeyValueCoding options)

Returns the effective batch size.

Parameters:

options - the current options

Returns:

the effective batch size

results

public ERXRestFetchSpecification.Results<T> results(EOEditingContext editingContext,
                                                    NSKeyValueCoding options)

Fetches the objects into the given editing context with the effective attributes of this fetch specification.

Parameters:

editingContext - the editing context to fetch into

options - the current options

Returns:

the fetch objects

objects

public NSArray<T> objects(EOEditingContext editingContext,
                          NSKeyValueCoding options)

Fetches the objects into the given editing context with the effective attributes of this fetch specification.

Parameters:

editingContext - the editing context to fetch into

options - the current options

Returns:

the fetch objects

objects

public NSArray<T> objects(NSArray<T> objects,
                          EOEditingContext editingContext,
                          NSKeyValueCoding options)

Applies the effective attributes of this fetch specification to the given array, filtering, sorting, and cutting into batches accordingly.

Parameters:

objects - the objects to filter

editingContext - the editing context to evaluate the qualifer filter with

options - the current options

Returns:

the filtered objects

objects

public NSArray<T> objects(EOEditingContext editingContext,
                          WORequest request)

Fetches the objects into the given editing context with the effective attributes of this fetch specification.

Parameters:

editingContext - the editing context to fetch into

request - the current request

Returns:

the fetch objects

objects

public NSArray<T> objects(NSArray<T> objects,
                          EOEditingContext editingContext,
                          WORequest request)

Applies the effective attributes of this fetch specification to the given array, filtering, sorting, and cutting into batches accordingly.

Parameters:

objects - the objects to filter

editingContext - the editing context to evaluate the qualifer filter with

request - the current request

Returns:

the filtered objects