at.mug.iqm.api.model

Class IqmDataBox

java.lang.Object

at.mug.iqm.api.model.IqmDataBox

All Implemented Interfaces:

IThumbnailSupport, Serializable, Cloneable

Direct Known Subclasses:

VirtualDataBox

public class IqmDataBox
extends Object
implements Serializable, IThumbnailSupport, Cloneable

This class is a container for IQM's main data types.

Changes

• 2012 04 08 PK: added TYPE_UNSUPPORTED = -1 for not supported data type
• 2012 10 16 MMR: added TYPE_PLOT + variables/functions

Since:

2012 02 18

Author:

Helmut Ahammer, Philipp Kainz, Michael Mayrhofer-R.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private CustomDataModel	customDataModel The variable for the custom content.
DataType	dataType The DataType of this object.
private Object	emptyContent The variable for the empty content, which is always null.
private UUID	id The unique ID of this object.
private ImageModel	imageModel The variable for the image.
private static org.apache.log4j.Logger	logger Class specific logger.
protected Thumbnail	managerThumbnail A cached fixed sized (40x40) manager thumb nail of the item's content.
private PlotModel	plotModel The variable for the plot model.
protected HashMap<String,Object>	properties A container for custom properties of the IqmDataBox.
private static long	serialVersionUID The UID for object serialization.
private TableModel	tableModel The variable for the table model.
protected Thumbnail	tankThumbnail A cached custom sized (40x40) tank thumb nail of the item's content.
protected Thumbnail	thumbnail A cached custom sized thumb nail of the item's content.

Constructor Summary

Constructors

Constructor and Description
IqmDataBox() This method creates an instance of IqmDataBox containing an empty object.
IqmDataBox(CustomDataModel customContent) This method creates an instance of IqmDataBox containing a specified custom content.
IqmDataBox(ImageModel im) This method creates an instance of IqmDataBox containing a specified ImageModel.
IqmDataBox(JTable tableModel) Deprecated. The use of this method is discouraged, better use setTableModel(TableModel)
IqmDataBox(javax.media.jai.PlanarImage pi) This method creates an instance of IqmDataBox containing a specified PlanarImage.
IqmDataBox(PlotModel plotModel) This method creates an instance of IqmDataBox containing a specified PlotModel.
IqmDataBox(TableModel tableModel) This method creates an instance of IqmDataBox containing a specified table model.

Method Summary

Modifier and Type	Method and Description
IqmDataBox	clone()
Thumbnail	createManagerThumbnail() Creates the Thumbnail for the IManager.
Thumbnail	createTankThumbnail() Creates the Thumbnail for the ITank.
Image	createThumbnail(int width, int height, boolean keepAspectRatio) Creates a Thumbnail.
void	createThumbnails() Creates all three thumb nails for the containing data model.
CustomDataModel	getCustomContent() Get the custom content.
IDataModel	getDataModel() Gets the data model according to the current content.
DataType	getDataType()
String	getDataTypeAsString() Get the data type of the object as string.
UUID	getID() Returns the unique identifier of this IqmDataBox object.
javax.media.jai.PlanarImage	getImage() Get the PlanarImage from the image model.
ImageModel	getImageModel()
Thumbnail	getManagerThumbnail() Get the Thumbnail for the IManager.
PlotModel	getPlotModel()
HashMap<String,Object>	getProperties() Get all custom properties for this IqmDataBox.
Object	getProperty(String key) Gets the value for the requested property.
TableModel	getTableModel()
Thumbnail	getTankThumbnail() Get the Thumbnail for the ITank.
Thumbnail	getThumbnail() Gets the thumbnail.
void	setCustomContent(CustomDataModel customContent) The data type is automatically set to DataType.CUSTOM.
void	setDataType(DataType dataType)
void	setEmptyContent(Object emptyContent) This method is just used for the annotation of the empty content.
void	setImage(javax.media.jai.PlanarImage planarImage) The data type is automatically set to DataType.IMAGE.
void	setImageModel(ImageModel imageModel) The data type is automatically set to DataType.IMAGE.
void	setManagerThumbnail(Thumbnail managerThumbnail) Set the Thumbnail for the IManager.
void	setPlotModel(PlotModel plotModel) The data type is automatically set to DataType.PLOT.
void	setProperties(HashMap<String,Object> properties) Set the property object for this IqmDataBox.
void	setProperty(String key, Object value) Sets a key-value pair to the properties of this object.
void	setTableModel(JTable table) Deprecated. Use setTableModel(TableModel) instead.
void	setTableModel(TableModel tableModel) The data type is automatically set to DataType.TABLE.
void	setTankThumbnail(Thumbnail tankThumbnail) Set the Thumbnail for the ITank.
void	setThumbnail(Thumbnail thumbnail) Set the thumbnail.
static javax.media.jai.PlanarImage	toPlanarImage(IqmDataBox iqmDataBox) This method creates a PlanarImage from the content of an IqmDataBox.

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

The UID for object serialization.

See Also:

Constant Field Values

logger

private static final transient org.apache.log4j.Logger logger

Class specific logger.

id

private UUID id

The unique ID of this object.

properties

protected HashMap<String,Object> properties

A container for custom properties of the IqmDataBox.

thumbnail

protected transient Thumbnail thumbnail

A cached custom sized thumb nail of the item's content.

managerThumbnail

protected transient Thumbnail managerThumbnail

A cached fixed sized (40x40) manager thumb nail of the item's content.

tankThumbnail

protected transient Thumbnail tankThumbnail

A cached custom sized (40x40) tank thumb nail of the item's content.

dataType

public DataType dataType

The DataType of this object.

imageModel

private ImageModel imageModel

The variable for the image.

plotModel

private PlotModel plotModel

The variable for the plot model.

tableModel

private TableModel tableModel

The variable for the table model.

customDataModel

private CustomDataModel customDataModel

The variable for the custom content.

emptyContent

private Object emptyContent

The variable for the empty content, which is always null.

Constructor Detail

IqmDataBox

public IqmDataBox(ImageModel im)

This method creates an instance of IqmDataBox containing a specified ImageModel. The data type is automatically set to DataType.IMAGE.

Parameters:

im -

IqmDataBox

public IqmDataBox(javax.media.jai.PlanarImage pi)

This method creates an instance of IqmDataBox containing a specified PlanarImage. The data type is automatically set to DataType.IMAGE.

Parameters:

pi -

IqmDataBox

@Deprecated
public IqmDataBox(JTable tableModel)

Deprecated. The use of this method is discouraged, better use setTableModel(TableModel)

This method creates an instance of IqmDataBox containing a specified table model. The data type is automatically set to DataType.TABLE.

Parameters:

tableModel - a JTable

IqmDataBox

public IqmDataBox(TableModel tableModel)

This method creates an instance of IqmDataBox containing a specified table model. The data type is automatically set to DataType.TABLE.

Parameters:

tableModel -

IqmDataBox

public IqmDataBox(PlotModel plotModel)

This method creates an instance of IqmDataBox containing a specified PlotModel. The data type is automatically set to DataType.PLOT.

Parameters:

plotModel -

IqmDataBox

public IqmDataBox(CustomDataModel customContent)

This method creates an instance of IqmDataBox containing a specified custom content. The data type is automatically set to DataType.CUSTOM.

Parameters:

customContent -

IqmDataBox

public IqmDataBox()

This method creates an instance of IqmDataBox containing an empty object. The data type is automatically set to DataType.EMPTY.

Method Detail

getImage

public javax.media.jai.PlanarImage getImage()

Get the PlanarImage from the image model.

Returns:

the image

setImage

public void setImage(javax.media.jai.PlanarImage planarImage)

The data type is automatically set to DataType.IMAGE.

Parameters:

planarImage - the planarImage to set

getImageModel

public ImageModel getImageModel()

Returns:

the planarImage

setImageModel

public void setImageModel(ImageModel imageModel)

The data type is automatically set to DataType.IMAGE.

Parameters:

imageModel - the planarImage to set

getTableModel

public TableModel getTableModel()

Returns:

the TableModel

setTableModel

public void setTableModel(JTable table)
                   throws ClassCastException

Deprecated. Use setTableModel(TableModel) instead.

The data type is automatically set to DataType.TABLE.

This method is just for downward compatibility and its use is discouraged, since data is stored in a TableModel.

Parameters:

table - the JTable to set

Throws:

ClassCastException

setTableModel

public void setTableModel(TableModel tableModel)

The data type is automatically set to DataType.TABLE.

Parameters:

tableModel - the TableModel to set

getPlotModel

public PlotModel getPlotModel()

Returns:

the plotData

setPlotModel

public void setPlotModel(PlotModel plotModel)

The data type is automatically set to DataType.PLOT.

Parameters:

plotModel - the PlotModel to set

getCustomContent

public CustomDataModel getCustomContent()

Get the custom content.

Returns:

the custom content

setCustomContent

public void setCustomContent(CustomDataModel customContent)

The data type is automatically set to DataType.CUSTOM.

Parameters:

customContent -

setEmptyContent

public void setEmptyContent(Object emptyContent)

This method is just used for the annotation of the empty content. There does not exist any The data type is automatically set to DataType.EMPTY.

Parameters:

emptyContent - will always be set to null

getDataType

public DataType getDataType()

Returns:

the dataType

setDataType

public void setDataType(DataType dataType)

Parameters:

dataType - the dataType to set

getProperty

public Object getProperty(String key)

Gets the value for the requested property.

Parameters:

key - the key for the value

Returns:

the value, or null if nothing is associated with the given key

setProperty

public void setProperty(String key,
                        Object value)

Sets a key-value pair to the properties of this object.

Parameters:

key -

value -

getProperties

public HashMap<String,Object> getProperties()

Get all custom properties for this IqmDataBox.

Returns:

all properties

setProperties

public void setProperties(HashMap<String,Object> properties)

Set the property object for this IqmDataBox.

Parameters:

properties -

createThumbnail

public Image createThumbnail(int width,
                             int height,
                             boolean keepAspectRatio)

Creates a Thumbnail.

Specified by:

createThumbnail in interface IThumbnailSupport

Parameters:

width -

height -

keepAspectRatio -

createManagerThumbnail

public Thumbnail createManagerThumbnail()

Creates the Thumbnail for the IManager.

Specified by:

createManagerThumbnail in interface IThumbnailSupport

Returns:

the thumbnail

createTankThumbnail

public Thumbnail createTankThumbnail()

Creates the Thumbnail for the ITank.

Specified by:

createTankThumbnail in interface IThumbnailSupport

Returns:

the thumbnail

getThumbnail

public Thumbnail getThumbnail()

Gets the thumbnail.

Specified by:

getThumbnail in interface IThumbnailSupport

Returns:

the custom thumbnail

setThumbnail

public void setThumbnail(Thumbnail thumbnail)

Set the thumbnail.

Specified by:

setThumbnail in interface IThumbnailSupport

Parameters:

thumbnail -

getManagerThumbnail

public Thumbnail getManagerThumbnail()

Get the Thumbnail for the IManager.

Specified by:

getManagerThumbnail in interface IThumbnailSupport

Returns:

the manager thumbnail

setManagerThumbnail

public void setManagerThumbnail(Thumbnail managerThumbnail)

Set the Thumbnail for the IManager.

Specified by:

setManagerThumbnail in interface IThumbnailSupport

Parameters:

managerThumbnail -

getTankThumbnail

public Thumbnail getTankThumbnail()

Get the Thumbnail for the ITank.

Specified by:

getTankThumbnail in interface IThumbnailSupport

Returns:

the thumbnail for the tank

setTankThumbnail

public void setTankThumbnail(Thumbnail tankThumbnail)

Set the Thumbnail for the ITank.

Specified by:

setTankThumbnail in interface IThumbnailSupport

Parameters:

tankThumbnail -

createThumbnails

public void createThumbnails()

Creates all three thumb nails for the containing data model.

getDataTypeAsString

public String getDataTypeAsString()

Get the data type of the object as string.

Returns:

a string representation of the DataType

getID

public UUID getID()

Returns the unique identifier of this IqmDataBox object.

Returns:

the id of the object

toPlanarImage

public static javax.media.jai.PlanarImage toPlanarImage(IqmDataBox iqmDataBox)

This method creates a PlanarImage from the content of an IqmDataBox.

This is a convenient method for creating images from the content before e.g. scaling the image down for a thumb nail or any other further processing.

Parameters:

iqmDataBox - the box, of whose content the image should be created

Returns:

a PlanarImage or null

Throws:

IllegalArgumentException - if the parameter is null

clone

public IqmDataBox clone()
                 throws CloneNotSupportedException

Overrides:

clone in class Object

Throws:

CloneNotSupportedException

getDataModel

public IDataModel getDataModel()

Gets the data model according to the current content.

Returns:

• an ImageModel, if DataType.IMAGE
• a PlotModel, if DataType.PLOT
• a TableModel, if DataType.TABLE
• a CustomDataModel, if DataType.CUSTOM