de.esoco.data.element

Class DataSetDataElement

java.lang.Object

de.esoco.lib.property.AbstractStringProperties

de.esoco.lib.property.StringProperties

de.esoco.data.element.DataElement<de.esoco.lib.model.DataSet<?>>

de.esoco.data.element.DataSetDataElement

All Implemented Interfaces:

de.esoco.lib.property.HasProperties, de.esoco.lib.property.MutableProperties, java.io.Serializable

public class DataSetDataElement
extends DataElement<de.esoco.lib.model.DataSet<?>>

A data element that stores a DataSet for a chart.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DataSetDataElement.ChartType Redefinition of chart types to make them available on the server side.
static class	DataSetDataElement.LegendPosition Redefinition of legend positions to make them available on the server side.

Nested classes/interfaces inherited from class de.esoco.data.element.DataElement

DataElement.CopyMode, DataElement.Flag

Field Summary

Fields

Modifier and Type	Field and Description
static de.esoco.lib.property.PropertyName<java.lang.Boolean>	CHART_3D Boolean property: display chart in 3D
static de.esoco.lib.property.PropertyName<de.esoco.lib.property.Color>	CHART_BACKGROUND The chart background color
static de.esoco.lib.property.PropertyName<DataSetDataElement.LegendPosition>	CHART_LEGEND_POSITION Enum property: the legend position of the chart (for possible values see DataSetDataElement.LegendPosition)
static de.esoco.lib.property.PropertyName<DataSetDataElement.ChartType>	CHART_TYPE Enum property: the type of the chart to render (for possible values see DataSetDataElement.ChartType)

Fields inherited from class de.esoco.data.element.DataElement

ALLOWED_VALUES_CHANGED, ANONYMOUS_ELEMENT_PREFIX, DISPLAY_FLAGS, HIDDEN_URL, INPUT_FLAGS, INTERACTION_URL, ITEM_ALL_RESOURCE, ITEM_NEW_RESOURCE, ITEM_RESOURCE_PREFIX, PATH_SEPARATOR_CHAR, SERVER_PROPERTIES

Constructor Summary

Constructors

Constructor and Description
DataSetDataElement(java.lang.String sName, de.esoco.lib.model.DataSet<?> aDataSet, DataSetDataElement.ChartType eChartType, DataSetDataElement.LegendPosition eLegendPosition, java.lang.String sBackgroundColor, boolean b3D) Creates a new instance with certain display properties set.
DataSetDataElement(java.lang.String sName, de.esoco.lib.model.DataSet<?> rDataSet, java.util.Set<DataElement.Flag> rFlags) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
DataSetDataElement	copy(DataElement.CopyMode eMode, de.esoco.lib.property.PropertyName<?>... rCopyProperties) Returns a copy of this data element that contains all or a subset of it's current state.
de.esoco.lib.model.DataSet<?>	getValue() //~ Methods ---------------------------------------------------------------- /*************************************** Returns the value of this element.
static void	init() This method should be invoked to initialize the property name constants for de-serialization.
protected DataSetDataElement	newInstance() Returns a new instance of the respective data element sub-type on which it is invoked.
protected void	updateValue(de.esoco.lib.model.DataSet<?> rNewDataSet) Updates the element value.

Methods inherited from class de.esoco.data.element.DataElement

checkImmutable, checkValidValue, copyAttributes, copyValue, createItemName, createItemResource, createResourceId, equals, getAllowedValues, getElementValidator, getName, getParent, getPath, getResourceId, getRoot, getSimpleName, getValidator, getValueHashCode, hasEqualValueAs, hashCode, isImmutable, isModified, isOptional, isSelected, isValidValue, markAsChanged, readFrom, removeProperty, setModified, setProperty, setSelected, setStringValue, setValidator, setValue, toDebugString, toString, valuesEqual, writeTo

Methods inherited from class de.esoco.lib.property.StringProperties

clearFlag, clearProperties, setFlag, setProperties, setProperty, setProperty

Methods inherited from class de.esoco.lib.property.AbstractStringProperties

convertCollection, convertMap, convertValue, ensurePropertyMapExists, findValue, getIntProperty, getProperty, getPropertyCount, getPropertyMap, getPropertyNames, hasEqualProperties, hasFlag, hasProperty, parseCollection, parseMap, parseValue, setPropertyMap

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.esoco.lib.property.HasProperties

getIntProperty, getProperty, getPropertyCount, getPropertyNames, hasFlag, hasProperty

Field Detail

CHART_TYPE

public static final de.esoco.lib.property.PropertyName<DataSetDataElement.ChartType> CHART_TYPE

Enum property: the type of the chart to render (for possible values see DataSetDataElement.ChartType)

CHART_LEGEND_POSITION

public static final de.esoco.lib.property.PropertyName<DataSetDataElement.LegendPosition> CHART_LEGEND_POSITION

Enum property: the legend position of the chart (for possible values see DataSetDataElement.LegendPosition)

CHART_BACKGROUND

public static final de.esoco.lib.property.PropertyName<de.esoco.lib.property.Color> CHART_BACKGROUND

The chart background color

CHART_3D

public static final de.esoco.lib.property.PropertyName<java.lang.Boolean> CHART_3D

Boolean property: display chart in 3D

Constructor Detail

DataSetDataElement

public DataSetDataElement(java.lang.String sName,
                          de.esoco.lib.model.DataSet<?> rDataSet,
                          java.util.Set<DataElement.Flag> rFlags)

Creates a new instance.

Parameters:

sName - The name of the data element

rDataSet - The data set for the chart

rFlags - The flags for this instance

DataSetDataElement

public DataSetDataElement(java.lang.String sName,
                          de.esoco.lib.model.DataSet<?> aDataSet,
                          DataSetDataElement.ChartType eChartType,
                          DataSetDataElement.LegendPosition eLegendPosition,
                          java.lang.String sBackgroundColor,
                          boolean b3D)

Creates a new instance with certain display properties set.

Parameters:

sName - The name of the data element

aDataSet - The chart data

eChartType - The chart type

eLegendPosition - The legend position

sBackgroundColor - The chart background color

b3D - TRUE for a 3D chart

Method Detail

init

public static void init()

This method should be invoked to initialize the property name constants for de-serialization.

copy

public DataSetDataElement copy(DataElement.CopyMode eMode,
                               de.esoco.lib.property.PropertyName<?>... rCopyProperties)

Returns a copy of this data element that contains all or a subset of it's current state. Always copied are the name and flags. Never copied is the parent reference because upon copying typically a reference to a copied parent needs to be set. The further data the copy contains depends on the copy mode:

• DataElement.CopyMode.FULL: The copy contains all data (except the parent reference).
• DataElement.CopyMode.FLAT: like DataElement.CopyMode.FULL but without sub-ordinate data elements.
• DataElement.CopyMode.PROPERTIES: The copy contains only the properties but not the element value and attributes.
• DataElement.CopyMode.PLACEHOLDER: The copy contains only the element name to serve as a placeholder.

The copy instance is created by invoking DataElement.newInstance() which has the recommendation to overwrite the return type to the concrete subtype to prevent the need for casting by the invoking code. For the same reason it is recommended that subclasses also override this method with the concrete return type and cast the result of super.copy() to that type.

Overrides:

copy in class DataElement<de.esoco.lib.model.DataSet<?>>

Parameters:

eMode - The copy mode

rCopyProperties - An optional list of properties to copy. If not provided all properties will be copied (unless the mode is DataElement.CopyMode.PLACEHOLDER)

Returns:

The copied instance

getValue

public de.esoco.lib.model.DataSet<?> getValue()

Description copied from class: DataElement

//~ Methods ---------------------------------------------------------------- /*************************************** Returns the value of this element. Each subclass must implement this method separately because some environments (like GWT) require serializable objects to use specific types for serializable fields. Therefore it is not possible to store a generic Object value in the base class.

Specified by:

getValue in class DataElement<de.esoco.lib.model.DataSet<?>>

Returns:

The element value

See Also:

DataElement.getValue()

newInstance

protected DataSetDataElement newInstance()

Returns a new instance of the respective data element sub-type on which it is invoked. This is needed for GWT which doesn't support reflection. Used by DataElement.copy(CopyMode, PropertyName...) for cloning an instance. Implementations should overwrite the return type with their concrete type to prevent the need for casting by the invoking code.

Specified by:

newInstance in class DataElement<de.esoco.lib.model.DataSet<?>>

Returns:

The new instance

updateValue

protected void updateValue(de.esoco.lib.model.DataSet<?> rNewDataSet)

Description copied from class: DataElement

Updates the element value. Will be invoked by DataElement.setValue(Object) to store a new value after validation. If a subclass wants to reject certain values it should do so in the DataElement.isValidValue(Validator, Object) method. Subclasses that are always immutable should implement an assertion because if the element has been initialized correctly (validator = NULL) this method should then be reached.

Specified by:

updateValue in class DataElement<de.esoco.lib.model.DataSet<?>>

Parameters:

rNewDataSet - The new value for this element

See Also:

DataElement.updateValue(Object)