Package org.gephi.filters.spi

Interfaces for creating new filter classes.

See: Description

Interface Summary

Interface	Description
CategoryBuilder	Category builder is a convenient way to define multiple builders from a single source and grouped in a single category.
ComplexFilter	Filter working with full graphs and generally returning a subgraph.
EdgeFilter	Basic filters for edges, that works as predicates.
ElementFilter<K extends Element>	Basic filters for elements (nodes or edges).
Filter	Filters are pruning the graph by keeping only nodes and edges that satisfy filters conditions.
FilterBuilder	Filter builder, creating Filter instances for a single type of filters.
FilterLibraryMask	Classes that implements this interface can be registered to the filter library to programmatically enable or disable categories, i.e.
NodeFilter	Basic filters for nodes, that works as predicates.
Operator
RangeFilter

Class Summary

Class	Description
Category	A filter category is like a folder, it describes the type of the filter and bring together to users filters that have the same categories.
FilterProperty	Properties for filters.

Package org.gephi.filters.spi Description

Interfaces for creating new filter classes.

Create a new Filter

1. Create a new module and set FilterAPI, GraphAPI and UtilitiesAPI as dependencies.
2. Create a new builder class by implementing FilterBuilder, this class is basically a factory that will create filter instances on demand.
3. Add @ServiceProvider annotation to your builder, that it can be found by the system. Set FilterBuilder as the annotation parameter.
4. Create a new class that implements either NodeFilter, EdgeFilter or ComplexFilter.
5. Fill getProperties() method in your filter, it should expose all properies that can be set by users and have an influence on the filter execution.
6. If you need a user interface for your filter, fill getPanel() method in the builder.