org.eclipse.eavp.viz.datastructures.VizObject

Class VizObject

java.lang.Object

org.eclipse.eavp.viz.datastructures.VizObject.VizObject

All Implemented Interfaces:

IVizObject, IVizUpdateable

Direct Known Subclasses:

BasicVizEntryContentProvider, BoundaryCondition, ConnectionAdapter, DataComponent, Transformation, VisualizationResource, VizEntry, VizTableComponent

public class VizObject
extends java.lang.Object
implements IVizObject, IVizUpdateable

VizObject is the base class for all common, shared data structures in Viz geometry and mesh bundles. ICEObjects are uniquely identifiable by their identification numbers and are persistent. VizObject implements clone() for creating deep copies and also provides a public copy operation to copy into an existing VizObject. VizObjects can be marshaled and unmarshaled to XML using the loadFromXML() and persistToXML().

Operations are defined for most of the attributes and capabilities of the VizObject class, but some work is required by subclasses. Subclasses must override clone() if they extend VizObject by adding attributes or the deep copy will fail. They should provide a custom implementation of copy() that is specific to their own type to do a deep copy (i.e. copy(a:myType) instead of copy(a:VizObject)) since VizObject.copy() will only copy the attributes of VizObjects. They must also override the loadFromXML() operation to copy the XML data properly from the XMLLoader (because Viz uses JAXB to bind XML to VizObjects and its subclasses).

VizObjects implement IVizUpdateable. The base class manages registering, unregistering and notifications. Subclasses are expected to override update().

Author:

Jay Jay Billings

Field Summary

Fields inherited from interface org.eclipse.eavp.viz.datastructures.VizObject.IVizUpdateable

iComponentListener

Constructor Summary

Constructors

Constructor and Description
VizObject() The Constructor

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone() This operation returns a clone of the ICEObject using a deep copy.
void	copy(VizObject entity) This operation copies the contents of an ICEObject into the current object using a deep copy.
boolean	equals(java.lang.Object otherObject) (non-Javadoc)
java.lang.String	getDescription() (non-Javadoc)
int	getId() (non-Javadoc)
java.lang.String	getName() (non-Javadoc)
int	hashCode() (non-Javadoc)
void	register(IVizUpdateableListener listener) (non-Javadoc)
void	setDescription(java.lang.String description) (non-Javadoc)
void	setId(int id) (non-Javadoc)
void	setName(java.lang.String name) (non-Javadoc)
void	unregister(IVizUpdateableListener listener) (non-Javadoc)
void	update(java.lang.String updatedKey, java.lang.String newValue) (non-Javadoc)

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

VizObject

public VizObject()

The Constructor

Method Detail

setId

public void setId(int id)

Description copied from interface: IVizObject

(non-Javadoc)

Specified by:

setId in interface IVizObject

See Also:

Identifiable#setId(int id)

getId

public int getId()

Description copied from interface: IVizObject

(non-Javadoc)

Specified by:

getId in interface IVizObject

See Also:

Identifiable#getId()

setName

public void setName(java.lang.String name)

Description copied from interface: IVizObject

(non-Javadoc)

Specified by:

setName in interface IVizObject

See Also:

Identifiable#setName(String name)

getName

public java.lang.String getName()

Description copied from interface: IVizObject

(non-Javadoc)

Specified by:

getName in interface IVizObject

See Also:

Identifiable#getName()

setDescription

public void setDescription(java.lang.String description)

Description copied from interface: IVizObject

(non-Javadoc)

Specified by:

setDescription in interface IVizObject

See Also:

Identifiable#setDescription(String description)

getDescription

public java.lang.String getDescription()

Description copied from interface: IVizObject

(non-Javadoc)

Specified by:

getDescription in interface IVizObject

See Also:

Identifiable#getDescription()

copy

public void copy(VizObject entity)

This operation copies the contents of an ICEObject into the current object using a deep copy.

Specified by:

copy in interface IVizObject

Parameters:

entity - The Identifiable entity from which the values should be copied.

clone

public java.lang.Object clone()

This operation returns a clone of the ICEObject using a deep copy.

Specified by:

clone in interface IVizObject

Overrides:

clone in class java.lang.Object

Returns:

The new clone.

equals

public boolean equals(java.lang.Object otherObject)

Description copied from interface: IVizObject

(non-Javadoc)

Specified by:

equals in interface IVizObject

Overrides:

equals in class java.lang.Object

See Also:

Identifiable#equals(Object otherObject)

hashCode

public int hashCode()

Description copied from interface: IVizObject

(non-Javadoc)

Specified by:

hashCode in interface IVizObject

Overrides:

hashCode in class java.lang.Object

See Also:

Identifiable#hashCode()

update

public void update(java.lang.String updatedKey,
                   java.lang.String newValue)

(non-Javadoc)

Specified by:

update in interface IVizObject

Specified by:

update in interface IVizUpdateable

Parameters:

updatedKey -

A unique key that describes the value that to be updated.

newValue -

The updated value of the key.

See Also:

IUpdateable#update(String updatedKey, String newValue)

register

public void register(IVizUpdateableListener listener)

(non-Javadoc)

Specified by:

register in interface IVizObject

Specified by:

register in interface IVizUpdateable

Parameters:

listener -

The new listener that should be notified when the the Component's state changes.

See Also:

IUpdateable#register(IUpdateableListener listener)

unregister

public void unregister(IVizUpdateableListener listener)

Description copied from interface: IVizObject

(non-Javadoc)

Specified by:

unregister in interface IVizObject

Specified by:

unregister in interface IVizUpdateable

Parameters:

listener -

The listener that should no longer receive updates.

See Also:

IUpdateable#unregister(IUpdateableListener listener)