NFERenderer (Oracle Spatial and Graph Java API Reference)

java.lang.Object
- oracle.spatial.network.nfe.vis.maps.layer.BasicLayer
- - oracle.spatial.network.nfe.vis.mapcanvas.render.NFERenderer<V>

Type Parameters:

V - The type of elements rendered. It must be a subclass of NFEGeoObject

All Implemented Interfaces:

java.util.EventListener, javax.swing.event.ChangeListener, GeoObjectLayer, HoverableLayer, Layer, SelectableLayer

Direct Known Subclasses:

NFEFeatureLayerRenderer, NFENetworkRenderer, NFEPathRenderer
```
public abstract class NFERenderer<V extends NFEGeoObject>
extends BasicLayer
implements SelectableLayer, HoverableLayer, javax.swing.event.ChangeListener
```
Basic renderer for displaying NFE layers using the MapCanvas. This class provides common functions used for rendering NFE API content.

Field Summary
- 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

NFERenderer(MapCanvas canvas)
Constructor called from a subclass constructor.

Constructors
Constructor and Description
`NFERenderer(MapCanvas canvas)` Constructor called from a subclass constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addContextualMenuHandler(ContextualMenuHandler contextualMenuHandler)` Add a contextual menu handler
`void`	`addSelectionListener(SelectionListener l)` Adds a SelectionListener
`void`	`clear()` Clears all contents of this layer.
`boolean`	`clearHover()` Removes the hovering state from all the geo-objects
`boolean`	`clearSelection()` Clears all selected objects
`java.awt.geom.Rectangle2D`	`getDataMBR()` Always return null here.
`java.awt.geom.Rectangle2D`	`getFullExtent()`
`V`	`getGeoObject(java.lang.String key)` Gets the GeoObject identified by the given key
`java.util.List<GeoObject>`	`getHover()` Returns all the geo-object that are being hovered
`float`	`getImageOpacityAlpha()` Gets the opacity
`V`	`getObject(java.lang.Object key)` Gets the GeoObject corresponding to the provided key
`GeoObject[]`	`getObjects()` Gets all GeoObjects in this layer
`java.util.List<GeoObject>`	`getSelection()` Returns all selected objects
`java.util.List<GeoObject>`	`getSelection(GeoObject obj)` Returns selected objects that are children of the provided objects GeoObject's isSubElementOf() determines if an object is children of another object
`JGeometrySegmentPoint`	`getSnapPoint(java.lang.Object key, java.awt.geom.Point2D point, double tolerance)`
`double`	`getTolerance()` Gets the screen tolerance converted to the model's coordinate system
`boolean`	`handleEvent(java.util.EventObject evt)` The main method that performs event handling for this tool.
`java.util.List<GeoObject>`	`hitTest(int x, int y, int granularity)` Performs a hit test for the given mouse location (x,y).
`java.util.List<GeoObject>`	`hitTest(java.awt.geom.Rectangle2D mbr, int granularity)` Performs a hit test for the given rectangle.
`boolean`	`isHover(GeoObject obj)` Returns true if the geo-object is being hovered
`boolean`	`isSelected(GeoObject obj)` Checks if an object is selected
`void`	`mapRegionChanged(MapRegionEvent e)` When the associated canvas's map region is changed, this method is called to notify the layer of the change.
`int`	`numHovered()` Returns the number of geo-objects that are being hovered
`int`	`numSelected()` Returns the number of selected objects
`void`	`refresh()` Refreshes the current data window
`void`	`refresh(java.awt.geom.Rectangle2D dataWindow)` Refreshes the data window at the given area
`void`	`removeContextualMenuHandler(ContextualMenuHandler contextualMenuHandler)` Remove a contextual menu handler
`void`	`removeSelectionListener(SelectionListener l)` Removes the given SelectionListener
`long`	`render(java.awt.Graphics2D graphics)` Renders the layer contents to the given Graphics.
`boolean`	`select(java.util.List<GeoObject> objs)` Adds the provided objects to the selection list
`boolean`	`setHover(java.util.List<GeoObject> objs)` A list of geo-objects being hovered
`void`	`setImageOpacityAlpha(float imageOpacityAlpha)` Sets the opacity for the layer's rendered images
`boolean`	`setSelection(java.util.List<GeoObject> selectedGeoObjects)` Clears selection before setting the provided objects as selected
`void`	`stateChanged(javax.swing.event.ChangeEvent event)`
`boolean`	`unselect(java.util.List<GeoObject> objs)` Removes the provided objects from the selection list
`void`	`update(long elapsedTime)` updates the contents data model or structure.

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
  - NFERenderer
```
public NFERenderer(MapCanvas canvas)
```
    Constructor called from a subclass constructor. It initializes the basic renderer state.
    
    Parameters:
    
    canvas - the MapCanvas where the layer will be rendered
- Method Detail
  - getTolerance
```
public double getTolerance()
```
    Gets the screen tolerance converted to the model's coordinate system
    
    Returns:
    
    the tolerance value or zero if it is not specified or could not be converted
  - refresh
```
public void refresh()
```
    Refreshes the current data window
  - refresh
```
public void refresh(java.awt.geom.Rectangle2D dataWindow)
```
    Refreshes the data window at the given area
    
    Parameters:
    
    dataWindow - a region to be refreshed
  - getImageOpacityAlpha
```
public float getImageOpacityAlpha()
```
    Gets the opacity
    
    Returns:
    
    the opacity value
  - setImageOpacityAlpha
```
public void setImageOpacityAlpha(float imageOpacityAlpha)
```
    Sets the opacity for the layer's rendered images
    
    Parameters:
    
    imageOpacityAlpha - the opacity value
  - addContextualMenuHandler
```
public void addContextualMenuHandler(ContextualMenuHandler contextualMenuHandler)
```
    Add a contextual menu handler
    
    Parameters:
    
    contextualMenuHandler - contextual menu handler
  - removeContextualMenuHandler
```
public void removeContextualMenuHandler(ContextualMenuHandler contextualMenuHandler)
```
    Remove a contextual menu handler
    
    Parameters:
    
    contextualMenuHandler - contextual menu handler
  - getGeoObject
```
public V getGeoObject(java.lang.String key)
```
    Gets the GeoObject identified by the given key
    
    Parameters:
    
    key - a GeoObject's key
    
    Returns:
    
    a GeoObject or null if it was not found
  - isSelected
```
public boolean isSelected(GeoObject obj)
```
    Description copied from interface: SelectableLayer
    
    Checks if an object is selected
    
    Specified by:
    
    isSelected in interface SelectableLayer
    
    Returns:
    
    true if the provided object is selected
  - clearSelection
```
public boolean clearSelection()
```
    Description copied from interface: SelectableLayer
    
    Clears all selected objects
    
    Specified by:
    
    clearSelection in interface SelectableLayer
    
    Returns:
    
    true if changes where made
  - numSelected
```
public int numSelected()
```
    Description copied from interface: SelectableLayer
    
    Returns the number of selected objects
    
    Specified by:
    
    numSelected in interface SelectableLayer
    
    Returns:
    
    the number of selected objects
  - getSelection
```
public java.util.List<GeoObject> getSelection()
```
    Description copied from interface: SelectableLayer
    
    Returns all selected objects
    
    Specified by:
    
    getSelection in interface SelectableLayer
    
    Returns:
  - getSelection
```
public java.util.List<GeoObject> getSelection(GeoObject obj)
```
    Description copied from interface: SelectableLayer
    
    Returns selected objects that are children of the provided objects GeoObject's isSubElementOf() determines if an object is children of another object
    
    Specified by:
    
    getSelection in interface SelectableLayer
    
    Returns:
  - setSelection
```
public boolean setSelection(java.util.List<GeoObject> selectedGeoObjects)
```
    Description copied from interface: SelectableLayer
    
    Clears selection before setting the provided objects as selected
    
    Specified by:
    
    setSelection in interface SelectableLayer
    
    Returns:
  - select
```
public boolean select(java.util.List<GeoObject> objs)
```
    Description copied from interface: SelectableLayer
    
    Adds the provided objects to the selection list
    
    Specified by:
    
    select in interface SelectableLayer
    
    Returns:
  - unselect
```
public boolean unselect(java.util.List<GeoObject> objs)
```
    Description copied from interface: SelectableLayer
    
    Removes the provided objects from the selection list
    
    Specified by:
    
    unselect in interface SelectableLayer
    
    Returns:
  - addSelectionListener
```
public void addSelectionListener(SelectionListener l)
```
    Description copied from interface: SelectableLayer
    
    Adds a SelectionListener
    
    Specified by:
    
    addSelectionListener in interface SelectableLayer
  - removeSelectionListener
```
public void removeSelectionListener(SelectionListener l)
```
    Description copied from interface: SelectableLayer
    
    Removes the given SelectionListener
    
    Specified by:
    
    removeSelectionListener in interface SelectableLayer
  - stateChanged
```
public void stateChanged(javax.swing.event.ChangeEvent event)
```
    Specified by:
    
    stateChanged in interface javax.swing.event.ChangeListener
  - setHover
```
public boolean setHover(java.util.List<GeoObject> objs)
```
    Description copied from interface: HoverableLayer
    
    A list of geo-objects being hovered
    
    Specified by:
    
    setHover in interface HoverableLayer
    
    Returns:
    
    true if the objects were hovered
  - clearHover
```
public boolean clearHover()
```
    Description copied from interface: HoverableLayer
    
    Removes the hovering state from all the geo-objects
    
    Specified by:
    
    clearHover in interface HoverableLayer
    
    Returns:
  - getHover
```
public java.util.List<GeoObject> getHover()
```
    Description copied from interface: HoverableLayer
    
    Returns all the geo-object that are being hovered
    
    Specified by:
    
    getHover in interface HoverableLayer
    
    Returns:
  - isHover
```
public boolean isHover(GeoObject obj)
```
    Description copied from interface: HoverableLayer
    
    Returns true if the geo-object is being hovered
    
    Specified by:
    
    isHover in interface HoverableLayer
    
    Returns:
  - numHovered
```
public int numHovered()
```
    Description copied from interface: HoverableLayer
    
    Returns the number of geo-objects that are being hovered
    
    Specified by:
    
    numHovered in interface HoverableLayer
    
    Returns:
  - getSnapPoint
```
public JGeometrySegmentPoint getSnapPoint(java.lang.Object key,
                                          java.awt.geom.Point2D point,
                                          double tolerance)
```
  - getFullExtent
```
public java.awt.geom.Rectangle2D getFullExtent()
```
    Specified by:
    
    getFullExtent in interface Layer
    
    Overrides:
    
    getFullExtent in class BasicLayer
  - clear
```
public void clear()
```
    Description copied from interface: Layer
    
    Clears all contents of this layer.
    
    Specified by:
    
    clear in interface Layer
    
    Overrides:
    
    clear in class BasicLayer
  - handleEvent
```
public boolean handleEvent(java.util.EventObject evt)
```
    Description copied from interface: Layer
    
    The main method that performs event handling for this tool. Returns whether the event should be propagated to other layers down stream (further down the layer stack) after the event has been handled.
    
    Specified by:
    
    handleEvent in interface Layer
    
    Overrides:
    
    handleEvent in class BasicLayer
  - update
```
public void update(long elapsedTime)
```
    Description copied from interface: Layer
    
    updates the contents data model or structure.
    
    Specified by:
    
    update in interface Layer
    
    Overrides:
    
    update in class BasicLayer
    
    Parameters:
    
    elapsedTime - The elapsed time since last update.
  - getDataMBR
```
public java.awt.geom.Rectangle2D getDataMBR()
```
    Description copied from class: BasicLayer
    
    Always return null here.
    
    Specified by:
    
    getDataMBR in interface Layer
    
    Overrides:
    
    getDataMBR in class BasicLayer
  - getObjects
```
public GeoObject[] getObjects()
```
    Description copied from interface: GeoObjectLayer
    
    Gets all GeoObjects in this layer
    
    Specified by:
    
    getObjects in interface GeoObjectLayer
    
    Returns:
  - getObject
```
public V getObject(java.lang.Object key)
```
    Description copied from interface: GeoObjectLayer
    
    Gets the GeoObject corresponding to the provided key
    
    Specified by:
    
    getObject in interface GeoObjectLayer
    
    Returns:
  - hitTest
```
public java.util.List<GeoObject> hitTest(int x,
                                         int y,
                                         int granularity)
```
    Description copied from interface: Layer
    
    Performs a hit test for the given mouse location (x,y). All the geo-objects that pass the hit test will be returned.
    
    Specified by:
    
    hitTest in interface Layer
    
    Overrides:
    
    hitTest in class BasicLayer
    
    Parameters:
    
    x - mouse location x
    
    y - mouse location y
    
    Returns:
    
    a list of features that pass the hit test; if no feature passes the hit test, the list is empty.
  - hitTest
```
public java.util.List<GeoObject> hitTest(java.awt.geom.Rectangle2D mbr,
                                         int granularity)
```
    Description copied from interface: Layer
    
    Performs a hit test for the given rectangle. All the geo-objects that are either inside or intersect the rectangle will be returned.
    
    Specified by:
    
    hitTest in interface Layer
    
    Overrides:
    
    hitTest in class BasicLayer
    
    Parameters:
    
    mbr - the test rectangle, in device coordinates
    
    Returns:
    
    a list of features that pass the box hit test; if no feature passes the hit test, the list is empty.
  - 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 BasicLayer
  - 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 BasicLayer
    
    Parameters:
    
    graphics - the graphics object
    
    Returns:
    
    the rendering time in milliseconds.

Class NFERenderer<V extends NFEGeoObject>

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

NFERenderer

Method Detail

getTolerance

refresh

refresh

getImageOpacityAlpha

setImageOpacityAlpha

addContextualMenuHandler

removeContextualMenuHandler

getGeoObject

isSelected

clearSelection

numSelected

getSelection

getSelection

setSelection

select

unselect

addSelectionListener

removeSelectionListener

stateChanged

setHover

clearHover

getHover

isHover

numHovered

getSnapPoint

getFullExtent

clear

handleEvent

update

getDataMBR

getObjects

getObject

hitTest

hitTest

mapRegionChanged

render