askalon.graph.chartpack
Class MultipleSurfaceDataElement

java.lang.Object
  askalon.graph.chartpack.MultipleSurfaceDataElement

All Implemented Interfaces:

DataElement, java.io.Serializable

public class MultipleSurfaceDataElement

extends java.lang.Object

implements java.io.Serializable, DataElement

Copyright (c) 2002 Thomas Fahringer, Institute for Software Science, University of Vienna, Austria

We provide the ASKALON Visualization Diagramm Class Library (below described as ASKALON") on an AS IS basis, and do not warrant its validity or performance. We reserve the right to update, modify, or discontinue this software at any time. We shall have no obligation to supply such updates or modifications or any other form of support to you.

This license is for research uses. For such uses, there is no charge. We define "research use" to mean you may freely use it inside your organization for whatever purposes you see fit. But you may not re-distribute ASKALON or parts of ASKALON, in any form source or binary (including derivatives), electronic or otherwise, to any other organization or entity without our permission. (for other uses, please contact us at tf@par.univie.ac.at)

All warranties, including without limitation, any warranty of merchantability or fitness for a particular purpose, are hereby excluded.

By your use of ASKALON, you understand and agree that we (or any other person or entity with proprietary rights in ASKALON) are under no obligation to provide either maintenance services, update services, notices of latent defects, or correction of defects for ASKALON.

Even if advised of the possibility of such damages, under no circumstances shall we (or any other person or entity with proprietary rights in the software licensed hereunder) be liable to you or any third party for direct, indirect, or consequential damages of any character regardless of type of action, including, without limitation, loss of profits, loss of use, loss of good will, or computer failure or malfunction. You agree to indemnify us (and any other person or entity with proprietary rights in the software licensed hereunder) for any and all liability it may incur to third parties resulting from your use of ASKALON.

Structure for storing one MultipleSurfaceDataElement.

Version:

$Revision: 1.8 $ / $Date: 2004/03/25 01:58:31 $.

Author:

Sascha Nemecek/9825915.

See Also:

Serialized Form

Constructor Summary

MultipleSurfaceDataElement()
Initializes a MultipleSurfaceDataElement.

MultipleSurfaceDataElement(int indexX, int indexZ, Point3D p3D)
Initializes a MultipleSurfaceDataElement.

Method Summary

java.awt.Color	getColor() Retrieves the elements color.
java.lang.String	getID() Retrieves the element's ID (IDX + IDZ).
int	getIDX() Retrieves the element's x index.
int	getIDZ() Retrieves the element's x index.
Point3D	getPoint3D() Returns the data element's point3D.
long	getTimestamp() Returns the element's timestamp.
double	getValue() Returns the element's value.
boolean	hasColor() Checks if the color property is set.
boolean	hasID() Checks if the ID not null and it's size is greater than 0.
boolean	isValid() Checks if all necessary values are set.
void	setColor(java.awt.Color c) Sets the elements color property.
void	setID(java.lang.String id) Sets the elements ID.
void	setIDX(java.lang.String idx) Sets the elements x-index.
void	setIDZ(java.lang.String idz) Sets the elements z-index.
void	setPoint3D(Point3D p3D) Sets the Point3D reference.
void	setTimestamp(long ts) Sets the elements timestamp.
void	setTimestamp(java.lang.String ts) Sets the elements timestamp.
void	setValueY(double value) Sets the elements y-value.
void	setValueY(java.lang.String value) Sets the elements y-value.
java.lang.String	toString() Returns a String representation of the element.
java.lang.String	toXML() Returns a XML representation of this DataElement.
void	updateElement(DataElement de) Update an element with the information from another element.

Methods inherited from class java.lang.Object

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

Constructor Detail

MultipleSurfaceDataElement

public MultipleSurfaceDataElement()

Initializes a MultipleSurfaceDataElement.

MultipleSurfaceDataElement

public MultipleSurfaceDataElement(int indexX,
                                  int indexZ,
                                  Point3D p3D)

Initializes a MultipleSurfaceDataElement.

Method Detail

getColor

public java.awt.Color getColor()

Retrieves the elements color.

Returns:

The color as a color object.

getID

public java.lang.String getID()

Retrieves the element's ID (IDX + IDZ).

Specified by:

getID in interface DataElement

Returns:

The element's ID.

Throws:

An - Exception if there is no ID.

getIDX

public int getIDX()

Retrieves the element's x index.

Returns:

The element's x index.

Throws:

An - Exception if there is no x index set.

getIDZ

public int getIDZ()

Retrieves the element's x index.

Returns:

The element's x index.

Throws:

An - Exception if there is no x index set.

getPoint3D

public Point3D getPoint3D()

Returns the data element's point3D.

Returns:

The data element's point3D.

getTimestamp

public long getTimestamp()

Returns the element's timestamp.

Returns:

The element's timestamp.

getValue

public double getValue()

Returns the element's value.

Returns:

The element's value.

hasColor

public boolean hasColor()

Checks if the color property is set.

Returns:

True, if the element has the color property set.

hasID

public boolean hasID()

Checks if the ID not null and it's size is greater than 0.

Specified by:

hasID in interface DataElement

Returns:

True if the ID is valid.

isValid

public boolean isValid()

Checks if all necessary values are set. E.g.: - ID - IDX - IDZ

Specified by:

isValid in interface DataElement

Returns:

True if the element is ok.

setColor

public void setColor(java.awt.Color c)

Sets the elements color property.

Parameters:

c - The color to set.

setID

public void setID(java.lang.String id)

Sets the elements ID.

Specified by:

setID in interface DataElement

Parameters:

id - The elements ID (:).

Throws:

An - Exception if the given index is null.

setIDX

public void setIDX(java.lang.String idx)

Sets the elements x-index.

Parameters:

idx - The elements x-index.

Throws:

An - Exception if the given index is null.

setIDZ

public void setIDZ(java.lang.String idz)

Sets the elements z-index.

Parameters:

idz - The elements z-index.

Throws:

An - Exception if the given index is null.

setPoint3D

public void setPoint3D(Point3D p3D)

Sets the Point3D reference.

Parameters:

p3D - The Point3D.

setTimestamp

public void setTimestamp(long ts)

Sets the elements timestamp.

Parameters:

ts - The timestamp (in ms) representet as Long.

setTimestamp

public void setTimestamp(java.lang.String ts)
                  throws java.lang.Exception

Sets the elements timestamp.

Parameters:

ts - The timestamp (in ms) representet as String.

Throws:

An - Exception if the given String is null.

java.lang.Exception

setValueY

public void setValueY(java.lang.String value)

Sets the elements y-value.

Parameters:

value - The elements y-value.

setValueY

public void setValueY(double value)

Sets the elements y-value.

Parameters:

value - The elements y-value.

toString

public java.lang.String toString()

Returns a String representation of the element.

Returns:

A String representation of the element.

toXML

public java.lang.String toXML()

Returns a XML representation of this DataElement.

Specified by:

toXML in interface DataElement

Returns:

XML representation of this DataElement.

updateElement

public void updateElement(DataElement de)

Update an element with the information from another element.

Specified by:

updateElement in interface DataElement

Parameters:

de - The element to synchronise with.