com.luciad.model

LuciadLightspeedClass ILcdModel.Query

java.lang.Object

com.luciad.model.ILcdModel.Query

Enclosing interface:

ILcdModel

public static final class ILcdModel.Query
extends Object

A query to be used with ILcdModel.query(Query).

You can create a query using one of the static factory methods: ILcdModel.all or ILcdModel.filter.
Then, you can specify additional aspects using the instance methods filter, sorted or limit.

The underlying condition and sort-by must never change after creation.

See examples.

Since:

2017.0

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object that)
ILcdModel.Query	filter(ILcdOGCCondition aCondition) Create a copy of this query and replace the condition to filter on.
ILcdOGCCondition	getCondition() Get the OGC condition that should be applied as filter, if any.
Integer	getLimit() Get the maximum number of elements to query, if any.
ILcdOGCSortBy	getSortBy() Get the sorting order should be applied, if any.
int	hashCode()
ILcdModel.Query	limit(Integer aLimit) Create a copy of this query and replace the maximum number of elements to retrieve.
ILcdModel.Query	sorted(ILcdOGCSortBy aSortBy) Create a copy of this query and replace the sorting order.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getCondition

public ILcdOGCCondition getCondition()

Get the OGC condition that should be applied as filter, if any.

Returns:

The condition to be used, or null if no filter should be applied.

Since:

2017.0

getSortBy

public ILcdOGCSortBy getSortBy()

Get the sorting order should be applied, if any.

Returns:

The sorting order, or null if no sorting should be applied.

Since:

2017.0

getLimit

public Integer getLimit()

Get the maximum number of elements to query, if any.

If specified (not null), the value is always >= 0.

Returns:

The maximum number of elements (zero or more), or null if all elements should be retrieved.

Since:

2017.0

filter

public ILcdModel.Query filter(ILcdOGCCondition aCondition)

Create a copy of this query and replace the condition to filter on.

Parameters:

aCondition - The condition to apply, or null if no filtering should be done.

Returns:

A new query object.

See Also:

TLcdOGCFilterFactory to easily create conditions

sorted

public ILcdModel.Query sorted(ILcdOGCSortBy aSortBy)

Create a copy of this query and replace the sorting order.

Parameters:

aSortBy - The sorting order to apply, or null if no sorting should be done.

Returns:

A new query object.

See Also:

TLcdOGCSortBy "comparing" and "thenComparing" factory methods to easily create sorting orders

limit

public ILcdModel.Query limit(Integer aLimit)

Create a copy of this query and replace the maximum number of elements to retrieve.

Parameters:

aLimit - The maximum number of element to query. Use Use null or a negative number if no limit should be applied.

Returns:

A new query object.

equals

public boolean equals(Object that)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object