com.esri.aims.mtier.model.map.layer.renderer.symbol
Class ChartValue

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

public class ChartValue
extends Object
implements Serializable

ChartValue objects are assigned to a ChartSymbol object and they depict the values of the symbol.

See Also:
Serialized Form

Constructor Summary
ChartValue()
          Constructs an instance of a ChartValue object.
 
Method Summary
 String getColor()
          Returns the color value set for the chart segment as a RGB value.
 String getLookUpField()
          Returns the lookup field for the chart segment.
 long getLower()
          Returns the minimum value for drawing the segment.
 long getUpper()
          Returns the maximum value for drawing the segment.
 long getValue()
          Returns the chart segment value.
 void setColor(String value)
          Sets the color used for segment of pie or chart using the given RGB values.
 void setLookUpField(String value)
          Sets the lookup field for the chart segment.
 void setLower(long value)
          Sets the minimum value for drawing the segment.
 void setUpper(long value)
          Sets the maximum value for drawing the segment.
 void setValue(long value)
          Used to change the color of a chart segment depending on the value.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ChartValue

public ChartValue()
Constructs an instance of a ChartValue object.

ChartValue chartValue = new ChartValue();

Method Detail

setLookUpField

public void setLookUpField(String value)
Sets the lookup field for the chart segment. The field can be in the layer table or a joined table.

 chartValue.setLookUpField("States");
 

Parameters:
value - the lookup field value.
See Also:
getLookUpField()

getLookUpField

public String getLookUpField()
Returns the lookup field for the chart segment.

 String lookUpField = chartValue.getLookUpField();
 

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

setColor

public void setColor(String value)
Sets the color used for segment of pie or chart using the given RGB values.

 chartValue.setColor("255,0,0");
 

Parameters:
value - the color value.
See Also:
getColor()

getColor

public String getColor()
Returns the color value set for the chart segment as a RGB value.

 String color = chartValue.getColor();
 

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

setLower

public void setLower(long value)
Sets the minimum value for drawing the segment. This value is used with upper to determine the minimum value for drawing a chart symbol.

 chartSymbol.setLower(100001);
 

Parameters:
value - the minimum value.
See Also:
getLower()

getLower

public long getLower()
Returns the minimum value for drawing the segment.

 long lower = chartValue.getLower();
 

Returns:
long
See Also:
setLower(long)

setUpper

public void setUpper(long value)
Sets the maximum value for drawing the segment. This value is used with lower to determine the maximum value for drawing a chart symbol.

 chartValue.setUpper(2000000);
 

Parameters:
value - the maximum value.
See Also:
getUpper()

getUpper

public long getUpper()
Returns the maximum value for drawing the segment.

 long upper = chartValue.getUpper();
 

Returns:
long
See Also:
setUpper(long)

setValue

public void setValue(long value)
Used to change the color of a chart segment depending on the value.

 chartValue.setValue(2000000);
 

Parameters:
value - the chart segment value.
See Also:
getValue()

getValue

public long getValue()
Returns the chart segment value.

 long value = chartValue.getValue();
 

Returns:
long
See Also:
setValue(long)