org.openstreetmap.josm.gui.autofilter

Class AutoFilterRule

java.lang.Object

org.openstreetmap.josm.gui.autofilter.AutoFilterRule

public class AutoFilterRule
extends java.lang.Object

An auto filter rule determines how auto filter can be built from visible map data. Several rules can be registered, but only one rule is active at the same time. Rules are identified by the OSM key on which they apply. The dynamic values discovering operates only below a certain zoom level, for performance reasons.

Since:

12400

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	key
private int	minZoomLevel
private java.util.Comparator<java.lang.String>	valueComparator
private java.util.function.UnaryOperator<java.lang.String>	valueFormatter

Constructor Summary

Constructors

Constructor and Description
AutoFilterRule(java.lang.String key, int minZoomLevel) Constructs a new AutoFilterRule.

Method Summary

Modifier and Type	Method and Description
static AutoFilterRule[]	defaultRules() Returns the default list of auto filter rules.
java.lang.String	getKey() Returns the OSM key on which the rule applies.
int	getMinZoomLevel() Returns the minimum zoom level at which the rule applies.
java.util.Comparator<java.lang.String>	getValueComparator() Returns the OSM value comparator used to order the buttons.
java.util.function.Function<java.lang.String,java.lang.String>	getValueFormatter() Returns the OSM value formatter that defines the associated button label.
AutoFilterRule	setValueComparator(java.util.Comparator<java.lang.String> valueComparator) Sets the OSM value comparator used to order the buttons.
AutoFilterRule	setValueFormatter(java.util.function.UnaryOperator<java.lang.String> valueFormatter) Sets a OSM value formatter that defines the associated button label.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

key

private final java.lang.String key

minZoomLevel

private final int minZoomLevel

valueFormatter

private java.util.function.UnaryOperator<java.lang.String> valueFormatter

valueComparator

private java.util.Comparator<java.lang.String> valueComparator

Constructor Detail

AutoFilterRule

public AutoFilterRule(java.lang.String key,
                      int minZoomLevel)

Constructs a new AutoFilterRule.

Parameters:

key - the OSM key on which the rule applies

minZoomLevel - the minimum zoom level at which the rule applies

Method Detail

getKey

public java.lang.String getKey()

Returns the OSM key on which the rule applies.

Returns:

the OSM key on which the rule applies

getMinZoomLevel

public int getMinZoomLevel()

Returns the minimum zoom level at which the rule applies.

Returns:

the minimum zoom level at which the rule applies

getValueFormatter

public java.util.function.Function<java.lang.String,java.lang.String> getValueFormatter()

Returns the OSM value formatter that defines the associated button label.

Returns:

the OSM value formatter that defines the associated button label (identity by default)

setValueFormatter

public AutoFilterRule setValueFormatter(java.util.function.UnaryOperator<java.lang.String> valueFormatter)

Sets a OSM value formatter that defines the associated button label.

Parameters:

valueFormatter - OSM value formatter. Cannot be null

Returns:

this

Throws:

java.lang.NullPointerException - if valueFormatter is null

getValueComparator

public java.util.Comparator<java.lang.String> getValueComparator()

Returns the OSM value comparator used to order the buttons.

Returns:

the OSM value comparator

setValueComparator

public AutoFilterRule setValueComparator(java.util.Comparator<java.lang.String> valueComparator)

Sets the OSM value comparator used to order the buttons.

Parameters:

valueComparator - the OSM value comparator

Returns:

this

Throws:

java.lang.NullPointerException - if valueComparator is null

defaultRules

public static AutoFilterRule[] defaultRules()

Returns the default list of auto filter rules. Plugins can extend the list by registering additional rules.

Returns:

the default list of auto filter rules

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object