Package idare.imagenode.Interfaces.Layout

Class DataSetLayoutProperties

java.lang.Object

idare.imagenode.Interfaces.Layout.DataSetLayoutProperties

All Implemented Interfaces:

idare.imagenode.internal.IDAREService, Serializable

Direct Known Subclasses:

AbstractArrayDataSetProperties, MultiArrayDataProperties

public abstract class DataSetLayoutProperties
extends Object
implements idare.imagenode.internal.IDAREService, Serializable

DataSetLayoutProperties allow the use of a specific class of DataSets for multiple different layouts. They contain information about localisation preferences and can provide different DataContainers (and thus layouts). The DataSetProperties should be independent of the DataSet they are used with. i.e. they should be able to check, whether a DataSet can be used with these properties and assume, that any request for a Container will provide a dataset that matches.

Author:

Thomas Pfau

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static long	serialVersionUID

Constructor Summary

Constructors

Constructor	Description
DataSetLayoutProperties()

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)	Two Datasetproperties are equal, if they have the same Type name.
abstract JPanel	getDataSetDescriptionPane(JScrollPane Legend, String DataSetLabel, ColorMap map, DataSet set)	Plot the Legend for this Dataset.
abstract boolean	getItemFlexibility()	Get information whether this dataset can be layouted flexibly or whether it has to obay the precisoe dimensions provided.
abstract Localisation.Position	getLocalisationPreference()	Get the preferred Localisation Localisation.Position.CENTER, Localisation.Position.EDGE, Localisation.Position.FREE of this dataset.
abstract String	getTypeName()	Get the type of DataSet (this can be used for display purposes
abstract Collection<Class<? extends DataSet>>	getWorkingClassTypes()	Get the DataSet class Types these Properties are supposed to work with.
abstract DataContainer	newContainerInstance(DataSet origin, NodeData data)	Create a new Container for a specific DataSet and a given NodeData.
abstract void	testValidity(DataSet set)	Test, whether the provided DataSet is valid to be used with these properties.
String	toString()	Override the ToString Method

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

DataSetLayoutProperties

public DataSetLayoutProperties()

Method Detail

getLocalisationPreference

public abstract Localisation.Position getLocalisationPreference()

Get the preferred Localisation Localisation.Position.CENTER, Localisation.Position.EDGE, Localisation.Position.FREE of this dataset.

Returns:

the preferred Localisation

getItemFlexibility

public abstract boolean getItemFlexibility()

Get information whether this dataset can be layouted flexibly or whether it has to obay the precisoe dimensions provided.

Returns:

whether this container has a flexible layout.

newContainerInstance

public abstract DataContainer newContainerInstance(DataSet origin,
                                                   NodeData data)
                                            throws WrongDatasetTypeException

Create a new Container for a specific DataSet and a given NodeData.

Parameters:

origin - the DataSet a new Container instance is created for. This DataSet has to pass the testValididty Method, or the behaviour is undefined.

data - a node data

Returns:

A new container for the given DataSet and NodeData

Throws:

WrongDatasetTypeException - if a DataSet of an incompatible type is supplied.

getTypeName

public abstract String getTypeName()

Get the type of DataSet (this can be used for display purposes

Returns:

the type name of these properties

testValidity

public abstract void testValidity(DataSet set)
                           throws WrongFormat

Test, whether the provided DataSet is valid to be used with these properties.

Parameters:

set - the DataSet to test

Throws:

WrongFormat - if the supplied set cannot be used.

getDataSetDescriptionPane

public abstract JPanel getDataSetDescriptionPane(JScrollPane Legend,
                                                 String DataSetLabel,
                                                 ColorMap map,
                                                 DataSet set)

Plot the Legend for this Dataset.

Parameters:

Legend - The Legend the returned Panel will be added to (to listen to resize events.

DataSetLabel - the Label of the DataSet these properties are used for

map - the colormap used for the corresponding dataset

set - the dataset for which to generate a DescriptionPane

Returns:

a JPanel that contains descriptive information about the provided dataset and its visualisation.

getWorkingClassTypes

public abstract Collection<Class<? extends DataSet>> getWorkingClassTypes()

Get the DataSet class Types these Properties are supposed to work with.

Returns:

All Classes these properties can be used for.

equals

public boolean equals(Object o)

Two Datasetproperties are equal, if they have the same Type name.

Overrides:

equals in class Object

toString

public String toString()

Override the ToString Method

Overrides:

toString in class Object