com.moximedia.aims
Class AimsChartValue

java.lang.Object
  com.moximedia.aims.AimsChartValue

All Implemented Interfaces:

java.lang.Cloneable, java.io.Serializable

public class AimsChartValue

extends java.lang.Object

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

Implementation of ArcIMS CHARTVALUE object, used as sub-element of a CHARTSYMBOL. Many AimsChartValues may exist for a given AimsChartSymbol. This element was introduced at ArcIMS 3.1.

See Also:

Serialized Form

Constructor Summary

AimsChartValue()
Creates new AimsChartValue

AimsChartValue(int value, AimsColor color)
Creates new AimsChartValue with a value and color

AimsChartValue(java.lang.String lookupField, AimsColor color)
Creates new AimsChartValue with a field and color

AimsChartValue(java.lang.String lookupField, int lower, int upper, AimsColor color)
Creates new AimsChartValue with a field, values and color

Method Summary

java.lang.Object	clone() Creates a copy of this object.
AimsColor	getColor() Gets the value of the attribute color.
java.lang.String	getLookupField() Gets the value of the attribute lookupField.
int	getLower() Gets the value of the attribute lower.
int	getUpper() Gets the value of the attribute upper.
int	getValue() Gets the value of the attribute value.
boolean	isNull() Returns a boolean that indicates whether all of the required values are properly set.
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	setColor(AimsColor color) Sets the value of the attribute color.
void	setLookupField(java.lang.String lookupField) Sets the value of the attribute lookupField.
void	setLower(int lower) Sets the value of the attribute lower.
void	setUpper(int upper) Sets the value of the attribute upper.
void	setValue(int value) Sets the value of the attribute value.
java.lang.String	toAxlString() Returns the AXL string to refresh this object, using the default environment coordinate separators.
java.lang.String	toAxlString(AimsEnvironment env) Returns the AXL string to refresh this object, using the coordinate separators in the specified environnment setting.

Methods inherited from class java.lang.Object

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

Constructor Detail

AimsChartValue

public AimsChartValue()

Creates new AimsChartValue

AimsChartValue

public AimsChartValue(java.lang.String lookupField,
                      AimsColor color)

Creates new AimsChartValue with a field and color

Parameters:

lookupField - The lookup field for the chartvalue.

color - The color for the classification.

AimsChartValue

public AimsChartValue(java.lang.String lookupField,
                      int lower,
                      int upper,
                      AimsColor color)

Creates new AimsChartValue with a field, values and color

Parameters:

lookupField - The lookup field for the chartvalue.

lower - The lower chart value.

upper - The upper chart value

color - The color for the classification.

AimsChartValue

public AimsChartValue(int value,
                      AimsColor color)

Creates new AimsChartValue with a value and color

Parameters:

value - The chart value.

color - The color for the classification.

Method Detail

getColor

public AimsColor getColor()

Gets the value of the attribute color.

Returns:

The value of the attribute color.

getLookupField

public java.lang.String getLookupField()

Gets the value of the attribute lookupField.

Returns:

The value of the attribute lookupField.

getLower

public int getLower()

Gets the value of the attribute lower.

Returns:

The value of the attribute lower.

getUpper

public int getUpper()

Gets the value of the attribute upper.

Returns:

The value of the attribute upper.

getValue

public int getValue()

Gets the value of the attribute value.

Returns:

The value of the attribute value.

setColor

public void setColor(AimsColor color)

Sets the value of the attribute color.

Parameters:

color - The value of the attribute color.

setLookupField

public void setLookupField(java.lang.String lookupField)

Sets the value of the attribute lookupField.

Parameters:

lookupField - The value of the attribute lookupField.

setLower

public void setLower(int lower)

Sets the value of the attribute lower.

Parameters:

lower - The value of the attribute lower.

setUpper

public void setUpper(int upper)

Sets the value of the attribute upper.

Parameters:

upper - The value of the attribute upper.

setValue

public void setValue(int value)

Sets the value of the attribute value.

Parameters:

value - The value of the attribute value.

isNull

public boolean isNull()

Returns a boolean that indicates whether all of the required values are properly set.

Returns:

True if all set, otherwise false.

clone

public java.lang.Object clone()

Creates a copy of this object.

Returns:

An object that is a copy of this object. Note that the returned value is a java.lang.Object that must be cast to an AimsChartValue before use.

toAxlString

public java.lang.String toAxlString()

Returns the AXL string to refresh this object, using the default environment coordinate separators. This method is not typically used by the application programmer.

Returns:

The AXL string to refresh this object.

toAxlString

public java.lang.String toAxlString(AimsEnvironment env)

Returns the AXL string to refresh this object, using the coordinate separators in the specified environnment setting. This method is not typically used by the application programmer.

Parameters:

env - The environment object containing coordinate separators.

Returns:

The AXL string to refresh this object.

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