org.gephi.filters.spi

Interface Filter

All Known Subinterfaces:

ComplexFilter, EdgeFilter, ElementFilter<K>, NodeFilter, Operator, RangeFilter

public interface Filter

Filters are pruning the graph by keeping only nodes and edges that satisfy filters conditions. Filters are predicates or functions that reduce the graph and therefore create sub-graphs.

Filters are the basic building blocks that are wrapped in queries and assembled to make simple or complex conditions on nodes and edges.

Filters objects are built in FilterBuilder. Implementors should define their own FilterBuilder class to propose new filter to users.

Author:

Mathieu Bastian

See Also:

Query

Method Summary

Modifier and Type	Method and Description
String	getName() Returns the filter's display name.
FilterProperty[]	getProperties() Returns the filter properties.

Method Detail

getName

String getName()

Returns the filter's display name.

Returns:

the filter's display name

getProperties

FilterProperty[] getProperties()

Returns the filter properties. Property values can be get and set from FilterProperty objects.

Returns:

the filter's properties