com.luciad.fusion.tilestore

LuciadLightspeedClass TLfnQuery

java.lang.Object

com.luciad.fusion.tilestore.TLfnQuery

public final class TLfnQuery
extends Object

A query object. A query can be created using a query builder. All fields are optional:

• resource types: selected resource types, defaults to null for all resource types
• filter: filters the results, defaults to null for no filtering
• sort-by: a criterion to sort the results by, defaults to null if unspecified
• range offset: defines the start of a range of results to be returned, defaults to 0 if unspecified
• range length: defines the amount of results to be returned, starting from the start index. Defaults to -1 (all results) if unspecified

Since:

10.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TLfnQuery.AbstractBuilder<B extends TLfnQuery.AbstractBuilder> A base class for builder for a TLfnQuery object.
static class	TLfnQuery.BasicBuilder A basic builder for a TLfnQuery object that allows creating common query's without any knowledge about OGC filters.
static class	TLfnQuery.Builder A builder for a TLfnQuery object.
static class	TLfnQuery.Property The resource properties that are supported in the TLfnQuery.BasicBuilder for creating a filter and sort-by.

Method Summary

Modifier and Type	Method and Description
TLcdOGCFilter	getFilter() Gets the filter used by this query.
int	getRangeLength() Gets the length of the desired range of result elements for this query.
int	getRangeOffset() Gets the offset of the desired range of results for this query.
ELfnResourceType[]	getResourceTypes() Gets the resource types used by this query.
TLcdOGCSortBy	getSortBy() Gets the sort-by criterion used by this query.
static TLfnQuery.BasicBuilder	newBasicBuilder() Creates a basic builder for a query.
static TLfnQuery.Builder	newBuilder() Creates a builder for a query.

Methods inherited from class java.lang.Object

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

Method Detail

getFilter

public TLcdOGCFilter getFilter()

Gets the filter used by this query.

Returns:

a filter, possibly null

getSortBy

public TLcdOGCSortBy getSortBy()

Gets the sort-by criterion used by this query.

Returns:

a sort-by criterion, possibly null

getResourceTypes

public ELfnResourceType[] getResourceTypes()

Gets the resource types used by this query.

Returns:

the resource types used by this query, possibly null

getRangeOffset

public int getRangeOffset()

Gets the offset of the desired range of results for this query.

Returns:

the offset of the desired range of results for this query

getRangeLength

public int getRangeLength()

Gets the length of the desired range of result elements for this query. The actual number of returned result elements may be less than the range length, but never more.

Returns:

the length of the desired range of results for this query

newBuilder

public static TLfnQuery.Builder newBuilder()

Creates a builder for a query. The builder's parameters are initialized to the default values.

Returns:

a new builder

newBasicBuilder

public static TLfnQuery.BasicBuilder newBasicBuilder()

Creates a basic builder for a query. This builder allows creating common query's without any knowledge about OGC filters. The builder's parameters are initialized to the default values.

Returns:

a new basic builder