com.moximedia.aims
Class AimsValueMapLabelRenderer

java.lang.Object
  com.moximedia.aims.AimsValueMapLabelRenderer

All Implemented Interfaces:

AimsRenderer, java.lang.Cloneable, java.io.Serializable

public class AimsValueMapLabelRenderer

extends java.lang.Object

implements java.lang.Cloneable, AimsRenderer, java.io.Serializable

Author:

Doug Cates - www.moximedia.com

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.moximedia.aims.AimsRenderer

RENDERER_TYPE_GROUP, RENDERER_TYPE_SCALEDEPENDENT, RENDERER_TYPE_SIMPLE, RENDERER_TYPE_SIMPLELABEL, RENDERER_TYPE_VALUEMAP, RENDERER_TYPE_VALUEMAPLABEL

Constructor Summary

AimsValueMapLabelRenderer()
Creates new SimpleLabelRenderer

Method Summary

void	add(AimsExact exactObj) Adds an Exact value to the renderer.
void	add(AimsOther otherObj) Adds an Other value to the renderer.
void	add(AimsRange rangeObj) Adds a Range value to the renderer.
void	adjustScaleFactors(double multiplier) Adjusts the scale factors for this renderer.
java.lang.Object	clone() Creates a copy of this renderer.
AimsValueMapObject	get(int index) Gets the object at the specified index.
java.lang.String	getFeatureWeight() Gets the value of attribute featureWeight
java.lang.String	getHowManyLabels() Gets the value of attribute howManyLabels
double	getLabelBufferRatio() Gets the value of attribute labelBufferRatio
java.lang.String	getLabelField() Gets the value of attribute labelField
java.lang.String	getLabelPriorities() Gets the value of attribute labelPriorities
java.lang.String	getLabelWeight() Gets the value of attribute labelWeight
java.lang.String	getLineLabelPosition() Gets the value of attribute lineLabelPosition
java.lang.String	getLookupField() Gets the value of attribute lookupField
java.util.ArrayList	getObjectArray() Gets the array of AimsValueMapObjects contained in this renderer.
int	getRendererType() Returns an indicator of what type of renderer this is.
java.lang.String	getRotationalAngles() Gets the value of attribute rotationalAngles
boolean	getVisible() gets the visiblility of the renderer
void	highlight(AimsColor highlightColor, double transparency)
boolean	isModified() Returns a boolean value indicating whether the renderer has been modified by the user since it was loaded from the map service.
void	remove(int index) Removes the object at the specified index.
void	removeLabels() Removes labels from this renderer and any subrenderers (if applicable).
void	setAxlAttribute(java.lang.String tag, java.lang.String name, java.lang.String value) Sets one of the attributes of this object using a string value.
void	setFeatureWeight(java.lang.String featureWeight) Sets the value of attribute featureWeight.
void	setHowManyLabels(java.lang.String howManyLabels) Sets the value of attribute howManyLabels.
void	setLabelBufferRatio(double labelBufferRatio) Sets the value of attribute labelBufferRatio.
void	setLabelField(java.lang.String labelField) Sets the value of attribute labelField.
void	setLabelPriorities(java.lang.String labelPriorities) Sets the value of attribute labelPriorities.
void	setLabelWeight(java.lang.String labelWeight) Sets the value of attribute labelWeight.
void	setLineLabelPosition(java.lang.String lineLabelPosition) Sets the value of attribute lineLabelPosition.
void	setLookupField(java.lang.String lookupField) Sets the value of attribute lookupField.
void	setModified(boolean isModified) Sets the modified flag of the renderer, indicating that it needs to be sent to the map server when the map is refreshed.
void	setRotationalAngles(java.lang.String rotationalAngles) Sets the value of attribute rotationalAngles.
void	setVisible(boolean isVisible) Sets the visiblility of the renderer
void	showLabels(boolean showLabels)
int	size() Returns the number of objects contained in the renderer.
java.lang.String	toAxlString() Returns the AXL string to refresh this object.
java.lang.String	toAxlString(AimsEnvironment env) Returns the AXL string to refresh this object.
java.lang.String	toString() Returns a string containing the name of this class.

Methods inherited from class java.lang.Object

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

Constructor Detail

AimsValueMapLabelRenderer

public AimsValueMapLabelRenderer()

Creates new SimpleLabelRenderer

Method Detail

clone

public java.lang.Object clone()

Creates a copy of this renderer.

Specified by:

clone in interface AimsRenderer

Returns:

An object that is a copy of this renderer. The object must be cast to an AimsValueMapLabelRenderer or AimsRenderer before use.

get

public AimsValueMapObject get(int index)

Gets the object at the specified index. The result may be cast to the proper object type AimsExact, AimsRange, AimsOther before using.

Parameters:

index - The index number of the object.

Returns:

The object, or null if no object is found at that index.

isModified

public boolean isModified()

Returns a boolean value indicating whether the renderer has been modified by the user since it was loaded from the map service.

Specified by:

isModified in interface AimsRenderer

Returns:

True if modified, otherwise false.

setModified

public void setModified(boolean isModified)

Sets the modified flag of the renderer, indicating that it needs to be sent to the map server when the map is refreshed.

Specified by:

setModified in interface AimsRenderer

Parameters:

isModified - True if the renderer has been modified.

add

public void add(AimsExact exactObj)

Adds an Exact value to the renderer.

add

public void add(AimsRange rangeObj)

Adds a Range value to the renderer.

add

public void add(AimsOther otherObj)

Adds an Other value to the renderer.

setLabelField

public void setLabelField(java.lang.String labelField)

Sets the value of attribute labelField.

getLabelField

public java.lang.String getLabelField()

Gets the value of attribute labelField

Returns:

The value of attribute labelField

setLookupField

public void setLookupField(java.lang.String lookupField)

Sets the value of attribute lookupField.

getLookupField

public java.lang.String getLookupField()

Gets the value of attribute lookupField

Returns:

The value of attribute lookupField

setFeatureWeight

public void setFeatureWeight(java.lang.String featureWeight)

Sets the value of attribute featureWeight.

getFeatureWeight

public java.lang.String getFeatureWeight()

Gets the value of attribute featureWeight

Returns:

The value of attribute featureWeight

setHowManyLabels

public void setHowManyLabels(java.lang.String howManyLabels)

Sets the value of attribute howManyLabels.

getHowManyLabels

public java.lang.String getHowManyLabels()

Gets the value of attribute howManyLabels

Returns:

The value of attribute howManyLabels

setLabelBufferRatio

public void setLabelBufferRatio(double labelBufferRatio)

Sets the value of attribute labelBufferRatio.

getLabelBufferRatio

public double getLabelBufferRatio()

Gets the value of attribute labelBufferRatio

Returns:

The value of attribute labelBufferRatio

setLabelPriorities

public void setLabelPriorities(java.lang.String labelPriorities)

Sets the value of attribute labelPriorities.

getLabelPriorities

public java.lang.String getLabelPriorities()

Gets the value of attribute labelPriorities

Returns:

The value of attribute labelPriorities

setLabelWeight

public void setLabelWeight(java.lang.String labelWeight)

Sets the value of attribute labelWeight.

getLabelWeight

public java.lang.String getLabelWeight()

Gets the value of attribute labelWeight

Returns:

The value of attribute labelWeight

setLineLabelPosition

public void setLineLabelPosition(java.lang.String lineLabelPosition)

Sets the value of attribute lineLabelPosition.

getLineLabelPosition

public java.lang.String getLineLabelPosition()

Gets the value of attribute lineLabelPosition

Returns:

The value of attribute lineLabelPosition

setRotationalAngles

public void setRotationalAngles(java.lang.String rotationalAngles)

Sets the value of attribute rotationalAngles.

getRotationalAngles

public java.lang.String getRotationalAngles()

Gets the value of attribute rotationalAngles

Returns:

The value of attribute rotationalAngles

getObjectArray

public java.util.ArrayList getObjectArray()

Gets the array of AimsValueMapObjects contained in this renderer.

Returns:

An ArrayList containing the value map objects.

remove

public void remove(int index)

Removes the object at the specified index.

Parameters:

index - The index number of the object.

size

public int size()

Returns the number of objects contained in the renderer.

Returns:

The count.

getVisible

public boolean getVisible()

gets the visiblility of the renderer

Returns:

The visibility property.

setVisible

public void setVisible(boolean isVisible)

Sets the visiblility of the renderer

Parameters:

isVisible - The visibility property.

setAxlAttribute

public void setAxlAttribute(java.lang.String tag,
                            java.lang.String name,
                            java.lang.String value)

Sets one of the attributes of this object using a string value. This method should only be called from the SAX event handler.

Parameters:

tag - The AXL element tag containing this attribute.

name - The AXL attribute name.

value - The AXL attribute value.

toString

public java.lang.String toString()

Returns a string containing the name of this class.

Specified by:

toString in interface AimsRenderer

Returns:

The name of the class

toAxlString

public java.lang.String toAxlString()

Returns the AXL string to refresh this object.

Specified by:

toAxlString in interface AimsRenderer

Returns:

The AXL string to refresh this object.

toAxlString

public java.lang.String toAxlString(AimsEnvironment env)

Returns the AXL string to refresh this object.

Specified by:

toAxlString in interface AimsRenderer

Returns:

The AXL string to refresh this object.

highlight

public void highlight(AimsColor highlightColor,
                      double transparency)

Specified by:

highlight in interface AimsRenderer

removeLabels

public void removeLabels()

Removes labels from this renderer and any subrenderers (if applicable). This method is used by the createHighlightLayer method to avoid duplicate labels on the map.

Specified by:

removeLabels in interface AimsRenderer

showLabels

public void showLabels(boolean showLabels)

Specified by:

showLabels in interface AimsRenderer

adjustScaleFactors

public void adjustScaleFactors(double multiplier)

Adjusts the scale factors for this renderer. Used for some renderers when changing the units of a map.

Specified by:

adjustScaleFactors in interface AimsRenderer

Parameters:

multiplier - The multiplication factor for adjusting scale factors.

getRendererType

public int getRendererType()

Returns an indicator of what type of renderer this is.

Specified by:

getRendererType in interface AimsRenderer

Returns:

An enumerated value indicating the type of renderer this is. Always returns AimsRenderer.RENDERER_TYPE_VALUEMAPLABEL.