gov.sandia.ccaffeine.dc.user_iface.MVC.event
Class SetPortPropertyEvent

java.lang.Object
  java.util.EventObject
      gov.sandia.ccaffeine.dc.user_iface.MVC.event.SetPortPropertyEvent

All Implemented Interfaces:

java.io.Serializable

public class SetPortPropertyEvent
extends java.util.EventObject

Used to notify components that the cca server has set the value of a property that is inside a port of a cca component. A view entity might respond by saving the new value of the property.

See Also:

Serialized Form

Field Summary

protected java.lang.String	componentInstanceName The name of the component that contains the property The name is usually the java class name of the component (without the package name) concatenated with an index number.
protected java.lang.String	dataType
protected java.lang.String	portInstanceName
protected java.lang.String	propertyName
protected java.lang.String	propertyValue

Fields inherited from class java.util.EventObject

source

Constructor Summary

SetPortPropertyEvent(java.lang.Object source, java.lang.String componentInstanceName, java.lang.String portInstanceName, java.lang.String propertyName, java.lang.String dataType, java.lang.String propertyValue)
Create a SetPropertyEvent.

Method Summary

java.lang.String	getComponentInstanceName() Get the name of the cca component that contains the property.
java.lang.String	getDataType() Get the data type of the property's value.
java.lang.String	getPortInstanceName() Get the name of the port that contains the property.
java.lang.String	getPropertyName() Get the name of the property.
java.lang.String	getPropertyValue() Get the value of the property.

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

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

Field Detail

componentInstanceName

protected java.lang.String componentInstanceName

The name of the component that contains the property The name is usually the java class name of the component (without the package name) concatenated with an index number. Example: "StartComponent0"

portInstanceName

protected java.lang.String portInstanceName

propertyName

protected java.lang.String propertyName

dataType

protected java.lang.String dataType

propertyValue

protected java.lang.String propertyValue

Constructor Detail

SetPortPropertyEvent

public SetPortPropertyEvent(java.lang.Object source,
                            java.lang.String componentInstanceName,
                            java.lang.String portInstanceName,
                            java.lang.String propertyName,
                            java.lang.String dataType,
                            java.lang.String propertyValue)

Create a SetPropertyEvent. The event can be used to notify components that the cca server has set the value of a property that is inside a port of a cca component. A view entity might respond by saving the new value of the property.

Parameters:

source - The entity that created this event.

componentInstanceName - The name of the component that contains the property The name is usually the java class name of the component (without the package name) concatenated with an index number. Example: "StartComponent0"

portInstanceName - the name of the port that contains the property.

propertyName - The name of the property.

dataType - The data type of the property's value.

propertyValue - The value of the property.

Method Detail

getComponentInstanceName

public java.lang.String getComponentInstanceName()

Get the name of the cca component that contains the property.

Returns:

the name of the compoonent that contains the property.

getPortInstanceName

public java.lang.String getPortInstanceName()

Get the name of the port that contains the property.

Returns:

String the name of the port that contains the property.

getPropertyName

public java.lang.String getPropertyName()

Get the name of the property.

Returns:

The name of the property.

getDataType

public java.lang.String getDataType()

Get the data type of the property's value.

Returns:

The data type of the property's value.

getPropertyValue

public java.lang.String getPropertyValue()

Get the value of the property.

Returns:

The value of the property.