com.altair.hwm.datamodel
Interface HWMDataModel

All Known Subinterfaces:

IHWMDataModel

All Known Implementing Classes:

HWMDataModelImpl

public interface HWMDataModel

Title: HWMDataModel

Description: This is the data model class which is created for each instance of the framework by the toolkit.

Company: Altair Engineering, Inc.

Method Summary

void	addPropertyChangeListener(java.beans.PropertyChangeListener propChangeListener) Add a listener
void	addPropertyChangeListener(java.lang.String strName, java.beans.PropertyChangeListener propChangeListener) Add a listener for a particular property
void	ClearAll() Clears all the properties
void	FireEvent(java.beans.PropertyChangeEvent propChangeEvent) Fire event to all the listeners
void	FireEvent(java.lang.String strPropName, java.lang.Object objOldVal, java.lang.Object objNewVal) Fire event to all the listeners
java.lang.Object	GetProperty(java.lang.String strName) Gets the property value
boolean	IsPropertyTransient(java.lang.String strPropName) Returns a flag indicating if the property is set as transient
void	ReadDataModel(org.jdom.Element elemDataModel) Reads the data model from a XML element
void	RemoveProperty(java.lang.String strName) Remove the property value
void	removePropertyChangeListener(java.beans.PropertyChangeListener propChangeListener) Removes a listener
void	removePropertyChangeListener(java.lang.String strName, java.beans.PropertyChangeListener propChangeListener) Remove a listener for a particular property
void	SetProperty(java.lang.String strName, java.lang.Object objNewValue) Sets the property value
void	SetPropertyAsTransient(java.lang.String strPropName, boolean bTransient) Sets the property to be transient or non-transient
void	WriteDataModel(org.jdom.Element elemDataModel) Writes the data model to a XML element

Method Detail

SetPropertyAsTransient

void SetPropertyAsTransient(java.lang.String strPropName,
                            boolean bTransient)

Sets the property to be transient or non-transient

Parameters:

strPropName - The name of the property

bTransient - If true, this property is set to transient i.e. not saved. Else, it is saved.

IsPropertyTransient

boolean IsPropertyTransient(java.lang.String strPropName)

Returns a flag indicating if the property is set as transient

Parameters:

strPropName - The name of the property

Returns:

boolean Returns true if this property is set as transient else returns false.

SetProperty

void SetProperty(java.lang.String strName,
                 java.lang.Object objNewValue)

Sets the property value

Parameters:

strName - The name of the property

objNewValue - The value for the given property

GetProperty

java.lang.Object GetProperty(java.lang.String strName)

Gets the property value

Parameters:

strName - The name of the property

Returns:

Object The value for the given property. If such a property does not exist, then null

RemoveProperty

void RemoveProperty(java.lang.String strName)

Remove the property value

Parameters:

strName - The name of the property to remove

FireEvent

void FireEvent(java.beans.PropertyChangeEvent propChangeEvent)

Fire event to all the listeners

Parameters:

propChangeEvent - The property change event.

FireEvent

void FireEvent(java.lang.String strPropName,
               java.lang.Object objOldVal,
               java.lang.Object objNewVal)

Fire event to all the listeners

Parameters:

strPropName - The property name.

objOldVal - The old value for the property.

objNewVal - The new value for the property. NOTE: If the oldValue = newValue, then the event is not fired

addPropertyChangeListener

void addPropertyChangeListener(java.beans.PropertyChangeListener propChangeListener)

Add a listener

Parameters:

propChangeListener - The listener object which will be notified.

addPropertyChangeListener

void addPropertyChangeListener(java.lang.String strName,
                               java.beans.PropertyChangeListener propChangeListener)

Add a listener for a particular property

Parameters:

strName - Name of the property to listen to.

propChangeListener - The listener object which will be notified.

removePropertyChangeListener

void removePropertyChangeListener(java.beans.PropertyChangeListener propChangeListener)

Removes a listener

Parameters:

propChangeListener - The listener object which will be removed.

removePropertyChangeListener

void removePropertyChangeListener(java.lang.String strName,
                                  java.beans.PropertyChangeListener propChangeListener)

Remove a listener for a particular property

Parameters:

strName - Name of the property.

propChangeListener - The listener object which should be removed.

ClearAll

void ClearAll()

Clears all the properties

ReadDataModel

void ReadDataModel(org.jdom.Element elemDataModel)
                   throws java.io.IOException,
                          java.lang.ClassNotFoundException

Reads the data model from a XML element

Parameters:

elemDataModel - The element representing the datamodel

Throws:

IOException, - ClassNotFoundException

java.io.IOException

java.lang.ClassNotFoundException

WriteDataModel

void WriteDataModel(org.jdom.Element elemDataModel)
                    throws java.io.IOException,
                           java.lang.ClassNotFoundException

Writes the data model to a XML element

Parameters:

elemDataModel - The element representing the datamodel

Throws:

IOException, - ClassNotFoundException

java.io.IOException

java.lang.ClassNotFoundException