ilog.views.maps.labelling
Class IlvLabeledPointRenderer

java.lang.Object
  ilog.views.maps.rendering.IlvDefaultPointRenderer
      ilog.views.maps.labelling.IlvLabeledPointRenderer

All Implemented Interfaces:

IlvPersistentObject, IlvFeatureRenderer

public class IlvLabeledPointRenderer
extends IlvDefaultPointRenderer

A point renderer which produces an IlvAnchoredLabel. An IlvAnchoredLabel is a subclass of IlvGraphic containing an IlvMapLabel and a reference IlvGraphic.
The renderer makes a label if an attribute corresponding to the specified name is found.

Since:

JViews 5.0

Constructor Summary

IlvLabeledPointRenderer()
Constructs an empty IlvLabeledPointRenderer.

IlvLabeledPointRenderer(IlvInputStream stream)
Reads an IlvLabeledPointRenderer from the stream stream.

IlvLabeledPointRenderer(String[] attributeNames, String[] rejectedValues)
Constructs an IlvLabeledPointRenderer with the name of the attribute and a value.

Method Summary

String[]	getAttributeNames() Retrieves the array of attribute names.
String	getName(IlvMapFeature feature) Retrieves a name in the attributes of the feature that matches the criteria defined in the constructor.
String[]	getRejectedValues() Retrieves the arrays of values to be rejected from attribute values.
IlvMapTextRenderingStyle	getTextRenderingStyle() Retrieves the test rendering style for the IlvAnchoredLabels label.
boolean	isAlwaysProducingGraphic() Tells if the renderer is always producing graphic even if there is no matching name or value in the attributes.
IlvGraphic	makeGraphic(IlvMapFeature feature, IlvCoordinateTransformation tr) Makes the graphic accordingly to the rule described in the constructor documentation.
void	setAlwaysProducingGraphic(boolean produce) Tells the renderer if it should produce an IlvGraphic even if there is no matching name or value in the attributes.
void	setAttributeNames(String[] attributeNames) Sets the attributes whose names are candidate to be displayed by the label.
void	setRejectedValues(String[] rejectedValues) Sets the arrays of values to be rejected from attribute values.
void	setTextRenderingStyle(IlvMapTextRenderingStyle style) Sets the text style for the IlvAnchoredLabels label.
void	write(IlvOutputStream stream) Writes the renderer to the IlvOutputStream stream.

Methods inherited from class ilog.views.maps.rendering.IlvDefaultPointRenderer

getPointRenderingStyle, isPersistent, isUsingFontMarker, setPointRenderingStyle, setUsingFontMarker

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvLabeledPointRenderer

public IlvLabeledPointRenderer(String[] attributeNames,
                               String[] rejectedValues)

Constructs an IlvLabeledPointRenderer with the name of the attribute and a value. If an attribute whose name is contained in the attributeNames array is found, and if the value of this attribute is different from a value found in the rejectedValues array, an IlvAnchoredLabel with a label will be made. Otherwise, depending on the AlwaysProducingGraphic flag, a null graphic or a IlvAnchoredLabel with only a reference graphic will be produced.

Parameters:

attributeNames - The list of attribute names to be taken in account.

rejectedValues - The list of attribute values that are to be ignored.

IlvLabeledPointRenderer

public IlvLabeledPointRenderer()

Constructs an empty IlvLabeledPointRenderer. Attribute names and rejected values must be set through the setAttibuteNames and setRejectedValues methods.

Since:

JViews 5.5

See Also:

IlvLabeledPointRenderer(java.lang.String[], java.lang.String[])

IlvLabeledPointRenderer

public IlvLabeledPointRenderer(IlvInputStream stream)
                        throws IlvReadFileException

Reads an IlvLabeledPointRenderer from the stream stream.

Throws:

IlvReadFileException

Method Detail

setAttributeNames

public void setAttributeNames(String[] attributeNames)

Sets the attributes whose names are candidate to be displayed by the label.

Parameters:

attributeNames - Array of attribute names whose values are candidate to be displayed.

Since:

JViews 5.5

getAttributeNames

public String[] getAttributeNames()

Retrieves the array of attribute names.

Returns:

The array of attribute names.

Since:

JViews 5.5

setRejectedValues

public void setRejectedValues(String[] rejectedValues)

Sets the arrays of values to be rejected from attribute values.

Since:

JViews 5.5

getRejectedValues

public String[] getRejectedValues()

Retrieves the arrays of values to be rejected from attribute values.

Since:

JViews 5.5

setAlwaysProducingGraphic

public void setAlwaysProducingGraphic(boolean produce)

Tells the renderer if it should produce an IlvGraphic even if there is no matching name or value in the attributes.

isAlwaysProducingGraphic

public boolean isAlwaysProducingGraphic()

Tells if the renderer is always producing graphic even if there is no matching name or value in the attributes.

setTextRenderingStyle

public void setTextRenderingStyle(IlvMapTextRenderingStyle style)

Sets the text style for the IlvAnchoredLabels label.

Parameters:

style - The text rendering style.

getTextRenderingStyle

public IlvMapTextRenderingStyle getTextRenderingStyle()

Retrieves the test rendering style for the IlvAnchoredLabels label.

write

public void write(IlvOutputStream stream)
           throws IOException

Writes the renderer to the IlvOutputStream stream.

Specified by:

write in interface IlvPersistentObject

Specified by:

write in interface IlvFeatureRenderer

Overrides:

write in class IlvDefaultPointRenderer

Parameters:

stream - the output stream

Throws:

IOException - thrown when an exception occurs during the write operation for this object.

getName

public String getName(IlvMapFeature feature)

Retrieves a name in the attributes of the feature that matches the criteria defined in the constructor. This method is used by the makeGraphic method to create an IlvAnchoredLabel.

makeGraphic

public IlvGraphic makeGraphic(IlvMapFeature feature,
                              IlvCoordinateTransformation tr)
                       throws IlvMapRenderException,
                              IlvProjectionException,
                              IlvCoordinateTransformationException

Makes the graphic accordingly to the rule described in the constructor documentation.

Specified by:

makeGraphic in interface IlvFeatureRenderer

Overrides:

makeGraphic in class IlvDefaultPointRenderer

Parameters:

feature - The map feature to be rendered.

tr - The coordinate transformation.

Throws:

IlvMapRenderException - If the renderer cannot process the map feature.

IlvCoordinateTransformationException - If a transformation exception occurs.

IlvProjectionException