org.ginsim.core.graph.view.css

Class Selector

java.lang.Object

org.ginsim.core.graph.view.css.Selector

Direct Known Subclasses:

AllSelector, PolytopesSelector

public abstract class Selector
extends Object

A Selector implementation for GINsim. It intend to be similar to selectors in HTML's CSS.

Author:

Duncan Berenguier

Field Summary

Fields

Modifier and Type	Field and Description
protected String	identifier
protected static Map	selectors

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Selector(String identifier)

Method Summary

Modifier and Type	Method and Description
protected void	addCategory(String category, CSSStyle defaultStyle) Declare a new category responding to this selector
boolean	applyStyleForEdge(Object obj, AttributesReader areader) Apply the style to an edge using an attributesReder for a category id or null if the category doesn't exist.
boolean	applyStyleForNode(Object obj, AttributesReader areader) Apply the style to a node using an attributesReder for a category id or null if the category doesn't exist.
Collection	categories() A collection of all the categories this selector respond to.
void	flush() By default this does nothing but subclasses of Selector could use this function to free the cache of category<=>object.
String	getCategory(Object obj) Return the category corresponding to the object obj or null if it doesn't respond to any.
protected abstract String	getCategoryForEdge(Object obj) Return the category corresponding to the object obj or null if it doesn't respond to any.
protected abstract String	getCategoryForNode(Object obj) Return the category corresponding to the object obj or null if it doesn't respond to any.
String	getIdentifer() Return the identifier for this selector
static Selector	getNewSelector(String identifier) return a new selector corresponding to an identifier
CSSStyle	getStyle(Object obj) Get the style for an object using getCategory to determine its category or null if the category doesn't exist or has no category If possible call getStyleForNode or getStyleForEdge, when you know the type of object
CSSStyle	getStyle(String category) Get the style for a category id or null if the category doesn't exist.
CSSStyle	getStyleForEdge(Object obj) Get the style for an edge using getCategory to determine its category or null if the category doesn't exist or has no category
CSSStyle	getStyleForNode(Object obj) Get the style for a node using getCategory to determine its category or null if the category doesn't exist or has no category
protected CSSStyle	missingCategory(String category) Called when the category doesn't exist in the map.
protected boolean	missingCategory(String category, AttributesReader areader) Called when the category doesn't exist in the map.
protected boolean	missingCategory(String category, CSSStyle style) Called when the category doesn't exist in the map.
static void	registerSelector(String identifier, Class cla) Register your selector to enable parsing it.
abstract void	resetDefaultStyle() Reset the categories to their default values.
boolean	respondToEdges() Indicates if the Selector contains edges styles.
boolean	respondToNodes() Indicates if the Selector contains nodes styles.
boolean	setStyle(String category, CSSStyle style) Set the style for a category id.
String	toCSS()
String	toString()
String	toString(String category)

Methods inherited from class java.lang.Object

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

Field Detail

selectors

protected static Map selectors

identifier

protected String identifier

Constructor Detail

Selector

protected Selector(String identifier)

Method Detail

registerSelector

public static void registerSelector(String identifier,
                                    Class cla)

Register your selector to enable parsing it.

Parameters:

identifier - the identifier of the selector

cla - the selector's class

getNewSelector

public static Selector getNewSelector(String identifier)

return a new selector corresponding to an identifier

Parameters:

id - the identifier

Returns:

a new selector with identifier id or null if the class doesn't exists or can't be instantiated.

getIdentifer

public final String getIdentifer()

Return the identifier for this selector

Returns:

identifier

categories

public final Collection categories()

A collection of all the categories this selector respond to.

Returns:

the categories id

getStyle

public CSSStyle getStyle(String category)

Get the style for a category id or null if the category doesn't exist.

Parameters:

category - the id of the category

Returns:

the default style

getStyle

public CSSStyle getStyle(Object obj)

Get the style for an object using getCategory to determine its category or null if the category doesn't exist or has no category If possible call getStyleForNode or getStyleForEdge, when you know the type of object

Parameters:

obj -

Returns:

the default style for this object

getStyleForNode

public final CSSStyle getStyleForNode(Object obj)

Get the style for a node using getCategory to determine its category or null if the category doesn't exist or has no category

Parameters:

obj - a node

Returns:

the default style for this object

getStyleForEdge

public final CSSStyle getStyleForEdge(Object obj)

Get the style for an edge using getCategory to determine its category or null if the category doesn't exist or has no category

Parameters:

obj - an edge

Returns:

the default style for this object

setStyle

public final boolean setStyle(String category,
                              CSSStyle style)

Set the style for a category id.

Parameters:

category - the id of the category

Returns:

false if the category doesn't exists

applyStyleForNode

public final boolean applyStyleForNode(Object obj,
                                       AttributesReader areader)

Apply the style to a node using an attributesReder for a category id or null if the category doesn't exist.

Parameters:

obj - a node

Returns:

false if the category doesn't exist

applyStyleForEdge

public final boolean applyStyleForEdge(Object obj,
                                       AttributesReader areader)

Apply the style to an edge using an attributesReder for a category id or null if the category doesn't exist.

Parameters:

obj - an edge

Returns:

false if the category doesn't exist

addCategory

protected void addCategory(String category,
                           CSSStyle defaultStyle)

Declare a new category responding to this selector

Parameters:

category - the identifier for this category

defaultStyle - its default style

resetDefaultStyle

public abstract void resetDefaultStyle()

Reset the categories to their default values.

missingCategory

protected CSSStyle missingCategory(String category)

Called when the category doesn't exist in the map.

Parameters:

category -

Returns:

null

missingCategory

protected boolean missingCategory(String category,
                                  AttributesReader areader)

Called when the category doesn't exist in the map.

Parameters:

category -

areader - the areader to apply the corresponding style on.

Returns:

false

missingCategory

protected boolean missingCategory(String category,
                                  CSSStyle style)

Called when the category doesn't exist in the map.

Parameters:

category -

style - the style to save for this category

Returns:

false

respondToNodes

public boolean respondToNodes()

Indicates if the Selector contains nodes styles. True by default, you should override this function if the selector doesn't respond to Nodes.

Returns:

true

respondToEdges

public boolean respondToEdges()

Indicates if the Selector contains edges styles. True by default, you should override this function if the selector doesn't respond to Nodes.

Returns:

true

getCategory

public final String getCategory(Object obj)

Return the category corresponding to the object obj or null if it doesn't respond to any. If possible call getCategoryForNode or getCategoryForEdge, when you know the type of object

Parameters:

obj -

Returns:

the associated category or null

getCategoryForNode

protected abstract String getCategoryForNode(Object obj)

Return the category corresponding to the object obj or null if it doesn't respond to any. When subclassing Selector you should use a cache system if you can't get the category for an object in a constant time. And therefore also extend the function flush() to empty this cache (set to to null).

Parameters:

obj -

Returns:

the associated category or null

getCategoryForEdge

protected abstract String getCategoryForEdge(Object obj)

Return the category corresponding to the object obj or null if it doesn't respond to any. When subclassing Selector you should use a cache system if you can't get the category for an object in a constant time. And therefore also extend the function flush() to empty this cache (set to to null).

Parameters:

obj -

Returns:

the associated category or null

flush

public void flush()

By default this does nothing but subclasses of Selector could use this function to free the cache of category<=>object. Should only be called if you are sure you doesn't need to use getCategory on this selector anymore.

toString

public final String toString()

Overrides:

toString in class Object

toString

public final String toString(String category)

toCSS

public final String toCSS()