org.gephi.filters

Class FilterLibraryImpl

java.lang.Object

org.gephi.filters.FilterLibraryImpl

All Implemented Interfaces:

FilterLibrary, org.openide.util.Lookup.Provider

public class FilterLibraryImpl
extends Object
implements FilterLibrary

Author:

Mathieu Bastian

Field Summary

Fields inherited from interface org.gephi.filters.api.FilterLibrary

ATTRIBUTES, EDGE, TOPOLOGY

Constructor Summary

Constructors

Constructor and Description
FilterLibraryImpl(Workspace workspace)

Method Summary

Modifier and Type	Method and Description
void	addBuilder(FilterBuilder builder) Adds builder to this library.
void	deleteQuery(Query query) Delete a saved query from the library.
FilterBuilder	getBuilder(Filter filter) Returns the builder that has created filter.
org.openide.util.Lookup	getLookup() Returns this library's lookup.
void	registerMask(FilterLibraryMask mask) Registers mask as a new FilterLibraryMask.
void	removeBuilder(FilterBuilder builder) Removes builder from this library.
void	saveQuery(Query query) Save query in the library in order it can be reused.
void	unregisterMask(FilterLibraryMask mask) Unregisters mask in the library.

Methods inherited from class java.lang.Object

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

Constructor Detail

FilterLibraryImpl

public FilterLibraryImpl(Workspace workspace)

Method Detail

getLookup

public org.openide.util.Lookup getLookup()

Description copied from interface: FilterLibrary

Returns this library's lookup. The lookup is a general container for objects and contains:

• FilterBuilder: Builders, these are building filters.
• CategoryBuilder: Category builders, these are building. categories, i.e. filters containers.
• FilterLibraryMask: Masks, for enable/disable categories according to the context.
• Query: Saved queries, look at FilterController for active queries.

The lists of all FilterBuilder in the library can be obtained by doing the following command:

 FilterLibrary.getLookup().lookupAll(FilterBuilder.class);
 

Specified by:

getLookup in interface FilterLibrary

Specified by:

getLookup in interface org.openide.util.Lookup.Provider

Returns:

the lookup container of this library

addBuilder

public void addBuilder(FilterBuilder builder)

Description copied from interface: FilterLibrary

Adds builder to this library.

Specified by:

addBuilder in interface FilterLibrary

Parameters:

builder - the builder that is to be added

removeBuilder

public void removeBuilder(FilterBuilder builder)

Description copied from interface: FilterLibrary

Removes builder from this library.

Specified by:

removeBuilder in interface FilterLibrary

Parameters:

builder - the builder that is to be removed

registerMask

public void registerMask(FilterLibraryMask mask)

Description copied from interface: FilterLibrary

Registers mask as a new FilterLibraryMask. Such masks have categories enable/disable flag. Useful to disable for instance filters for undirected graphs when the current graph is directed.

Specified by:

registerMask in interface FilterLibrary

Parameters:

mask - the mask that is to be registered

unregisterMask

public void unregisterMask(FilterLibraryMask mask)

Description copied from interface: FilterLibrary

Unregisters mask in the library. The mask will no longer be used.

Specified by:

unregisterMask in interface FilterLibrary

Parameters:

mask - the mask that is to be unregistered

getBuilder

public FilterBuilder getBuilder(Filter filter)

Description copied from interface: FilterLibrary

Returns the builder that has created filter.

Specified by:

getBuilder in interface FilterLibrary

Parameters:

filter - the filter that the builder is to be returned

Returns:

the builder that has created filter

saveQuery

public void saveQuery(Query query)

Description copied from interface: FilterLibrary

Save query in the library in order it can be reused. Saved queries are saved to the project.

Specified by:

saveQuery in interface FilterLibrary

Parameters:

query - the query that is to be saved

deleteQuery

public void deleteQuery(Query query)

Description copied from interface: FilterLibrary

Delete a saved query from the library. Deleted queries are deleted from the project.

Specified by:

deleteQuery in interface FilterLibrary

Parameters:

query - the query that is to be deleted