Gephi Toolkit Javadoc

org.gephi.filters.spi
Interface Filter

All Known Subinterfaces:
AttributableFilter, ComplexFilter, EdgeFilter, NodeFilter, Operator, RangeFilter
All Known Implementing Classes:
AbstractAttributeFilter, AbstractFilter, AttributeEqualBuilder.EqualBooleanFilter, AttributeEqualBuilder.EqualNumberFilter, AttributeEqualBuilder.EqualStringFilter, AttributeNonNullBuilder.AttributeNonNullFilter, AttributeRangeBuilder.AttributeRangeFilter, DegreeRangeBuilder.DegreeRangeFilter, DynamicRangeBuilder.DynamicRangeFilter, EdgeWeightBuilder.EdgeWeightFilter, EgoBuilder.EgoFilter, FlattenBuilder.FlattenFilter, GiantComponentBuilder.GiantComponentFilter, InDegreeRangeBuilder.InDegreeRangeFilter, InterEdgesBuilder.InterEdgesFilter, INTERSECTIONBuilder.IntersectionOperator, IntraEdgesBuilder.IntraEdgesFilter, KCoreBuilder.KCoreFilter, LevelBuilder.LevelFilter, MASKBuilderEdge.MaskEdgeOperator, MutualDegreeRangeBuilder.MutualDegreeRangeFilter, NeighborsBuilder.NeighborsFilter, NOTBuilderEdge.NotOperatorEdge, NOTBuilderNode.NOTOperatorNode, OutDegreeRangeBuilder.OutDegreeRangeFilter, PartitionBuilder.EdgePartitionFilter, PartitionBuilder.NodePartitionFilter, PartitionBuilder.PartitionFilter, PartitionCountBuilder.PartitionCountFilter, SelfLoopFilterBuilder.SelfLoopFilter, UNIONBuilder.UnionOperator

public interface Filter

Filters are pruning the graph by keeping only nodes and edges that satisify 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
 java.lang.String getName()
          Returns the filter's display name.
 FilterProperty[] getProperties()
          Returns the filter properties.
 

Method Detail

getName

java.lang.String getName()
Returns the filter's display name.

Returns:
the filter's dispaly name

getProperties

FilterProperty[] getProperties()
Returns the filter properties. Property values can be get and set from FilterProperty objects.

Returns:
the filter's properties

Gephi Toolkit Javadoc