org.cytoscape.filter.model

Interface CompositeFilter<C,E>

Type Parameters:

C - The context type of the elements this Filter operates on.

E - The element type this Filter operates on.

All Superinterfaces:

Filter<C,E>, Transformer<C,E>

public interface CompositeFilter<C,E>
extends Filter<C,E>

A Filter that computes the set-union or set-intersection of the Filters it contains. The ordering of the child filters does not affect the final output of this filter, but may impact performance.

Cytoscape Backwards Compatibility (API Interface): We expect that this interface will be used but not implemented by developers using this interface. As such, we reserve the right to add methods to the interface as part of minor version upgrades. We will not remove methods for any changes other than major version upgrades.

Module: filter-api

To use this in your app, include the following dependency in your POM:

<dependency>
    <groupId>org.cytoscape</groupId>
    <artifactId>filter-api</artifactId>
</dependency>

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CompositeFilter.Type Determines how a CompositeFilter combines the results of its contained Filters.

Method Summary

Modifier and Type	Method and Description
void	append(Filter<C,E> filter) Appends filter to the list of children.
Filter<C,E>	get(int index) Returns the Filter at the given index.
int	getLength() Returns the number of direct children Filters contained by this CompositeFilter.
CompositeFilter.Type	getType() Returns the type of combining semantics used by this filter.
int	indexOf(Filter<C,E> filter) Returns the index of filter within the list of children, or -1 if filter is not in that list.
void	insert(int index, Filter<C,E> filter) Inserts filter at the given index within the list of children.
Filter<C,E>	remove(int index) Removes the Filter at the given index from the list of children and returns in.
void	setType(CompositeFilter.Type type) Sets the type of combining semantics used by this filter.

Methods inherited from interface org.cytoscape.filter.model.Filter

accepts

Methods inherited from interface org.cytoscape.filter.model.Transformer

addListener, getContextType, getElementType, getId, getName, removeListener

Method Detail

append

void append(Filter<C,E> filter)

Appends filter to the list of children.

Parameters:

filter - the Filter to add.

insert

void insert(int index,
            Filter<C,E> filter)

Inserts filter at the given index within the list of children.

Parameters:

index - the index where the filter should be inserted.

filter - the Filter to add.

get

Filter<C,E> get(int index)

Returns the Filter at the given index.

Parameters:

index - the index of the Filter to get.

Returns:

the Filter at the given index.

remove

Filter<C,E> remove(int index)

Removes the Filter at the given index from the list of children and returns in.

Parameters:

index - the index of the Filter to get.

Returns:

the Filter at the given index.

indexOf

int indexOf(Filter<C,E> filter)

Returns the index of filter within the list of children, or -1 if filter is not in that list.

Parameters:

filter - the filter whose index should be looked up.

Returns:

the index of filter or -1 if it cannot be found.

getLength

int getLength()

Returns the number of direct children Filters contained by this CompositeFilter.

Returns:

the number of direct children.

getType

CompositeFilter.Type getType()

Returns the type of combining semantics used by this filter.

Returns:

the type of combining semantics used by this filter.

setType

void setType(CompositeFilter.Type type)

Sets the type of combining semantics used by this filter.

Parameters:

type - the combining semantics to use.