com.davisor.graphics.data
Class ColorScaleType

java.lang.Object
  java.text.Format
      com.davisor.data.Type
          com.davisor.graphics.data.PaintType
              com.davisor.graphics.data.ColorScaleType

All Implemented Interfaces:

java.lang.Cloneable, java.util.Comparator, com.davisor.core.Dupable, java.io.Serializable

public class ColorScaleType

extends PaintType

ColorScaleType defines a color scale paint mapper that maps abritary data values to a color spectrum.

Since:

JDK1.1

See Also:

ColorData, GradientData, PaintType, TextureType, Serialized Form

Nested Class Summary

Nested classes inherited from class java.text.Format

java.text.Format.Field

Field Summary

protected java.awt.Color	M_color1 Color scale lower limit.
protected java.awt.Color	M_color2 Color scale upper limit.
protected boolean	M_cyclic Color scale cyclic flag.
protected Deinterpolator	M_deinterpolator Color scale deinterpolator.
static java.lang.String	TYPENAME Type name ("COLORSCALE").

Fields inherited from class com.davisor.graphics.data.PaintType

DEFAULT

Fields inherited from class com.davisor.data.Type

METADATA_GROUP, METADATA_NAME, METADATA_PARENT, METADATA_SUBCHANNELS

Constructor Summary

	ColorScaleType() Default constructor.
	ColorScaleType(ColorScaleType cst) Depp copy constructor.
	ColorScaleType(java.lang.String dataName, java.lang.String id, java.util.Map metaData, java.net.URL context, java.lang.Object minValue, java.lang.Object maxValue, java.awt.Color color1, java.awt.Color color2, boolean cyclic) Creates a new type.
	ColorScaleType(java.lang.String dataName, java.lang.String id, java.lang.String format) Constructs a new type with given spesification.
protected	ColorScaleType(java.lang.String typeName, java.lang.String dataName, java.lang.String id, java.util.Map metaData, java.net.URL context, java.lang.Object minValue, java.lang.Object maxValue, java.awt.Color color1, java.awt.Color color2, boolean cyclic) Creates a new type.

Method Summary

com.davisor.core.Dupable	dup() Makes a deep copy of this object.
DataValue	getColor() Gets current deinterpolated color value.
void	setValue(DataValue value) Sets current deinterpolator value.
DataValue	toData(java.sql.CallableStatement call, int column) Get callable statement result value.
DataValue	toData(java.lang.Object value) Converts an object to a color scale color value.
DataValue	toData(java.sql.ResultSet set, int column) Parse a result set output value as a data object.
DataValue	toData(java.lang.String data, java.text.ParsePosition status) Converts a string to a color scale color value.

Methods inherited from class com.davisor.graphics.data.PaintType

createColor, createColor, createPaint, createPaint, equals, getContext, getPaints, getValueClass, one, setContext, toData, zero

Methods inherited from class com.davisor.data.Type

ceil, check, check, compare, create, create, create, create, create, dup, floor, format, getCompatibility, getDataName, getFormat, getId, getID, getMetaData, getMetaData, getSpecs, getSQLCode, getSQLName, getSQLName, getTypeName, hashCode, isNull, parseObject, register, register, setDataName, setFormat, setId, setID, setMetaData, setMetaData, setSpecs, toString, toXML, xmlEnd, xmlStart

Methods inherited from class java.text.Format

clone, format, formatToCharacterIterator, parseObject

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

TYPENAME

public static final java.lang.String TYPENAME

Type name ("COLORSCALE").

See Also:

Constant Field Values

M_color1

protected java.awt.Color M_color1

Color scale lower limit.

M_color2

protected java.awt.Color M_color2

Color scale upper limit.

M_cyclic

protected boolean M_cyclic

Color scale cyclic flag.

M_deinterpolator

protected Deinterpolator M_deinterpolator

Color scale deinterpolator.

Constructor Detail

ColorScaleType

public ColorScaleType()

Default constructor.

ColorScaleType

public ColorScaleType(ColorScaleType cst)

Depp copy constructor.

ColorScaleType

public ColorScaleType(java.lang.String dataName,
                      java.lang.String id,
                      java.lang.String format)

Constructs a new type with given spesification.

Parameters:

dataName - data name (may be null)

id - type identity (may be null)

format - type spesification (may be null)

See Also:

Type.setFormat(java.lang.String)

ColorScaleType

public ColorScaleType(java.lang.String dataName,
                      java.lang.String id,
                      java.util.Map metaData,
                      java.net.URL context,
                      java.lang.Object minValue,
                      java.lang.Object maxValue,
                      java.awt.Color color1,
                      java.awt.Color color2,
                      boolean cyclic)

Creates a new type.

Parameters:

dataName - data name (may be null)

id - type identity (may be null)

metaData - type meta data map (may be null)

context - context for partially specified URL addesses (may be null)

minValue - color scale lower data value

maxValue - color scale upper data value

color1 - color scale lower color value

color2 - color scale lower color value

cyclic - color scale cyclic control

ColorScaleType

protected ColorScaleType(java.lang.String typeName,
                         java.lang.String dataName,
                         java.lang.String id,
                         java.util.Map metaData,
                         java.net.URL context,
                         java.lang.Object minValue,
                         java.lang.Object maxValue,
                         java.awt.Color color1,
                         java.awt.Color color2,
                         boolean cyclic)

Creates a new type.

Parameters:

typeName - type name

dataName - data name (may be null)

id - type identity (may be null)

metaData - type meta data map (may be null)

context - context for partially specified URL addesses (may be null)

minValue - color scale lower data value

maxValue - color scale upper data value

color1 - color scale lower color value

color2 - color scale lower color value

cyclic - color scale cyclic control

Method Detail

dup

public com.davisor.core.Dupable dup()

Makes a deep copy of this object.

Specified by:

dup in interface com.davisor.core.Dupable

Overrides:

dup in class PaintType

getColor

public DataValue getColor()

Gets current deinterpolated color value.

See Also:

setValue(com.davisor.data.DataValue), ColorData

setValue

public void setValue(DataValue value)

Sets current deinterpolator value.

See Also:

getColor(), Deinterpolator.setValue(DataValue)

toData

public DataValue toData(java.lang.String data,
                        java.text.ParsePosition status)
                 throws InvalidDataException

Converts a string to a color scale color value. The string is first passed to underlying deinterpolator, which interpretes it, and deinterpolates it to a scalar value. A color data instance matching that scalar value is then returned.

Overrides:

toData in class PaintType

Parameters:

data - a paint data string

status - parse status

Returns:

a new color data object

Throws:

InvalidDataException - if data can not be converted to a paint value

See Also:

getColor()

toData

public DataValue toData(java.lang.Object value)
                 throws InvalidDataException

Converts an object to a color scale color value. The obect is first passed to underlying deinterpolator, which interpretes it, and deinterpolates it to a scalar value. A color data instance matching that scalar value is then returned.

Overrides:

toData in class PaintType

Parameters:

value - the object to be converted

Returns:

a new color data object

Throws:

InvalidDataException - if object can not be converted

See Also:

getColor()

toData

public DataValue toData(java.sql.CallableStatement call,
                        int column)
                 throws InvalidDataException,
                        java.sql.SQLException

Get callable statement result value. The statement value is first passed to underlying deinterpolator, which interpretes it, and deinterpolates it to a scalar value. A color data instance matching that scalar value is then returned.

Overrides:

toData in class Type

Parameters:

call - statement holding the data value to be converted

column - SQL column index for the data value to be converted

Returns:

a new color data object

Throws:

InvalidDataException - if result set data can not be converted

java.sql.SQLException - if a SQL error occurs

See Also:

getColor()

toData

public DataValue toData(java.sql.ResultSet set,
                        int column)
                 throws InvalidDataException,
                        java.sql.SQLException

Parse a result set output value as a data object. The value is first passed to underlying deinterpolator, which interpretes it, and deinterpolates it to a scalar value. A color data instance matching that scalar value is then returned.

Overrides:

toData in class Type

Parameters:

set - resultSet holding the data value to be converted

column - SQL column index for the data value to be converted

Returns:

a new color data object

Throws:

InvalidDataException - if result set data can not be converted

java.sql.SQLException - if a SQL error occurs

See Also:

getColor()