net.sf.gridarta.model.filter

Class NamedFilter

java.lang.Object

net.sf.gridarta.model.filter.NamedFilter

All Implemented Interfaces:

Filter<NamedFilter,NamedFilterConfig>

public class NamedFilter
extends java.lang.Object
implements Filter<NamedFilter,NamedFilterConfig>

A Filter that aggregates named filters.

This filter aggregates a list of named sub-filters. Each sub-filter can be (dis)enabled.

Constructor Summary

Constructors

Constructor and Description
NamedFilter(java.lang.Iterable<NamedGameObjectMatcher> matchers) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
void	addFilter(java.lang.String name, Filter<?,?> filter) Adds a sub-Filter.
void	addFilterListener(NamedFilterListener listener) Adds a NamedFilterListener to be notified about changes.
boolean	canShow(GameObject<?,?,?> gameObject, NamedFilterConfig filterOutConfig) Returns whether this filter matches a GameObject.
NamedFilterConfig	createConfig() Creates a new FilterConfig instance for this filter.
boolean	hasGlobalMatch(NamedFilterConfig config) Tells if all the game objects on a square are to be analyzed before a match result.
boolean	match(NamedFilterConfig config, GameObject<?,?,?> gameObject) Tells whether we got a match on specific GameObject.
void	removeFilter(java.lang.String name) Removes a sub-filter.
void	removeFilterListener(NamedFilterListener listener) Removes a NamedFilterListener to be notified about changes.
boolean	reset(NamedFilterConfig config) This tells the filter we have finished with current map square and, perhaps, we are jumping on next one.
void	resetConfig(NamedFilterConfig config) Disables all sub-filters.

Methods inherited from class java.lang.Object

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

Constructor Detail

NamedFilter

public NamedFilter(@NotNull
                   java.lang.Iterable<NamedGameObjectMatcher> matchers)

Creates a new instance.

Parameters:

matchers - the matchers to create filters from

Method Detail

resetConfig

public void resetConfig(@NotNull
                        NamedFilterConfig config)

Disables all sub-filters.

Parameters:

config - the filter config to reset

match

public boolean match(@NotNull
                     NamedFilterConfig config,
                     @NotNull
                     GameObject<?,?,?> gameObject)

Tells whether we got a match on specific GameObject. The analysis tool will call this function with every game object on a given map square. The match function is responsible for analyzing inventories if it needs to. Unless Filter.hasGlobalMatch(FilterConfig) returns true, when a match occurred, this function is not called with the remaining game objects on the map square and a reset is issued.

Specified by:

match in interface Filter<NamedFilter,NamedFilterConfig>

Parameters:

config - the filter configuration to use

gameObject - the game object being analyzed on the map

Returns:

whether it matches the criteria; this value is ignored if hasGlobalMatch() returns true

reset

public boolean reset(@NotNull
                     NamedFilterConfig config)

This tells the filter we have finished with current map square and, perhaps, we are jumping on next one. If Filter.hasGlobalMatch(FilterConfig) returns true, the returning value is used to know if we had a match.

Specified by:

reset in interface Filter<NamedFilter,NamedFilterConfig>

Parameters:

config - the filter configuration to use

Returns:

whether we had a global match on map square

hasGlobalMatch

public boolean hasGlobalMatch(@NotNull
                              NamedFilterConfig config)

Tells if all the game objects on a square are to be analyzed before a match result. If all game objects must be analyzed to decide the result of a match, the return value of Filter.match(FilterConfig, GameObject) is ignored and the returning value of Filter.reset(FilterConfig) is used as replacement. This should mainly used by complex analyze filters.

Specified by:

hasGlobalMatch in interface Filter<NamedFilter,NamedFilterConfig>

Parameters:

config - the filter configuration to use

Returns:

whether a match can be decided only when all game objects on a map square are analyzed

createConfig

@NotNull
public NamedFilterConfig createConfig()

Creates a new FilterConfig instance for this filter.

Specified by:

createConfig in interface Filter<NamedFilter,NamedFilterConfig>

Returns:

the new filter config instance

addFilter

public void addFilter(@NotNull
                      java.lang.String name,
                      @NotNull
                      Filter<?,?> filter)

Adds a sub-Filter.

Parameters:

name - the name of the sub-filter

filter - the sub-filter

removeFilter

public void removeFilter(@NotNull
                         java.lang.String name)

Removes a sub-filter.

Parameters:

name - the name of the sub-filter

addFilterListener

public void addFilterListener(@NotNull
                              NamedFilterListener listener)

Adds a NamedFilterListener to be notified about changes.

Parameters:

listener - the listener

removeFilterListener

public void removeFilterListener(@NotNull
                                 NamedFilterListener listener)

Removes a NamedFilterListener to be notified about changes.

Parameters:

listener - the listener

canShow

public boolean canShow(@NotNull
                       GameObject<?,?,?> gameObject,
                       @NotNull
                       NamedFilterConfig filterOutConfig)

Returns whether this filter matches a GameObject.

Parameters:

gameObject - the game object

filterOutConfig - the filter config to use

Returns:

whether this filter matches the game object