org.ascape.util.vis
Interface EntityFeature

All Superinterfaces:

ColorFeature, HasName

All Known Implementing Classes:

DefaultEntityFeature

public interface EntityFeature
extends ColorFeature

An interface for classes which define the Entity rendering hints of an entity relation graphical view.

Since:

2.9

Version:

2.9

Author:

Roger Critchlow

Method Summary

java.awt.Color	getBorderColor(java.lang.Object entity) Gets the borderColor for the EntityFeature object.
java.awt.Color	getColor(java.lang.Object entity) Gets the color for the EntityFeature object.
ERVDerivedFontMap	getDerivedFontMap() Returns the derived font map used by all entities in this view.
double	getHeight(java.lang.Object entity) Returns the double value which should be interpolated into the min and max height to decide the size of this entity.
double	getMaxNormedHeight(java.lang.Object entity) Returns the maximum normalized height of the entity.
double	getMinNormedHeight(java.lang.Object entity) Returns the minimum normalized height of the entity.
java.lang.String	getName() Returns the name of this feature.
java.awt.geom.Point2D.Double	getPosition(java.lang.Object entity) Returns the normalized position of the entity.
java.awt.geom.RectangularShape	getShape(java.lang.Object entity) Describe getShape method here.
java.lang.Class	getShapeClass(java.lang.Object entity) Returns the shape class of the entity
java.lang.String	getText(java.lang.Object entity) Returns the text string for this entity.
boolean	includesEntity(java.lang.Object entity) Answers whether this entity should be rendered.
java.util.Iterator	iterator() Returns an iteration over the entities herein featured.

Method Detail

getName

java.lang.String getName()

Returns the name of this feature.

Specified by:

getName in interface HasName

Returns:

a String value

includesEntity

boolean includesEntity(java.lang.Object entity)

Answers whether this entity should be rendered.

Parameters:

entity - the object of interest.

Returns:

a boolean

iterator

java.util.Iterator iterator()

Returns an iteration over the entities herein featured.

Returns:

an iterator over the entities.

getDerivedFontMap

ERVDerivedFontMap getDerivedFontMap()

Returns the derived font map used by all entities in this view.

Returns:

the ERVDerivedFontMap

getShapeClass

java.lang.Class getShapeClass(java.lang.Object entity)

Returns the shape class of the entity

Parameters:

entity - the object of interest.

Returns:

the shapeClass

getShape

java.awt.geom.RectangularShape getShape(java.lang.Object entity)

Describe getShape method here.

Parameters:

entity - an Object value

Returns:

a RectangularShape value

getPosition

java.awt.geom.Point2D.Double getPosition(java.lang.Object entity)

Returns the normalized position of the entity.

Parameters:

entity - the object of interest.

Returns:

the position

getMinNormedHeight

double getMinNormedHeight(java.lang.Object entity)

Returns the minimum normalized height of the entity.

Parameters:

entity - the object of interest.

Returns:

the minNormedHeight

getMaxNormedHeight

double getMaxNormedHeight(java.lang.Object entity)

Returns the maximum normalized height of the entity.

Parameters:

entity - the object of interest.

Returns:

the maxNormedHeight

getHeight

double getHeight(java.lang.Object entity)

Returns the double value which should be interpolated into the min and max height to decide the size of this entity.

Parameters:

entity - the object of interest.

Returns:

the height

getColor

java.awt.Color getColor(java.lang.Object entity)

Gets the color for the EntityFeature object.

Specified by:

getColor in interface ColorFeature

Parameters:

entity - parameter

Returns:

the color

getBorderColor

java.awt.Color getBorderColor(java.lang.Object entity)

Gets the borderColor for the EntityFeature object.

Parameters:

entity - parameter

Returns:

the borderColor

getText

java.lang.String getText(java.lang.Object entity)

Returns the text string for this entity.

Parameters:

entity - the object of interest.

Returns:

the text