com.rapidminer.gui.new_plotter.configuration
Class DomainConfigManager

java.lang.Object
  com.rapidminer.gui.new_plotter.configuration.AbstractDimensionConfig
      com.rapidminer.gui.new_plotter.configuration.DomainConfigManager

All Implemented Interfaces:

AxisParallelLinesConfigurationListener, DimensionConfig, DimensionConfigListener, java.lang.Cloneable

public class DomainConfigManager
extends AbstractDimensionConfig
implements DimensionConfigListener, java.lang.Cloneable, AxisParallelLinesConfigurationListener

A class which manages the domain groupings of all ValueSources in a PlotConfiguration. This manager is necessary, because switching between grouping types is not possible all the time because of some constraints. The DimensionConfigManager enforces these constraints.

Author:

Marius Helf, Nils Woehler

Nested Class Summary

static class	DomainConfigManager.GroupingState
static class	DomainConfigManager.Sorting

Nested classes/interfaces inherited from interface com.rapidminer.gui.new_plotter.configuration.DimensionConfig

DimensionConfig.PlotDimension

Field Summary

Fields inherited from interface com.rapidminer.gui.new_plotter.configuration.DimensionConfig

DEFAULT_AXIS_LABEL, DEFAULT_DATE_FORMAT_STRING, DEFAULT_USE_USER_DEFINED_DATE_FORMAT, DEFAULT_USER_DEFINED_LOWER_BOUND, DEFAULT_USER_DEFINED_UPPER_BOUND

Constructor Summary

DomainConfigManager(PlotConfiguration plotConfiguration, DataTableColumn domainColumn)

Method Summary

void	axisParallelLineConfigurationsChanged(AxisParallelLinesConfigurationChangeEvent e)
DomainConfigManager	clone()
void	colorSchemeChanged()
void	dimensionConfigChanged(DimensionConfigChangeEvent change)
AxisParallelLinesConfiguration	getCrosshairLines()
DataTableColumn	getDataTableColumn() Returns the DataTableColumn from which this DimensionConfig gets its raw values.
java.text.DateFormat	getDateFormat() Returns a DateFormat to be used for formatting dates on this axis.
DimensionConfig.PlotDimension	getDimension()
DataTableColumn	getDomainColumn()
DefaultDimensionConfig	getDomainConfig(boolean grouped)
java.util.List<PlotConfigurationError>	getErrors()
ValueGrouping	getGrouping()
DomainConfigManager.GroupingState	getGroupingState()
int	getId()
java.lang.String	getLabel() Returns the label of the dimension config that will be shown in the GUI.
DomainConfigManager.Sorting	getSortingMode()
java.util.Set<DataTableColumn.ValueType>	getSupportedValueTypes()
java.lang.String	getUserDefinedDateFormatString()
java.lang.Double	getUserDefinedLowerBound()
ValueRange	getUserDefinedRangeClone(DataTable dataTable) Returns the range of data which is used to create the diagram.
java.lang.Double	getUserDefinedUpperBound()
java.util.Vector<ValueGrouping.GroupingType>	getValidGroupingTypes()
DataTableColumn.ValueType	getValueType()
java.util.List<PlotConfigurationError>	getWarnings()
boolean	isAutoNaming()
boolean	isAutoRangeRequired()
boolean	isDate()
boolean	isGrouping() Returns true if at least one ValueSource in the PlotConfiguration uses the domain axis grouping provided by this DomainConfigManager.
boolean	isLogarithmic()
boolean	isLogarithmicDomainAxis()
boolean	isNominal()
boolean	isNumerical()
boolean	isUsingUserDefinedDateFormat()
boolean	isUsingUserDefinedLowerBound()
boolean	isUsingUserDefinedUpperBound()
boolean	isValid()
void	resetToDefaults()
void	setAutoNaming(boolean autoNaming)
void	setDataTableColumn(DataTableColumn column)
void	setGrouping(ValueGrouping grouping)
void	setLabel(java.lang.String label)
void	setLogarithmic(boolean logarithmic)
void	setLowerBound(java.lang.Double lowerBound)
void	setPlotConfiguration(PlotConfiguration plotConfiguration)
void	setSortingMode(DomainConfigManager.Sorting sortingMode)
void	setUpperBound(java.lang.Double upperBound)
void	setUserDefinedDateFormatString(java.lang.String formatString)
void	setUserDefinedRange(NumericalValueRange range)
void	setUseUserDefinedDateFormat(boolean yes)
void	setUseUserDefinedLowerBound(boolean useLowerBound)
void	setUseUserDefinedUpperBound(boolean useUpperBound)

Methods inherited from class com.rapidminer.gui.new_plotter.configuration.AbstractDimensionConfig

addDimensionConfigListener, fireDimensionConfigChanged, isFiringEvents, removeDimensionConfigListener, setFireEvents

Methods inherited from class java.lang.Object

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

Constructor Detail

DomainConfigManager

public DomainConfigManager(PlotConfiguration plotConfiguration,
                           DataTableColumn domainColumn)

Method Detail

getDomainConfig

public DefaultDimensionConfig getDomainConfig(boolean grouped)

isLogarithmicDomainAxis

public boolean isLogarithmicDomainAxis()

getUserDefinedRangeClone

public ValueRange getUserDefinedRangeClone(DataTable dataTable)

Description copied from interface: DimensionConfig

Returns the range of data which is used to create the diagram. Note that this is not necessarily the data the user sees, because he might apply further filtering by zooming. Might return null, which indicates that all values should be used. Returns a clone of the actual range, so changing the returned object does not actually change the range of this DimensionConfig.

Specified by:

getUserDefinedRangeClone in interface DimensionConfig

getDomainColumn

public DataTableColumn getDomainColumn()

getDimension

public DimensionConfig.PlotDimension getDimension()

Specified by:

getDimension in interface DimensionConfig

Overrides:

getDimension in class AbstractDimensionConfig

getDataTableColumn

public DataTableColumn getDataTableColumn()

Description copied from interface: DimensionConfig

Returns the DataTableColumn from which this DimensionConfig gets its raw values.

Specified by:

getDataTableColumn in interface DimensionConfig

getGrouping

public ValueGrouping getGrouping()

Specified by:

getGrouping in interface DimensionConfig

getLabel

public java.lang.String getLabel()

Description copied from interface: DimensionConfig

Returns the label of the dimension config that will be shown in the GUI.

Specified by:

getLabel in interface DimensionConfig

isAutoRangeRequired

public boolean isAutoRangeRequired()

Specified by:

isAutoRangeRequired in interface DimensionConfig

isLogarithmic

public boolean isLogarithmic()

Specified by:

isLogarithmic in interface DimensionConfig

isAutoNaming

public boolean isAutoNaming()

Specified by:

isAutoNaming in interface DimensionConfig

setDataTableColumn

public void setDataTableColumn(DataTableColumn column)

Specified by:

setDataTableColumn in interface DimensionConfig

getSortingMode

public DomainConfigManager.Sorting getSortingMode()

setSortingMode

public void setSortingMode(DomainConfigManager.Sorting sortingMode)

setUserDefinedRange

public void setUserDefinedRange(NumericalValueRange range)

Specified by:

setUserDefinedRange in interface DimensionConfig

setLogarithmic

public void setLogarithmic(boolean logarithmic)

Specified by:

setLogarithmic in interface DimensionConfig

setAutoNaming

public void setAutoNaming(boolean autoNaming)

Specified by:

setAutoNaming in interface DimensionConfig

setLabel

public void setLabel(java.lang.String label)

Specified by:

setLabel in interface DimensionConfig

getErrors

public java.util.List<PlotConfigurationError> getErrors()

Specified by:

getErrors in interface DimensionConfig

getWarnings

public java.util.List<PlotConfigurationError> getWarnings()

Specified by:

getWarnings in interface DimensionConfig

isValid

public boolean isValid()

Specified by:

isValid in interface DimensionConfig

getValueType

public DataTableColumn.ValueType getValueType()

Specified by:

getValueType in interface DimensionConfig

isNominal

public boolean isNominal()

Specified by:

isNominal in interface DimensionConfig

isNumerical

public boolean isNumerical()

Specified by:

isNumerical in interface DimensionConfig

isDate

public boolean isDate()

Specified by:

isDate in interface DimensionConfig

setGrouping

public void setGrouping(ValueGrouping grouping)

Specified by:

setGrouping in interface DimensionConfig

setUpperBound

public void setUpperBound(java.lang.Double upperBound)

Specified by:

setUpperBound in interface DimensionConfig

setLowerBound

public void setLowerBound(java.lang.Double lowerBound)

Specified by:

setLowerBound in interface DimensionConfig

getUserDefinedUpperBound

public java.lang.Double getUserDefinedUpperBound()

Specified by:

getUserDefinedUpperBound in interface DimensionConfig

getUserDefinedLowerBound

public java.lang.Double getUserDefinedLowerBound()

Specified by:

getUserDefinedLowerBound in interface DimensionConfig

isGrouping

public boolean isGrouping()

Returns true if at least one ValueSource in the PlotConfiguration uses the domain axis grouping provided by this DomainConfigManager.

Specified by:

isGrouping in interface DimensionConfig

See Also:

DimensionConfig.isGrouping()

getGroupingState

public DomainConfigManager.GroupingState getGroupingState()

dimensionConfigChanged

public void dimensionConfigChanged(DimensionConfigChangeEvent change)

Specified by:

dimensionConfigChanged in interface DimensionConfigListener

getValidGroupingTypes

public java.util.Vector<ValueGrouping.GroupingType> getValidGroupingTypes()

Specified by:

getValidGroupingTypes in interface DimensionConfig

getSupportedValueTypes

public java.util.Set<DataTableColumn.ValueType> getSupportedValueTypes()

Specified by:

getSupportedValueTypes in interface DimensionConfig

isUsingUserDefinedLowerBound

public boolean isUsingUserDefinedLowerBound()

Specified by:

isUsingUserDefinedLowerBound in interface DimensionConfig

isUsingUserDefinedUpperBound

public boolean isUsingUserDefinedUpperBound()

Specified by:

isUsingUserDefinedUpperBound in interface DimensionConfig

setUseUserDefinedUpperBound

public void setUseUserDefinedUpperBound(boolean useUpperBound)

Specified by:

setUseUserDefinedUpperBound in interface DimensionConfig

setUseUserDefinedLowerBound

public void setUseUserDefinedLowerBound(boolean useLowerBound)

Specified by:

setUseUserDefinedLowerBound in interface DimensionConfig

clone

public DomainConfigManager clone()

Overrides:

clone in class java.lang.Object

colorSchemeChanged

public void colorSchemeChanged()

Specified by:

colorSchemeChanged in interface DimensionConfig

setPlotConfiguration

public void setPlotConfiguration(PlotConfiguration plotConfiguration)

axisParallelLineConfigurationsChanged

public void axisParallelLineConfigurationsChanged(AxisParallelLinesConfigurationChangeEvent e)

Specified by:

axisParallelLineConfigurationsChanged in interface AxisParallelLinesConfigurationListener

getCrosshairLines

public AxisParallelLinesConfiguration getCrosshairLines()

getDateFormat

public java.text.DateFormat getDateFormat()

Description copied from interface: DimensionConfig

Returns a DateFormat to be used for formatting dates on this axis.

Specified by:

getDateFormat in interface DimensionConfig

Returns:

the date format used to format dates on this axis.

setUserDefinedDateFormatString

public void setUserDefinedDateFormatString(java.lang.String formatString)

Specified by:

setUserDefinedDateFormatString in interface DimensionConfig

getUserDefinedDateFormatString

public java.lang.String getUserDefinedDateFormatString()

Specified by:

getUserDefinedDateFormatString in interface DimensionConfig

setUseUserDefinedDateFormat

public void setUseUserDefinedDateFormat(boolean yes)

Specified by:

setUseUserDefinedDateFormat in interface DimensionConfig

isUsingUserDefinedDateFormat

public boolean isUsingUserDefinedDateFormat()

Specified by:

isUsingUserDefinedDateFormat in interface DimensionConfig

getId

public int getId()

Specified by:

getId in interface DimensionConfig

resetToDefaults

public void resetToDefaults()