uk.ac.ebi.intact.application.hierarchView.highlightment.behaviour
Class HighlightmentBehaviour

java.lang.Object
  |
  +--uk.ac.ebi.intact.application.hierarchView.highlightment.behaviour.HighlightmentBehaviour

Direct Known Subclasses:

ColorHighlightmentBehaviour, VisibleHighlightmentBehaviour

public abstract class HighlightmentBehaviour

extends java.lang.Object

Abstract class allowing to deals with the Highlightment behaviour, the implementation of that class would just specify the behaviour of one node of the graph.

Version:

$Id: HighlightmentBehaviour.java,v 1.10 2003/11/13 14:21:43 skerrien Exp $

Author:

Samuel Kerrien (skerrien@ebi.ac.uk)

Constructor Summary

HighlightmentBehaviour()

Method Summary

void	apply(java.util.Collection proteins, InteractionNetwork aGraph) Apply the implemented behaviour to a set of nodes.
abstract void	applyBehaviour(Node aProtein) Apply the implemented behaviour to the specific Node of the graph
static HighlightmentBehaviour	getHighlightmentBehaviour(java.lang.String aClassName) Provides a implementation of HighlightmentBehaviour from its name. for example you have an implementation of this abstract class called : ColorHighlightmentBehaviour.
java.util.Collection	modifyCollection(java.util.Collection proteins, InteractionNetwork aGraph) Allow to apply a modification on the collection of protein to highlight.

Methods inherited from class java.lang.Object

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

Constructor Detail

HighlightmentBehaviour

public HighlightmentBehaviour()

Method Detail

getHighlightmentBehaviour

public static HighlightmentBehaviour getHighlightmentBehaviour(java.lang.String aClassName)

Provides a implementation of HighlightmentBehaviour from its name.
for example you have an implementation of this abstract class called : ColorHighlightmentBehaviour. so, you could call the following method to get an instance of this class :
HighlightmentBehaviour.getHighlightmentBehaviour ("mypackage.ColorHighlightmentBehaviour");
then you're able to use methods provided by this abstract class without to know what implementation you are using.

Parameters:

aClassName - the name of the implementation class you want to get

Returns:

an HighlightmentBehaviour object, or null if an error occurs.

applyBehaviour

public abstract void applyBehaviour(Node aProtein)

Apply the implemented behaviour to the specific Node of the graph

Parameters:

aProtein - the node on which we want to apply the behaviour

modifyCollection

public java.util.Collection modifyCollection(java.util.Collection proteins,
                                             InteractionNetwork aGraph)

Allow to apply a modification on the collection of protein to highlight. for example select all the graph proteins which are not in the given collection The default behaviour of that method is to return the given Collection, to change that you have to overwrite that method in your implementation.

Parameters:

proteins - the list of protein to highlight

aGraph - the current interaction network

Returns:

the new collection of protein to highlight

apply

public void apply(java.util.Collection proteins,
                  InteractionNetwork aGraph)

Apply the implemented behaviour to a set of nodes.

Parameters:

proteins - the set of protein on which to apply the behaviour

aGraph - the interaction network they come from