com.moximedia.aims
Class AimsValueMapRenderer

java.lang.Object
  com.moximedia.aims.AimsValueMapRenderer

All Implemented Interfaces:

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

public class AimsValueMapRenderer

extends java.lang.Object

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

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

AimsValueMapRenderer()
Creates new AimsValueMapRenderer

AimsValueMapRenderer(java.lang.String lookupField)
Creates new AimsValueMapRenderer setting the lookup field name

Method Summary

void	add(AimsExact exactObj) Adds an AimsExact value to the renderer.
void	add(AimsOther otherObj) Adds an AimsOther value to the renderer.
void	add(AimsRange rangeObj) Adds an AimsRange object 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	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.
void	highlight(AimsColor highlightColor, double transparency) Sets the highlight color of the objects in this renderer.
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	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	showLabels(boolean showLabels) Has no effect for this type of renderer.
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 text representation of of this class.

Methods inherited from class java.lang.Object

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

Constructor Detail

AimsValueMapRenderer

public AimsValueMapRenderer()

Creates new AimsValueMapRenderer

AimsValueMapRenderer

public AimsValueMapRenderer(java.lang.String lookupField)

Creates new AimsValueMapRenderer setting the lookup field name

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 AimsValueMapRenderer or AimsRenderer before use.

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

add

public void add(AimsExact exactObj)

Adds an AimsExact value to the renderer.

add

public void add(AimsRange rangeObj)

Adds an AimsRange object to the renderer.

add

public void add(AimsOther otherObj)

Adds an AimsOther value to the renderer.

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.

remove

public void remove(int index)

Removes the object at the specified index.

Parameters:

index - The index number of the object.

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

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 text representation of of this class.

Specified by:

toString in interface AimsRenderer

Returns:

A string describing 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)

Sets the highlight color of the objects in this renderer.

Specified by:

highlight in interface AimsRenderer

Parameters:

highlightColor - The highlight color.

transparency - The transparency value.

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)

Has no effect for this type of renderer.

Specified by:

showLabels in interface AimsRenderer

Parameters:

showLabels - Has no effect for this type of renderer.

getObjectArray

public java.util.ArrayList getObjectArray()

Gets the array of AimsValueMapObjects contained in this renderer.

Returns:

An ArrayList containing the value map objects.

size

public int size()

Returns the number of objects contained in the renderer.

Returns:

The count.

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_VALUEMAP.