org.eclipse.eavp.viz.datastructures.VizObject

Interface IVizObject

All Known Subinterfaces:

IResource, IVizResource

All Known Implementing Classes:

BasicVizEntryContentProvider, BoundaryCondition, ConnectionAdapter, ConnectionTable, DataComponent, KeyEntry, KeyEntryContentProvider, PortEntry, PortEntryContentProvider, SecretEntry, TestEntry, Transformation, VisualizationResource, VizEntry, VizObject, VizTableComponent

public interface IVizObject

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

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)

Method Detail

setId

void setId(int id)

(non-Javadoc)

See Also:

Identifiable#setId(int id)

getId

int getId()

(non-Javadoc)

See Also:

Identifiable#getId()

setName

void setName(java.lang.String name)

(non-Javadoc)

See Also:

Identifiable#setName(String name)

getName

java.lang.String getName()

(non-Javadoc)

See Also:

Identifiable#getName()

setDescription

void setDescription(java.lang.String description)

(non-Javadoc)

See Also:

Identifiable#setDescription(String description)

getDescription

java.lang.String getDescription()

(non-Javadoc)

See Also:

Identifiable#getDescription()

copy

void copy(VizObject entity)

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

Parameters:

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

clone

java.lang.Object clone()

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

Returns:

The new clone.

equals

boolean equals(java.lang.Object otherObject)

(non-Javadoc)

Overrides:

equals in class java.lang.Object

See Also:

Identifiable#equals(Object otherObject)

hashCode

int hashCode()

(non-Javadoc)

Overrides:

hashCode in class java.lang.Object

See Also:

Identifiable#hashCode()

update

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

(non-Javadoc)

See Also:

IUpdateable#update(String updatedKey, String newValue)

register

void register(IVizUpdateableListener listener)

(non-Javadoc)

See Also:

IUpdateable#register(IUpdateableListener listener)

unregister

void unregister(IVizUpdateableListener listener)

(non-Javadoc)

See Also:

IUpdateable#unregister(IUpdateableListener listener)