idare.imagenode.internal.Layout.Automatic

Class AutomaticNodeLayout

java.lang.Object

idare.imagenode.internal.Layout.Automatic.AutomaticNodeLayout

All Implemented Interfaces:

DataSetAboutToBeChangedListener, IDAREService, ImageNodeLayout

public class AutomaticNodeLayout
extends Object
implements ImageNodeLayout, IDAREService

Te NodeLAyout stores the localisation of different Containerlayouts and sets them up using the Datasets in this layout.

Author:

Thomas Pfau

Constructor Summary

Constructors

Constructor and Description
AutomaticNodeLayout()
AutomaticNodeLayout(Collection<DataSetLayoutInfoBundle> DataSetsToUse) Generate an automatic layout for a set of DataSetLayouts

Method Summary

Modifier and Type	Method and Description
void	datasetChanged(DataSetChangedEvent e) Inform that there will be a change in the DataSets
void	datasetsChanged(DataSetsChangedEvent e) Inform that a Collection of changes coming up in the DataSets.
void	doLayout() Produce the layout based on the added DataSets.
void	generateLayoutForDataSets(Collection<DataSetLayoutInfoBundle> Datasets) Generate a Layout for a given set of DataSets.
ColorMap	getColorsForDataSet(DataSetLink dsl) Get the ColorMap associated with this DataSet in this AutomaticNodeLayout.
String	getDataSetLabel(DataSetLink dsl) Get the label for a specific DataSet used in this layout;
Vector<? extends DataSetLink>	getDatasetsInOrder() Get the DataSets used in this Layout in the order of labeling
ContainerLayout	getLayoutContainerUsedFor(DataSet set) Get the Container used for the provided dataset
boolean	isValid() Check whether this AutomaticNodeLayout is valid.
void	layoutLegendNode(Collection<NodeData> datacollection, org.apache.batik.svggen.SVGGraphics2D svg) Lay out the legend for a specific set of node data
void	layoutNode(Collection<NodeData> datacollection, org.apache.batik.svggen.SVGGraphics2D svg) Layout a specific node in a given context.
boolean	readLayout(DataSetManager dsm, ObjectInputStream os, Object currentobject) Read a layout object from an ObjectInputStream given the last object read (which is the first object of the layout)
void	writeLayout(ObjectOutputStream os) Write all data that is relevant to restore this nodelayout to a ObjectOutputStream

Methods inherited from class java.lang.Object

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

Constructor Detail

AutomaticNodeLayout

public AutomaticNodeLayout()

AutomaticNodeLayout

public AutomaticNodeLayout(Collection<DataSetLayoutInfoBundle> DataSetsToUse)

Generate an automatic layout for a set of DataSetLayouts

Parameters:

DataSetsToUse - the Datasets and layouts to use.

Method Detail

isValid

public boolean isValid()

Description copied from interface: ImageNodeLayout

Check whether this AutomaticNodeLayout is valid. A Layout is valid, if its ImageNodeContainer contains at least one DataSet. Thus, by default a newly generated layout is invalid until a DataSet is added.

Specified by:

isValid in interface ImageNodeLayout

Returns:

whether this layout is still valid (i.e. has contaniers to lay out)

writeLayout

public void writeLayout(ObjectOutputStream os)
                 throws IOException

Description copied from interface: ImageNodeLayout

Write all data that is relevant to restore this nodelayout to a ObjectOutputStream

Specified by:

writeLayout in interface ImageNodeLayout

Parameters:

os - The ObjectOutputStream to write the dlayout infromation to

Throws:

IOException - If errors occur with the given stream

readLayout

public boolean readLayout(DataSetManager dsm,
                          ObjectInputStream os,
                          Object currentobject)
                   throws IOException

Description copied from interface: ImageNodeLayout

Read a layout object from an ObjectInputStream given the last object read (which is the first object of the layout)

Specified by:

readLayout in interface ImageNodeLayout

Parameters:

dsm - the DataSetManager to get information about DataSets from.

os - The ObjectInputStream to read from

currentobject - The last object read in the ObjectInputStream provided (the first object of the nodelayout save

Returns:

true, if reading was successful, false if there was a non IOException.

Throws:

IOException - If errors occur with the given stream

getLayoutContainerUsedFor

public ContainerLayout getLayoutContainerUsedFor(DataSet set)

Get the Container used for the provided dataset

Parameters:

set - The DataSet for which the ContainerLayout is requested.

Returns:

the associated ContainerLayout or null if there is no associated ContainerLayout

generateLayoutForDataSets

public void generateLayoutForDataSets(Collection<DataSetLayoutInfoBundle> Datasets)
                               throws TooManyItemsException,
                                      ContainerUnplaceableExcpetion,
                                      DimensionMismatchException,
                                      WrongDatasetTypeException

Generate a Layout for a given set of DataSets.

Parameters:

Datasets - the DataSets to generate a layout for.

Throws:

TooManyItemsException - If there are too many items

ContainerUnplaceableExcpetion - if a container is unplaceable

DimensionMismatchException - if the given dimensions cant fit

WrongDatasetTypeException - if an Invalid DatasetLayoutinfo bundle is added

doLayout

public void doLayout()
              throws TooManyItemsException,
                     ContainerUnplaceableExcpetion,
                     DimensionMismatchException,
                     WrongDatasetTypeException

Description copied from interface: ImageNodeLayout

Produce the layout based on the added DataSets.

Specified by:

doLayout in interface ImageNodeLayout

Throws:

TooManyItemsException - If there are too many Items to layout

ContainerUnplaceableExcpetion - If a container is not placeable

DimensionMismatchException - If the given dimensions don't fit.

WrongDatasetTypeException - IF the given Dataset does not it to the layout

getDataSetLabel

public String getDataSetLabel(DataSetLink dsl)

Description copied from interface: ImageNodeLayout

Get the label for a specific DataSet used in this layout;

Specified by:

getDataSetLabel in interface ImageNodeLayout

Parameters:

dsl - the DataSet to get the label for

Returns:

The String label for the supplied DataSet

getColorsForDataSet

public ColorMap getColorsForDataSet(DataSetLink dsl)

Description copied from interface: ImageNodeLayout

Get the ColorMap associated with this DataSet in this AutomaticNodeLayout.

Specified by:

getColorsForDataSet in interface ImageNodeLayout

Parameters:

dsl - - The requested Dataset

Returns:

the ColorMap associated with the DataSet in this AutomaticNodeLayout

getDatasetsInOrder

public Vector<? extends DataSetLink> getDatasetsInOrder()

Description copied from interface: ImageNodeLayout

Get the DataSets used in this Layout in the order of labeling

Specified by:

getDatasetsInOrder in interface ImageNodeLayout

Returns:

A Vector of DataSets in the order they were added during the layout process

layoutNode

public void layoutNode(Collection<NodeData> datacollection,
                       org.apache.batik.svggen.SVGGraphics2D svg)

Description copied from interface: ImageNodeLayout

Layout a specific node in a given context.

Specified by:

layoutNode in interface ImageNodeLayout

Parameters:

datacollection - The data to be used for drawing

svg - the SVGGraphics2D to draw in

layoutLegendNode

public void layoutLegendNode(Collection<NodeData> datacollection,
                             org.apache.batik.svggen.SVGGraphics2D svg)

Description copied from interface: ImageNodeLayout

Lay out the legend for a specific set of node data

Specified by:

layoutLegendNode in interface ImageNodeLayout

Parameters:

datacollection - The data to be used for drawing

svg - the SVGGraphics2D to draw in

datasetChanged

public void datasetChanged(DataSetChangedEvent e)

Description copied from interface: DataSetAboutToBeChangedListener

Inform that there will be a change in the DataSets

Specified by:

datasetChanged in interface DataSetAboutToBeChangedListener

Specified by:

datasetChanged in interface ImageNodeLayout

Parameters:

e - the DataSetChangedEvent to process

datasetsChanged

public void datasetsChanged(DataSetsChangedEvent e)

Description copied from interface: DataSetAboutToBeChangedListener

Inform that a Collection of changes coming up in the DataSets.

Specified by:

datasetsChanged in interface DataSetAboutToBeChangedListener

Specified by:

datasetsChanged in interface ImageNodeLayout

Parameters:

e - the DataSetChangedEvent to process