oracle.adf.view.faces.bi.component.thematicMap.mapProvider

Class LayerArea

java.lang.Object

oracle.adf.view.faces.bi.component.thematicMap.mapProvider.LayerArea

public abstract class LayerArea
extends java.lang.Object

An abstract class for storing the information needed to draw an area for an area layer.

Constructor Summary

Constructors

Constructor and Description
LayerArea()

Method Summary

Modifier and Type	Method and Description
abstract java.lang.String	getId() Returns the Id for this area which will be used to match data to this area.
abstract java.awt.geom.Rectangle2D	getLabelBox() Returns the Rectangle bounding box for this area's label or null if the area's bounding box should be used.
abstract java.lang.String	getLongLabel() Returns the long label for this area or null if none exists.
abstract java.lang.String	getParent() Returns the Id of this area's parent within this basemap's layer hierarchy or null if no parent exists.
abstract java.lang.String	getPath() Returns the String representing the SVG path for this area.
abstract java.lang.String	getShortLabel() Returns the short abbreviated label for this area or null if none exists.

Methods inherited from class java.lang.Object

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

Constructor Detail

LayerArea

public LayerArea()

Method Detail

getId

public abstract java.lang.String getId()

Returns the Id for this area which will be used to match data to this area.

Returns:

the String respresenting the Id for this area.

getShortLabel

public abstract java.lang.String getShortLabel()

Returns the short abbreviated label for this area or null if none exists.

Returns:

the String representing the short label for this area or null.

getLongLabel

public abstract java.lang.String getLongLabel()

Returns the long label for this area or null if none exists.

Returns:

the String representing the long label for this area or null.

getLabelBox

public abstract java.awt.geom.Rectangle2D getLabelBox()

Returns the Rectangle bounding box for this area's label or null if the area's bounding box should be used.

Returns:

the Rectangle bounding box for this area's label or null.

getPath

public abstract java.lang.String getPath()

Returns the String representing the SVG path for this area. It is recommended that relative commands be used and h/v commands used instead of l commands when possible.

Returns:

the String representing the SVG path commands for this area.

getParent

public abstract java.lang.String getParent()

Returns the Id of this area's parent within this basemap's layer hierarchy or null if no parent exists.

Returns:

the String Id of this area's parent or null.