Package com.luciad.models.features
Class FeatureQuery
java.lang.Object
com.luciad.models.features.FeatureQuery
- All Implemented Interfaces:
AutoCloseable
A query specifies which objects you are interested in.
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.
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic final class
Builder
to create a FeatureQuery.static final class
SortOperator
class contains a list of properties that must be taken into account for sorting.static enum
Sort order.static final class
SortProperty
class defines the property name and the sort order for theSortOperator
. -
Method Summary
Modifier and TypeMethodDescriptionstatic FeatureQuery
all()
This method is a convenience factory method that creates a query to retrieve all features.void
close()
protected void
finalize()
Returns the bounds the queried features must interact with.Returns the condition that should be applied on the query, if any.Returns the features to retrieve by id.getLimit()
Returns the maximum number of elements to query, if any.Returns the sorting order that should be applied on the query, if any.static FeatureQuery.Builder
Returns the builder class for creation of the feature query.
-
Method Details
-
finalize
protected void finalize() -
close
public void close()- Specified by:
close
in interfaceAutoCloseable
-
newBuilder
Returns the builder class for creation of the feature query.- Returns:
- the builder class for creation of the feature query.
-
all
This method is a convenience factory method that creates a query to retrieve all features.- Returns:
- a query to retrieve all features.
-
getBounds
Returns the bounds the queried features must interact with.- Returns:
- the bounds the queried features must interact with.
-
getCondition
Returns the condition that should be applied on the query, if any.- Returns:
- the condition that should be applied on the query, if any.
-
getFeatureIds
Returns the features to retrieve by id.- Returns:
- the features to retrieve by id.
-
getSortBy
Returns the sorting order that should be applied on the query, if any.- Returns:
- the sorting order that should be applied on the query, if any.
-
getLimit
Returns the maximum number of elements to query, if any.- Returns:
- the maximum number of elements to query, if any.
-