Class BucketsRequest<T extends UniqueObject>
java.lang.Object
de.digitalcollections.model.list.ListRequest
de.digitalcollections.model.list.buckets.BucketsRequest<T>
- Type Parameters:
T
- type of an UniqueObject contained in a Bucket
- All Implemented Interfaces:
Serializable
A BucketsRequest allows you to break a list / result set into a specified number of approximately
equal groups, or buckets.
It assigns each group a bucket number starting from one.
For each row in a group, the bucket number represents the group to which the row belongs.
It assigns each group a bucket number starting from one.
For each row in a group, the bucket number represents the group to which the row belongs.
- See Also:
-
Field Summary
Fields inherited from class de.digitalcollections.model.list.ListRequest
filtering, searchTerm, sorting
-
Constructor Summary
ConstructorDescriptionBucketsRequest
(int numberOfBuckets) Creates a newBucketsRequest
targeting a list of objects.BucketsRequest
(int numberOfBuckets, Bucket<T> parentBucket, Sorting sorting, Filtering filtering) Creates a newBucketsRequest
with sorting parameters applied.BucketsRequest
(int numberOfBuckets, T startObject, T endObject, Sorting sorting, Filtering filtering) Creates a newBucketsRequest
with sorting parameters applied to a previously calculated (sub)bucket of all objects. -
Method Summary
Modifier and TypeMethodDescriptionint
void
setNumberOfBuckets
(int numberOfBuckets) void
setParentBucket
(Bucket<T> parentBucket) Methods inherited from class de.digitalcollections.model.list.ListRequest
add, add, equals, getFiltering, getSearchTerm, getSorting, hasFiltering, hashCode, hasSorting, init, setFiltering, setSearchTerm, setSorting, toString
-
Constructor Details
-
BucketsRequest
public BucketsRequest(int numberOfBuckets, Bucket<T> parentBucket, Sorting sorting, Filtering filtering) Creates a newBucketsRequest
with sorting parameters applied.- Parameters:
numberOfBuckets
- number (which is a literal positive integer number) of buckets the list should be divided into.parentBucket
- bucket to be split into buckets or null if top bucket (whole list) ist to be splitsorting
- can be nullfiltering
- contains list of filter criterias
-
BucketsRequest
public BucketsRequest(int numberOfBuckets, T startObject, T endObject, Sorting sorting, Filtering filtering) Creates a newBucketsRequest
with sorting parameters applied to a previously calculated (sub)bucket of all objects.- Parameters:
numberOfBuckets
- number (which is a literal positive integer number) of buckets the list should be divided into.startObject
- left border object (first object in source list)endObject
- right border object (last object in source list)sorting
- can be nullfiltering
- contains list of filter criterias
-
BucketsRequest
public BucketsRequest(int numberOfBuckets) Creates a newBucketsRequest
targeting a list of objects.- Parameters:
numberOfBuckets
- number (which is a literal positive integer number) of buckets the list should be divided into.
-
BucketsRequest
public BucketsRequest()
-
-
Method Details
-
getNumberOfBuckets
public int getNumberOfBuckets()- Returns:
- number of buckets requested
-
getParentBucket
- Returns:
- parent bucket being the border for sub buckets request
-
setNumberOfBuckets
public void setNumberOfBuckets(int numberOfBuckets) - Parameters:
numberOfBuckets
- number of buckets requested
-
setParentBucket
- Parameters:
parentBucket
- parent bucket being the border for sub buckets request (or null)
-