oracle.spatial.network.nfe.vis.mapcanvas.render

Class NFENetworkRenderer

java.lang.Object

oracle.spatial.network.nfe.vis.maps.layer.BasicLayer

oracle.spatial.network.nfe.vis.mapcanvas.render.NFERenderer<NFENetworkElementGeoObject>

oracle.spatial.network.nfe.vis.mapcanvas.render.NFENetworkRenderer

All Implemented Interfaces:

java.util.EventListener, javax.swing.event.ChangeListener, NFEModelListener, BehavioralLayer, ManipulableLayer, VertexEditableLayer, GeoObjectLayer, HoverableLayer, Layer, SelectableLayer

public class NFENetworkRenderer
extends NFERenderer<NFENetworkElementGeoObject>
implements NFEModelListener, ManipulableLayer, VertexEditableLayer

Layer used for rendering network elements (nodes and links). It is automatically subscribed to the model's network to draw or erase network elements as they are added, modified or removed. Support is provided for manipulating network elements.

Field Summary

Fields inherited from interface oracle.spatial.network.nfe.model.event.NFEModelListener

METHOD_MODEL_OBJECT_ADDED, METHOD_MODEL_OBJECT_REMOVED, METHOD_MODEL_OBJECTS_ADDED, METHOD_MODEL_OBJECTS_REMOVED, METHOD_PROPERTY_CHANGED

Fields inherited from interface oracle.spatial.network.nfe.vis.mapcanvas.behavior.manipulate.ManipulableLayer

TRANS_NONE, TRANS_PULL, TRANS_TRANSLATE

Fields inherited from interface oracle.spatial.network.nfe.vis.maps.core.Layer

PROPERTY_NAME, PROPERTY_PROVIDERID, PROPERTY_SRID, PROPERTY_VISIBLE

Constructor Summary

Constructors

Constructor and Description
NFENetworkRenderer(MapCanvas canvas, NFEModel model) Allocates a new network renderer

Method Summary

Modifier and Type	Method and Description
void	addFeatureLayerRenderer(NFEFeatureLayerRenderer flRenderer) Associates a feature layer renderer
boolean	addVertex(GeoObject geoObj, JGeometrySegmentPoint snapPoint) Adds a vertex to the given GeoObject at the specified snap point
boolean	canAddVertex(GeoObject geoObj, JGeometrySegmentPoint snapPoint) Tells whether it is possible to add a new vertex to the GeoObject at the specified snap point
void	cancelManipulation(long manId) Cancels the given manipulation and releases all the resources related to it
boolean	finishManipulation(long manId, java.awt.geom.Point2D dataPoint) finishes the manipulation identified by the given id.
int	getApplicableTransformation(GeoObject geoObj, java.util.Collection<GeoObject> manGeoObjGroup, JGeometrySegmentPoint snapPoint) Gets manipulation available for the given GeoObject and its current snap point.
java.util.List<NFEFeatureLayerRenderer>	getFeatureLayerRenderers() Gets all the feature layer renderers associated
double[]	getHandlePoints(GeoObject geoObj) Gets the ordinates of the points from which a GeoObject can be manipulated
java.util.Collection<GeoObject>	getManipulableGeoObjects() Gets the layer's GeoObjects that can be manipulated
ManipulationPreview	getPreview(long manId) Gets a preview for a manipulation
JGeometrySegmentPoint	getSnapPoint(GeoObject geoObj, java.awt.geom.Point2D dataPoint, double tolerance) Gets the closer GeoObject's snap point to the given point using the tolerance specified
java.util.Collection<GeoObject>	getVertexEditableGeoObjects() Gets all the GeoObjects which vertices can be edited
double[]	getVertices(GeoObject geoObj) Gets all the vertices of the GeoObject
boolean	isHidden() Tells whether the layer is hidden
boolean	isShowFlow() Tells whether flow indicators are displayed for links
boolean	manipulate(long manId, java.awt.geom.Point2D dataPoint) Updates the state of a manipulation with the last point.
void	mapRegionChanged(MapRegionEvent e) When the associated canvas's map region is changed, this method is called to notify the layer of the change.
void	modelObjectAdded(NFEModelObjectEvent event) Invoked when a model object has been added
void	modelObjectPropertyChanged(NFEModelObjectPropertyChangedEvent event) Invoked when a model object's property has been changed
void	modelObjectRemoved(NFEModelObjectEvent event) Invoked when a model object has been removed
void	modelObjectsAdded(NFEModelObjectsEvent event) Invoked when one or more model objects have been added
void	modelObjectsRemoved(NFEModelObjectsEvent event) Invoked when one or more model objects have been removed
void	refresh() Refreshes the current data window
boolean	removeFeatureLayerRenderer(NFEFeatureLayerRenderer flRenderer) Removes the association to a feature layer renderer
long	render(java.awt.Graphics2D graphics) Renders the layer contents to the given Graphics.
void	setHidden(boolean hidden) Sets whether the layer is hidden or not
void	setShowFlow(boolean showFlow) Sets whether flow indicators are displayed for links
long	startManipulation(GeoObject geoObj, java.util.Collection<GeoObject> manGeoObjGroup, JGeometrySegmentPoint snapPoint, int transformation) Starts a manipulation session.
void	synchronizeWithModel() Refreshes the current state to refresh the state of the model's network

Methods inherited from class oracle.spatial.network.nfe.vis.mapcanvas.render.NFERenderer

addContextualMenuHandler, addSelectionListener, clear, clearHover, clearSelection, getDataMBR, getFullExtent, getGeoObject, getHover, getImageOpacityAlpha, getObject, getObjects, getSelection, getSelection, getSnapPoint, getTolerance, handleEvent, hitTest, hitTest, isHover, isSelected, numHovered, numSelected, refresh, removeContextualMenuHandler, removeSelectionListener, select, setHover, setImageOpacityAlpha, setSelection, stateChanged, unselect, update

Methods inherited from class oracle.spatial.network.nfe.vis.maps.layer.BasicLayer

added, addPropertyChangeListener, addPropertyChangeListener, fromXMLElement, getCanvas, getIcon, getName, getProperties, getProperty, getProperty, getPropertyChangeListeners, getPropertyChangeListeners, getProviderID, getSRID, isVisible, removed, removePropertyChangeListener, removePropertyChangeListener, repaint, setCanvas, setName, setProperty, setProviderID, setSRID, setVisible, toXMLElement

Methods inherited from class java.lang.Object

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

Methods inherited from interface oracle.spatial.network.nfe.vis.maps.core.Layer

added, fromXMLElement, getCanvas, getIcon, getName, getProviderID, getSRID, isVisible, removed, repaint, setCanvas, setName, setProviderID, setSRID, setVisible, toXMLElement

Constructor Detail

NFENetworkRenderer

public NFENetworkRenderer(MapCanvas canvas,
                          NFEModel model)

Allocates a new network renderer

Parameters:

canvas - the MapCanvas where the layer will be rendered

model - the model containing the network to be rendered

Method Detail

synchronizeWithModel

public void synchronizeWithModel()

Refreshes the current state to refresh the state of the model's network

isShowFlow

public boolean isShowFlow()

Tells whether flow indicators are displayed for links

Returns:

true if flow is shown

setShowFlow

public void setShowFlow(boolean showFlow)

Sets whether flow indicators are displayed for links

Parameters:

showFlow - true if flow should be shown

getFeatureLayerRenderers

public java.util.List<NFEFeatureLayerRenderer> getFeatureLayerRenderers()

Gets all the feature layer renderers associated

Returns:

a list of feature layer renderers

addFeatureLayerRenderer

public void addFeatureLayerRenderer(NFEFeatureLayerRenderer flRenderer)

Associates a feature layer renderer

Parameters:

flRenderer - a feature layer renderer

removeFeatureLayerRenderer

public boolean removeFeatureLayerRenderer(NFEFeatureLayerRenderer flRenderer)

Removes the association to a feature layer renderer

Parameters:

flRenderer - a feature layer renderer

Returns:

true if the association was removed

isHidden

public boolean isHidden()

Tells whether the layer is hidden

Returns:

true if it is hidden

setHidden

public void setHidden(boolean hidden)

Sets whether the layer is hidden or not

Parameters:

hidden - true if it should be hidden

refresh

public void refresh()

Description copied from class: NFERenderer

Refreshes the current data window

Specified by:

refresh in interface BehavioralLayer

Overrides:

refresh in class NFERenderer<NFENetworkElementGeoObject>

mapRegionChanged

public void mapRegionChanged(MapRegionEvent e)

Description copied from interface: Layer

When the associated canvas's map region is changed, this method is called to notify the layer of the change. Note that either a device window change (as a result of resizing the application window) or a data window change can cause this method to be invoked. Query the canvas' MapRegion object to get the changed values. Inside a mapRegionChanged() implementation, the layer typically needs to update its data contents accordingly.

Specified by:

mapRegionChanged in interface Layer

Overrides:

mapRegionChanged in class NFERenderer<NFENetworkElementGeoObject>

render

public long render(java.awt.Graphics2D graphics)

Description copied from interface: Layer

Renders the layer contents to the given Graphics.

Specified by:

render in interface Layer

Overrides:

render in class NFERenderer<NFENetworkElementGeoObject>

Parameters:

graphics - the graphics object

Returns:

the rendering time in milliseconds.

modelObjectAdded

public void modelObjectAdded(NFEModelObjectEvent event)

Description copied from interface: NFEModelListener

Invoked when a model object has been added

Specified by:

modelObjectAdded in interface NFEModelListener

Parameters:

event - contains a reference to the model object that has been added

modelObjectsAdded

public void modelObjectsAdded(NFEModelObjectsEvent event)

Description copied from interface: NFEModelListener

Invoked when one or more model objects have been added

Specified by:

modelObjectsAdded in interface NFEModelListener

Parameters:

event - contains a collection of references to the model objects that have been added

modelObjectRemoved

public void modelObjectRemoved(NFEModelObjectEvent event)

Description copied from interface: NFEModelListener

Invoked when a model object has been removed

Specified by:

modelObjectRemoved in interface NFEModelListener

Parameters:

event - contains a reference to the model object that has been removed

modelObjectsRemoved

public void modelObjectsRemoved(NFEModelObjectsEvent event)

Description copied from interface: NFEModelListener

Invoked when one or more model objects have been removed

Specified by:

modelObjectsRemoved in interface NFEModelListener

Parameters:

event - contains a collection of references to the model objects that have been removed

modelObjectPropertyChanged

public void modelObjectPropertyChanged(NFEModelObjectPropertyChangedEvent event)

Description copied from interface: NFEModelListener

Invoked when a model object's property has been changed

Specified by:

modelObjectPropertyChanged in interface NFEModelListener

Parameters:

event - contains a reference to the model objects which property has been changed and the name and previous value of the changed property

getManipulableGeoObjects

public java.util.Collection<GeoObject> getManipulableGeoObjects()

Description copied from interface: ManipulableLayer

Gets the layer's GeoObjects that can be manipulated

Specified by:

getManipulableGeoObjects in interface ManipulableLayer

Returns:

a collection of GeoObjects

getHandlePoints

public double[] getHandlePoints(GeoObject geoObj)

Description copied from interface: ManipulableLayer

Gets the ordinates of the points from which a GeoObject can be manipulated

Specified by:

getHandlePoints in interface ManipulableLayer

Parameters:

geoObj - a GeoObject

Returns:

an array of ordinates in model's coordinate system

getSnapPoint

public JGeometrySegmentPoint getSnapPoint(GeoObject geoObj,
                                          java.awt.geom.Point2D dataPoint,
                                          double tolerance)

Description copied from interface: ManipulableLayer

Gets the closer GeoObject's snap point to the given point using the tolerance specified

Specified by:

getSnapPoint in interface ManipulableLayer

Specified by:

getSnapPoint in interface VertexEditableLayer

Parameters:

geoObj - a GeoObject

dataPoint - a point in model's coordinate system

tolerance - a tolarence in model's coordinate system

Returns:

a segment point relative to the GeoObject's geometry

getApplicableTransformation

public int getApplicableTransformation(GeoObject geoObj,
                                       java.util.Collection<GeoObject> manGeoObjGroup,
                                       JGeometrySegmentPoint snapPoint)

Description copied from interface: ManipulableLayer

Gets manipulation available for the given GeoObject and its current snap point. It is also specified all the GeoObjects that need to be manipulated along with the first GeoObject passed.

Specified by:

getApplicableTransformation in interface ManipulableLayer

Parameters:

geoObj - a GeoObject

manGeoObjGroup - a collection containing more GeoObjects to be manipulated. It can be null

snapPoint - a segment point relative to the GeoObject's geometry

Returns:

a manipulation code

startManipulation

public long startManipulation(GeoObject geoObj,
                              java.util.Collection<GeoObject> manGeoObjGroup,
                              JGeometrySegmentPoint snapPoint,
                              int transformation)

Description copied from interface: ManipulableLayer

Starts a manipulation session. The manipulation will be performed over the give GeoObject and the GeoObject group passed.

Specified by:

startManipulation in interface ManipulableLayer

Parameters:

geoObj - the target GeoObject to be manipulated

manGeoObjGroup - a group of GeoObjects to be manipulated

snapPoint - a segment point relative to the GeoObject's geometry

transformation - the type of manipulation to be performed

Returns:

a manipulation session id

finishManipulation

public boolean finishManipulation(long manId,
                                  java.awt.geom.Point2D dataPoint)

Description copied from interface: ManipulableLayer

finishes the manipulation identified by the given id. The last mouse point is specified.

Specified by:

finishManipulation in interface ManipulableLayer

Parameters:

manId - the manipulation session id

dataPoint - the last point for the manipulation in model's coordinate system

Returns:

true if the manipulation was performed successfully

manipulate

public boolean manipulate(long manId,
                          java.awt.geom.Point2D dataPoint)

Description copied from interface: ManipulableLayer

Updates the state of a manipulation with the last point. It is useful if a live preview has to be shown.

Specified by:

manipulate in interface ManipulableLayer

Parameters:

manId - a manipulation session id

dataPoint - the last user point (it may be a mouse point) in model's coordinate system

Returns:

true if the manipulation state was updated successfully

cancelManipulation

public void cancelManipulation(long manId)

Description copied from interface: ManipulableLayer

Cancels the given manipulation and releases all the resources related to it

Specified by:

cancelManipulation in interface ManipulableLayer

Parameters:

manId - a manipulation session id

getPreview

public ManipulationPreview getPreview(long manId)

Description copied from interface: ManipulableLayer

Gets a preview for a manipulation

Specified by:

getPreview in interface ManipulableLayer

Parameters:

manId - a manipulation session id

Returns:

a manipulation preview object

getVertexEditableGeoObjects

public java.util.Collection<GeoObject> getVertexEditableGeoObjects()

Description copied from interface: VertexEditableLayer

Gets all the GeoObjects which vertices can be edited

Specified by:

getVertexEditableGeoObjects in interface VertexEditableLayer

Returns:

a collection of GeoObjects

getVertices

public double[] getVertices(GeoObject geoObj)

Description copied from interface: VertexEditableLayer

Gets all the vertices of the GeoObject

Specified by:

getVertices in interface VertexEditableLayer

Parameters:

geoObj - a GeoObject

Returns:

an array containing the ordinates of the GeoObject's vertices

canAddVertex

public boolean canAddVertex(GeoObject geoObj,
                            JGeometrySegmentPoint snapPoint)

Description copied from interface: VertexEditableLayer

Tells whether it is possible to add a new vertex to the GeoObject at the specified snap point

Specified by:

canAddVertex in interface VertexEditableLayer

Parameters:

geoObj - a GeoObject

snapPoint - a segment point relative to the GeoObject's geometry

Returns:

true if it is possible to add a new vertex

addVertex

public boolean addVertex(GeoObject geoObj,
                         JGeometrySegmentPoint snapPoint)

Description copied from interface: VertexEditableLayer

Adds a vertex to the given GeoObject at the specified snap point

Specified by:

addVertex in interface VertexEditableLayer

Parameters:

geoObj - a GeoObject

snapPoint - a segment point relative to the GeoObject's geometry

Returns:

true if the vertex was successfully added