public final class FeatureQuery extends Object implements AutoCloseable
It is a combination of:
All of these are optional.The query implementation must use all settings on the Query instance. For example, if both a bounds and a condition are specified, the query implementation must take both the bounds and the condition into account.
Create an empty Query
to get all objects. When both a condition and feature ids are provided in the Query
the objects need to fulfill both.
Modifier and Type | Class and Description |
---|---|
static class |
FeatureQuery.Builder
Builder to create a FeatureQuery. |
static class |
FeatureQuery.SortOperator
SortOperator class contains a list of properties that must be taken into account for sorting. |
static class |
FeatureQuery.SortOrder
Sort order.
|
static class |
FeatureQuery.SortProperty
SortProperty class defines the property name and the sort order for the SortOperator . |
Modifier and Type | Method and Description |
---|---|
static FeatureQuery |
all()
This method is a convenience factory method that creates a query to retrieve all features.
|
void |
close() |
protected void |
finalize() |
Bounds |
getBounds()
Returns the bounds the queried features must interact with.
|
Expression |
getCondition()
Returns the condition that should be applied on the query, if any.
|
List<Long> |
getFeatureIds()
Returns the features to retrieve by id.
|
Long |
getLimit()
Returns the maximum number of elements to query, if any.
|
FeatureQuery.SortOperator |
getSortBy()
Returns the sorting order that should be applied on the query, if any.
|
static FeatureQuery.Builder |
newBuilder()
Returns the builder class for creation of the feature query.
|
public void close()
close
in interface AutoCloseable
@NotNull public static FeatureQuery.Builder newBuilder()
@NotNull public static FeatureQuery all()
@Nullable public Bounds getBounds()
@Nullable public Expression getCondition()
@Nullable public List<Long> getFeatureIds()
@Nullable public FeatureQuery.SortOperator getSortBy()
@Nullable public Long getLimit()