com.luciad.maps

Class Map.FeatureQuery.Builder

java.lang.Object

com.luciad.maps.Map.FeatureQuery.Builder

All Implemented Interfaces:

AutoCloseable

Enclosing class:

Map.FeatureQuery

public static final class Map.FeatureQuery.Builder
extends Object
implements AutoCloseable

Builder for a Map.FeatureQuery.

Constructor Summary

Constructors

Constructor and Description
Builder(Map.FeatureQuery.Builder other)

Method Summary

Modifier and Type	Method and Description
Map.FeatureQuery	build() Creates the map feature query for the configured settings.
void	close()
Map.FeatureQuery.Builder	features(List<LayerFeatureId> features) Sets the features to select for this query.
protected void	finalize()
Map.FeatureQuery.Builder	includeControllerLayers(boolean enable) Indicates if you want to query features on the controller layers in addition to the map layers.
Map.FeatureQuery.Builder	rectangle(Rectangle rectangle) The rectangle parameter is mandatory.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(@NotNull
               Map.FeatureQuery.Builder other)

Method Detail

finalize

protected void finalize()

Overrides:

finalize in class Object

close

public void close()

Specified by:

close in interface AutoCloseable

build

@NotNull
public Map.FeatureQuery build()
                                throws IllegalStateException

Creates the map feature query for the configured settings.

Returns:

the feature query.

Throws:

IllegalStateException - when not all mandatory parameters are set.

rectangle

@NotNull
public Map.FeatureQuery.Builder rectangle(@NotNull
                                                   Rectangle rectangle)

The rectangle parameter is mandatory.

Parameters:

rectangle - the rectangle the features must interact with. Defined in device independent pixels.

Returns:

this

includeControllerLayers

@NotNull
public Map.FeatureQuery.Builder includeControllerLayers(boolean enable)

Indicates if you want to query features on the controller layers in addition to the map layers.

Calling this method is optional, this value is false by default.

Parameters:

enable - if you want to query features on the controller layers in addition to the map layers.

Returns:

this

features

@NotNull
public Map.FeatureQuery.Builder features(@NotNull
                                                  List<LayerFeatureId> features)

Sets the features to select for this query.

These features act as a filter on the result: the Map:queryFeatures method will only provide results for the given features.

Calling this method is optional. If it is not called, no filtering will be applied on the result.

Parameters:

features - the features to include in the result

Returns:

this