ilog.views.chart.datax

Class IlvDefaultDataColumnInfo

java.lang.Object

ilog.views.chart.datax.IlvAbstractDataColumnInfo

ilog.views.chart.datax.IlvDefaultDataColumnInfo

All Implemented Interfaces:

IlvDataColumnInfo, IlvStaticColumnInfo, Serializable, Cloneable

public class IlvDefaultDataColumnInfo
extends IlvAbstractDataColumnInfo
implements Cloneable, Serializable

This class is the default implementation of the IlvDataColumnInfo interface.

It stores the column properties (type, empty value replacement, and so on) locally in this instance.

Since:

JViews 7.5

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
IlvDefaultDataColumnInfo() Creates a column info with an empty name and value type String.
IlvDefaultDataColumnInfo(String name, Class type) Creates a column info with the given name and value type.
IlvDefaultDataColumnInfo(String name, Class type, boolean enumerated) Creates a column info with the given name and value type, possibly enumerated.

Method Summary

Modifier and Type	Method and Description
Object	clone() Returns a copy of this object.
Object	getEmptyValue() Returns the replacement value when a record has no value for this column.
Object	getEnumValue(int i) Returns one of the possible values.
List	getEnumValues() Returns the list of possible values if this column is enumerated.
Object	getMaxValue() Returns the theoretical maximum value of this column.
Object	getMinValue() Returns the theoretical minimum value of this column.
String	getName() Returns the name of the column.
Class	getType() Returns the value type of the column.
boolean	isEnumerated() Returns true if this column stores enumerated values, meaning that there are only a few possible values.
void	setEmptyValue(Object emptyValue) Sets the replacement value when a record has no value for this column.
void	setEnumerated(boolean enumerated) Sets the column to enumerated or not.
void	setEnumValue(int i, Object value) Sets one of the possible values.
void	setEnumValues(List enumValues) Sets the list of possible values if this column is enumerated.
void	setMaxValue(Object max) Sets the theoretical maximum value of this column.
void	setMinValue(Object min) Sets the theoretical minimum value of this column.
void	setName(String name) Sets the name of the column.
void	setType(Class type) Sets the type of the values of this column.

Methods inherited from class ilog.views.chart.datax.IlvAbstractDataColumnInfo

addDataColumnListener, fireColumnEvent, removeDataColumnListener

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvDefaultDataColumnInfo

public IlvDefaultDataColumnInfo()

Creates a column info with an empty name and value type String.

IlvDefaultDataColumnInfo

public IlvDefaultDataColumnInfo(String name,
                                Class type)

Creates a column info with the given name and value type.

IlvDefaultDataColumnInfo

public IlvDefaultDataColumnInfo(String name,
                                Class type,
                                boolean enumerated)

Creates a column info with the given name and value type, possibly enumerated.

Method Detail

getName

public String getName()

Returns the name of the column.

The name is used in the chart display. It is used for accessing the column data only in some implementation of IlvModelWithColumns (such as IlvFlatListModel or IlvTreeListModel).

Specified by:

getName in interface IlvStaticColumnInfo

setName

public void setName(String name)

Sets the name of the column.

When using this function, you should make sure that two columns of the same IlvModelWithColumns do not have the same name.

This method should not be called once this instance is already connected to an IlvModelWithColumns because no notification is sent when the name changes.

getType

public Class getType()

Returns the value type of the column.

Specified by:

getType in interface IlvStaticColumnInfo

Returns:

A class to which all values of the column belong.

setType

public void setType(Class type)

Sets the type of the values of this column.

This method should not be called once this instance is already connected to an IlvModelWithColumns because no notification is sent when the type changes.

getEmptyValue

public Object getEmptyValue()

Returns the replacement value when a record has no value for this column.

Specified by:

getEmptyValue in interface IlvDataColumnInfo

Returns:

A non-null object belonging to the getType() class.

setEmptyValue

public void setEmptyValue(Object emptyValue)

Sets the replacement value when a record has no value for this column.

Parameters:

emptyValue - The new replacement for an empty value, should belong to the getType() class.

isEnumerated

public boolean isEnumerated()

Returns true if this column stores enumerated values, meaning that there are only a few possible values.

Specified by:

isEnumerated in interface IlvDataColumnInfo

setEnumerated

public void setEnumerated(boolean enumerated)

Sets the column to enumerated or not.

getEnumValues

public List getEnumValues()

Returns the list of possible values if this column is enumerated.

Specified by:

getEnumValues in interface IlvDataColumnInfo

Returns:

An unmodifiable list of non-null objects, each one belonging to the getType() class, or null if the possible values are not fixed but depend on the contents of the model, or null if isEnumerated() is false.

setEnumValues

public void setEnumValues(List enumValues)

Sets the list of possible values if this column is enumerated.

Parameters:

enumValues - A list of non-null objects, each belonging to the getType() class.

getEnumValue

public Object getEnumValue(int i)

Returns one of the possible values.

Note: This method can only be called after setEnumValues(java.util.List) has been called with a non-null list as argument.

setEnumValue

public void setEnumValue(int i,
                         Object value)

Sets one of the possible values.

Note: This method can only be called after setEnumValues(java.util.List) has been called with a non-null list as argument.

getMinValue

public Object getMinValue()

Returns the theoretical minimum value of this column.

Specified by:

getMinValue in interface IlvDataColumnInfo

Returns:

A non-null object belonging to the getType() class, or null when there is no theoretical minimum.

setMinValue

public void setMinValue(Object min)

Sets the theoretical minimum value of this column.

Parameters:

min - A non-null object belonging to the getType() class, or null when there is no theoretical minimum.

getMaxValue

public Object getMaxValue()

Returns the theoretical maximum value of this column.

Specified by:

getMaxValue in interface IlvDataColumnInfo

Returns:

A non-null object belonging to the getType() class, or null when there is no theoretical maximum.

setMaxValue

public void setMaxValue(Object max)

Sets the theoretical maximum value of this column.

Parameters:

max - A non-null object belonging to the getType() class, or null when there is no theoretical maximum.

clone

public Object clone()

Returns a copy of this object.

Specified by:

clone in interface IlvStaticColumnInfo

Overrides:

clone in class IlvAbstractDataColumnInfo

See Also:

Cloneable