org.gephi.filters.api

Interface FilterModel

public interface FilterModel

The Filter Model hosts the queries defined in the system and the currently active query. It also stroe the selection or filtering flag. The filtering mode display the subgraph made from filters, whereas the selection mode highlight elements on the graph.

Author:

Mathieu Bastian

See Also:

FilterController

Method Summary

Modifier and Type	Method and Description
void	addChangeListener(ChangeListener listener)
Query	getCurrentQuery() Returns the query currently active or null if none is active.
FilterLibrary	getLibrary() Returns the FilterLibrary, where FilterBuilder belongs to.
Query[]	getQueries() Returns all queries in the model, represented by their root query.
boolean	isAutoRefresh()
boolean	isFiltering() Returns true if the system is currently in filtering mode.
boolean	isSelecting() Returns true if the system is currently in selection mode.
void	removeChangeListener(ChangeListener listener)

Method Detail

getLibrary

FilterLibrary getLibrary()

Returns the FilterLibrary, where FilterBuilder belongs to.

Returns:

the filter library

getQueries

Query[] getQueries()

Returns all queries in the model, represented by their root query.

Returns:

all root queries in the model

getCurrentQuery

Query getCurrentQuery()

Returns the query currently active or null if none is active.

Returns:

the current query

isFiltering

boolean isFiltering()

Returns true if the system is currently in filtering mode.

Returns:

true if the result graph is filtered, false if it's in selection mode

isSelecting

boolean isSelecting()

Returns true if the system is currently in selection mode.

Returns:

true if the result is selected on the graph, false if it's filtered

isAutoRefresh

boolean isAutoRefresh()

addChangeListener

void addChangeListener(ChangeListener listener)

removeChangeListener

void removeChangeListener(ChangeListener listener)