org.gephi.filters

Class FilterControllerImpl

java.lang.Object

org.gephi.filters.FilterControllerImpl

All Implemented Interfaces:

FilterController, PropertyExecutor

public class FilterControllerImpl
extends Object
implements FilterController, PropertyExecutor

Author:

Mathieu Bastian

Nested Class Summary

Nested classes/interfaces inherited from interface org.gephi.filters.api.PropertyExecutor

PropertyExecutor.Callback

Constructor Summary

Constructors

Constructor and Description
FilterControllerImpl()

Method Summary

Modifier and Type	Method and Description
void	add(Query query) Adds query as a new query in the system.
Query	createQuery(Filter filter) Creates a query from filter.
Query	createQuery(FilterBuilder builder) Creates a query from builder.
void	exportToColumn(String title, Query query) Exports query result in a new column title.
void	exportToLabelVisible(Query query) Exports query result to visible/hidden labels.
void	exportToNewWorkspace(Query query) Exports query result in a new workspace.
org.gephi.graph.api.GraphView	filter(Query query) Filtering method for API users.
void	filterVisible(Query query) Filters main graph with query and set result as the new visible graph.
FilterModel	getModel() Returns the filter's model.
FilterModel	getModel(Workspace workspace) Returns the filter's model for workspace.
void	remove(Query query) Removes query from the system if exists.
void	removeSubQuery(Query query, Query parent) Removes query from parent query.
void	rename(Query query, String name) Renames query with name.
void	selectVisible(Query query) Selects query results on the main graph visualization window.
void	setAutoRefresh(boolean autoRefresh)
void	setCurrentQuery(Query query)
void	setSubQuery(Query query, Query subQuery) Sets subQuery as a child of query.
void	setValue(FilterProperty property, Object value, PropertyExecutor.Callback callback) Set value on property in a safe way by using callback.

Methods inherited from class java.lang.Object

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

Constructor Detail

FilterControllerImpl

public FilterControllerImpl()

Method Detail

createQuery

public Query createQuery(FilterBuilder builder)

Description copied from interface: FilterController

Creates a query from builder. The created query is a root query.

Specified by:

createQuery in interface FilterController

Parameters:

builder - the builder that can create the filter that is to be wrapped in a new query

Returns:

a query that is wrapping builder

createQuery

public Query createQuery(Filter filter)

Description copied from interface: FilterController

Creates a query from filter. The created query is a root query.

Specified by:

createQuery in interface FilterController

Parameters:

filter - the filter that is to be wrapped in a new query

Returns:

a query that is wrapping filter

add

public void add(Query query)

Description copied from interface: FilterController

Adds query as a new query in the system. The query should be a root query.

Specified by:

add in interface FilterController

Parameters:

query - the query that is to be added

remove

public void remove(Query query)

Description copied from interface: FilterController

Removes query from the system if exists.

Specified by:

remove in interface FilterController

Parameters:

query - the query that is to be removed

rename

public void rename(Query query,
                   String name)

Description copied from interface: FilterController

Renames query with name.

Specified by:

rename in interface FilterController

Parameters:

query - the query that is to be renamed

name - the new query's name

setSubQuery

public void setSubQuery(Query query,
                        Query subQuery)

Description copied from interface: FilterController

Sets subQuery as a child of query. If subQuery already has a parent query, it will be removed first.

Specified by:

setSubQuery in interface FilterController

Parameters:

query - the query that subQuery is to be added as a new child

subQuery - the query that is to be added as a child of query

removeSubQuery

public void removeSubQuery(Query query,
                           Query parent)

Description copied from interface: FilterController

Removes query from parent query.

Specified by:

removeSubQuery in interface FilterController

Parameters:

query - the query that is to be removed from parent

parent - the query that query is to be removed as a child

filterVisible

public void filterVisible(Query query)

Description copied from interface: FilterController

Filters main graph with query and set result as the new visible graph. Note that the query will be executed in a background thread and results delivered as soon as ready. Then, query is defined as the currently active query and property's value changes are watched. If a query's property is changed the query is automatically reexecuted.

Specified by:

filterVisible in interface FilterController

Parameters:

query - the query that is to be executed

filter

public org.gephi.graph.api.GraphView filter(Query query)

Description copied from interface: FilterController

Filtering method for API users. The query is executed and the GraphView result is returned.

Specified by:

filter in interface FilterController

Parameters:

query - the query that is to be executed

Returns:

a graph view that represents the query result

selectVisible

public void selectVisible(Query query)

Description copied from interface: FilterController

Selects query results on the main graph visualization window. Note that the query will be executed in a background thread and results delivered as soon as ready. Then, query is defined as the currently active query and property's value changes are watched. If a query's property is changed the query is automatically reexecuted.

Specified by:

selectVisible in interface FilterController

Parameters:

query - the query that is to be executed

exportToColumn

public void exportToColumn(String title,
                           Query query)

Description copied from interface: FilterController

Exports query result in a new column title. Nodes and edges that pass the query have true value and false for others.

Specified by:

exportToColumn in interface FilterController

Parameters:

title - the column's title

query - the query that is to be executed

exportToNewWorkspace

public void exportToNewWorkspace(Query query)

Description copied from interface: FilterController

Exports query result in a new workspace. Note that query is executed in a separate thread and the workspace may not be ready immediately when this method returns.

Specified by:

exportToNewWorkspace in interface FilterController

Parameters:

query - the query that is to be executed

exportToLabelVisible

public void exportToLabelVisible(Query query)

Description copied from interface: FilterController

Exports query result to visible/hidden labels. Each node and edge not present in the query result has its label set hidden. Label visibility is controlled from TextData object, accessible from NodeData or EdgeData.

Specified by:

exportToLabelVisible in interface FilterController

Parameters:

query - the query that is to be used to hide labels

setAutoRefresh

public void setAutoRefresh(boolean autoRefresh)

Specified by:

setAutoRefresh in interface FilterController

setCurrentQuery

public void setCurrentQuery(Query query)

Specified by:

setCurrentQuery in interface FilterController

getModel

public FilterModel getModel()

Description copied from interface: FilterController

Returns the filter's model.

Specified by:

getModel in interface FilterController

Returns:

the filter's model

getModel

public FilterModel getModel(Workspace workspace)

Description copied from interface: FilterController

Returns the filter's model for workspace.

Specified by:

getModel in interface FilterController

Parameters:

workspace - workspace

Returns:

the filter's model in the given workspace

setValue

public void setValue(FilterProperty property,
                     Object value,
                     PropertyExecutor.Callback callback)

Description copied from interface: PropertyExecutor

Set value on property in a safe way by using callback.

Specified by:

setValue in interface PropertyExecutor

Parameters:

property - the filter property that value is to be set

value - the value that is to be set

callback - the callback function to be notified when setting has to be done