com.esri.aims.mtier.model.map.layer.renderer
Class ValueMapRenderer

java.lang.Object
  extended by com.esri.aims.mtier.model.map.layer.renderer.Renderer
      extended by com.esri.aims.mtier.model.map.layer.renderer.ValueMapRenderer
All Implemented Interfaces:
Serializable

public class ValueMapRenderer
extends Renderer

A ValueMapRenderer object allows different symbols to be set for different features on the map. The differences are set with the Exact, Other, and Range objects. The ValueMapRenderer object extends the Renderer object.

See Also:
Serialized Form

Constructor Summary
ValueMapRenderer()
          Constructs an instance of a ValueMapRenderer object.
 
Method Summary
 void addObject(Object obj)
          Adds the given 'ValueMap' object to the ValueMapRenderer collection.
 void clear()
          Clears all objects from the ValueMapRenderer collection.
 int count()
          Returns the count of all objects in the ValueMapRenderer collection.
 String getLookupField()
          Returns the ValueMapRenderer objects lookup field value.
 ValueMap getObject(int index)
          Returns a ValueMapRenderer object from the ValueMapRenderer collection.
 String getType()
          Returns object type as string,"ValueMap".
 Object remove(int index)
          Removes the object at given index from the ValueMapRenderer collection.
 Object replace(int index, Object obj)
          Replaces an object in the ValueMapRenderer collection.
 void setLookupField(String value)
          Sets the lookup field value for the ValueMapRenderer object.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ValueMapRenderer

public ValueMapRenderer()
Constructs an instance of a ValueMapRenderer object. Example:
ValueMapRenderer valueMap = new ValueMapRenderer();

Method Detail

getType

public String getType()
Returns object type as string,"ValueMap".

Specified by:
getType in class Renderer
Returns:
String

addObject

public void addObject(Object obj)
Adds the given 'ValueMap' object to the ValueMapRenderer collection. Example:
 Range range = new Range();
 range.setLower("0");
 range.setUpper("4500");
 range.setLabel("Less than 4500 [range]");
 SimplePolygonSymbol sps = new SimplePolygonSymbol();
 sps.setFillColor("250,240,230");
 range.setSymbol(sps);
 valueMapRender.addObject(range);
 

Parameters:
obj - the object to add.
See Also:
remove(int), clear(), getObject(int)

getObject

public ValueMap getObject(int index)
Returns a ValueMapRenderer object from the ValueMapRenderer collection. Example:
 ValueMap value = valueMap.getObject(2);
 

Parameters:
index - the object to return.
Returns:
Object
See Also:
addObject(java.lang.Object)

setLookupField

public void setLookupField(String value)
Sets the lookup field value for the ValueMapRenderer object. Example:
 valueMap.setLookupField("States");
 

Parameters:
value - the look up field value.
See Also:
getLookupField()

getLookupField

public String getLookupField()
Returns the ValueMapRenderer objects lookup field value. Example:
 String lookupfield = valueMap.getLookupField();
 

Returns:
String
See Also:
setLookupField(java.lang.String)

clear

public void clear()
Clears all objects from the ValueMapRenderer collection. Example:
 valueMap.clear();
 

See Also:
remove(int), addObject(java.lang.Object)

remove

public Object remove(int index)
Removes the object at given index from the ValueMapRenderer collection. Example:
 ValueMap value = valueMap.remove(0);
 

Parameters:
index - the object to remove.
Returns:
Object
See Also:
clear(), addObject(java.lang.Object)

count

public int count()
Returns the count of all objects in the ValueMapRenderer collection. Example:
 int count = valueMap.count();
 

Returns:
integer

replace

public Object replace(int index,
                      Object obj)
Replaces an object in the ValueMapRenderer collection. Example:
 ValueMap value = valueMap.getObject(2);
 valueMap.replace(3, value);
 

Parameters:
index - the object to replace.
obj - the replacement object.
Returns:
Object