Module com.esri.arcgisruntime

Package com.esri.arcgisruntime.layers

Class DisplayFilter

java.lang.Object

com.esri.arcgisruntime.layers.DisplayFilter

Direct Known Subclasses:

ScaleRangeDisplayFilter

public class DisplayFilter
extends Object

Represents a type used for limiting which features are rendered.

Features filtered from display remain available for query and analysis. Use display filter when only a subset of features needs to be visible while maintaining access to all features.

Since:

100.13.0

See Also:

• ScaleDisplayFilterDefinition.getFilters()
• ManualDisplayFilterDefinition.getActiveFilter()

Constructor Summary

Constructors

Constructor	Description
DisplayFilter(String name, String whereClause)	Creates a new DisplayFilter with the specified name and where clause.

Method Summary

Modifier and Type	Method	Description
String	getFilterId()	Gets the identifier for this display filter.
String	getName()	Gets a descriptive name for this display filter.
String	getWhereClause()	Gets a SQL expression that defines which features are rendered.
void	setName(String name)	Sets a descriptive name for this display filter.
void	setWhereClause(String whereClause)	Sets a SQL expression that defines which features are rendered.

Methods inherited from class java.lang.Object

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

Constructor Details

DisplayFilter

public DisplayFilter(String name,
 String whereClause)

Creates a new DisplayFilter with the specified name and where clause.

Parameters:

name - a descriptive name for this display filter

whereClause - a SQL expression that defines which features are rendered

Throws:

IllegalArgumentException - if name is null or empty

IllegalArgumentException - if whereClause is null or empty

Since:

100.13.0

Method Details

getFilterId

public String getFilterId()

Gets the identifier for this display filter.

Use a unique name to identify this display filter when used in a webmap as a ManualDisplayFilterDefinition.getActiveFilter().

Returns:

the identifier for this display filter

Since:

100.13.0

getName

public String getName()

Gets a descriptive name for this display filter.

Returns:

a descriptive name for this display filter

Since:

100.13.0

setName

public void setName(String name)

Sets a descriptive name for this display filter.

Parameters:

name - a descriptive name for this display filter

Throws:

IllegalArgumentException - if name is null

Since:

100.13.0

getWhereClause

public String getWhereClause()

Gets a SQL expression that defines which features are rendered.

The where clause string that is used as the getWhereClause() should follow standard SQL syntax similar to what is discussed in the document SQL reference for query expressions used in ArcGIS. A where clause that is not valid for the data may result in no features being drawn when this display filter is applied either by ManualDisplayFilterDefinition.getActiveFilter() or by ScaleRangeDisplayFilter.getMaxScale(). Check the layer's LayerViewState for a LayerViewStatus.WARNING; if there is one, then there might be LayerViewState.getError() describing that the display filter's where clause is not valid.

Returns:

a SQL expression that defines which features are rendered

Since:

100.13.0

setWhereClause

public void setWhereClause(String whereClause)

Sets a SQL expression that defines which features are rendered.

The where clause string that is used as the getWhereClause() should follow standard SQL syntax similar to what is discussed in the document SQL reference for query expressions used in ArcGIS. A where clause that is not valid for the data may result in no features being drawn when this display filter is applied either by ManualDisplayFilterDefinition.getActiveFilter() or by ScaleRangeDisplayFilter.getMaxScale(). Check the layer's LayerViewState for a LayerViewStatus.WARNING; if there is one, then there might be LayerViewState.getError() describing that the display filter's where clause is not valid.

Parameters:

whereClause - a SQL expression that defines which features are rendered

Throws:

IllegalArgumentException - if whereClause is null or empty

Since:

100.13.0