Package uk.ac.rdg.resc.edal.graphics.style

Class ColouredSizedArrowLayer

java.lang.Object

uk.ac.rdg.resc.edal.graphics.style.Drawable

uk.ac.rdg.resc.edal.graphics.style.ImageLayer

uk.ac.rdg.resc.edal.graphics.style.GriddedImageLayer

uk.ac.rdg.resc.edal.graphics.style.SizedArrowLayer

uk.ac.rdg.resc.edal.graphics.style.ColouredSizedArrowLayer

public class ColouredSizedArrowLayer
extends SizedArrowLayer

A GriddedImageLayer which draws arrows which can be scaled and coloured according to two (potentially different) data fields User: JRI Date: 02/08/2016

Nested Class Summary

Nested classes/interfaces inherited from class uk.ac.rdg.resc.edal.graphics.style.GriddedImageLayer

GriddedImageLayer.MapFeatureDataReader

Nested classes/interfaces inherited from class uk.ac.rdg.resc.edal.graphics.style.ImageLayer

ImageLayer.MetadataFilter

Nested classes/interfaces inherited from class uk.ac.rdg.resc.edal.graphics.style.Drawable

Drawable.NameAndRange

Field Summary

Fields inherited from class uk.ac.rdg.resc.edal.graphics.style.SizedArrowLayer

arrowSizeFieldName, directionFieldName

Constructor Summary

Constructors

Constructor	Description
ColouredSizedArrowLayer(String directionField, String arrowSizeField, String arrowColourField, Integer arrowMinSize, Integer arrowMaxSize, ScaleRange scale, ColourScheme arrowColourScheme, ArrowLayer.ArrowStyle arrowStyle, ArrowLayer.ArrowDirectionConvention arrowDirectionConvention)	Instantiates a new ColouredSizedArrowLayer

Method Summary

Modifier and Type	Method	Description
protected void	drawIntoImage(BufferedImage image, GriddedImageLayer.MapFeatureDataReader dataReader)	Draws the data into the supplied image.
protected Color	getArrowColour(Number arrowSize)
Set<Drawable.NameAndRange>	getFieldsWithScales()

Methods inherited from class uk.ac.rdg.resc.edal.graphics.style.SizedArrowLayer

drawArrows

Methods inherited from class uk.ac.rdg.resc.edal.graphics.style.GriddedImageLayer

drawIntoImage, supportedFeatureTypes

Methods inherited from class uk.ac.rdg.resc.edal.graphics.style.ImageLayer

drawImage, getMetadataFilter

Methods inherited from class uk.ac.rdg.resc.edal.graphics.style.Drawable

getOpacityTransform, setOpacityTransform

Methods inherited from class java.lang.Object

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

Constructor Detail

ColouredSizedArrowLayer

public ColouredSizedArrowLayer(String directionField,
                               String arrowSizeField,
                               String arrowColourField,
                               Integer arrowMinSize,
                               Integer arrowMaxSize,
                               ScaleRange scale,
                               ColourScheme arrowColourScheme,
                               ArrowLayer.ArrowStyle arrowStyle,
                               ArrowLayer.ArrowDirectionConvention arrowDirectionConvention)

Instantiates a new ColouredSizedArrowLayer

Parameters:

directionField - The name of the data layer used to determine direction

arrowSizeField - The name of the data layer used to determine arrow size

arrowColourField - The name of the data layer used to determine arrow colour

arrowMinSize - The minimum arrow size to plot, in pixels

arrowMaxSize - The maximum arrow size to plot, in pixels

scale - The ScaleRange used to scale the arrow size

arrowColourScheme - The ColourScheme used to determine arrow colour

arrowStyle - The style of arrow to plot

arrowDirectionConvention - The direction convention of arrow to plot

Method Detail

getArrowColour

protected Color getArrowColour(Number arrowSize)

Overrides:

getArrowColour in class SizedArrowLayer

drawIntoImage

protected void drawIntoImage(BufferedImage image,
                             GriddedImageLayer.MapFeatureDataReader dataReader)
                      throws EdalException

Description copied from class: GriddedImageLayer

Draws the data into the supplied image.

Overrides:

drawIntoImage in class SizedArrowLayer

Parameters:

image - A BufferedImage to draw into

dataReader - A GriddedImageLayer.MapFeatureDataReader which is used to obtain the actual data values and domain. The MapDomain returned will match the size of the image, and pixels are georeferenced to the GridCell2Ds which comprise the domain

Throws:

EdalException - If there is a problem reading the data or drawing into the image

getFieldsWithScales

public Set<Drawable.NameAndRange> getFieldsWithScales()

Overrides:

getFieldsWithScales in class SizedArrowLayer

Returns:

A list of all the fields used in this image layer, and their appropriate scale ranges. If there is NO scale range there can be NO data field and vice versa - i.e. a Drawable.NameAndRange object must have all non-null fields. If the layer doesn't depend on any data, this should return an empty set. It should never return null.