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

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

All Implemented Interfaces:

java.io.Serializable

public class PortPropertiesEvent
extends java.util.EventObject

Used to notify components that an entity wants to either retrieve the value of a port property or wants to set the value of a port property. A view entity might respond by either displaying the current value of one or more port properties or by setting the value of one port 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	dataTypeOfPropertyValue If we are setting the value of a property then we need the datatype of the value.
protected int	numberOfArguments
protected java.lang.String	portName
protected java.lang.String	propertyName
protected java.lang.String	propertyValue

Fields inherited from class java.util.EventObject

source

Constructor Summary

PortPropertiesEvent(java.lang.Object source, int numberOfArguments, java.lang.String componentInstanceName)
Used to notify components that an entity wants to either retrieve the values of all the properties that are contained inside of a port.

PortPropertiesEvent(java.lang.Object source, int numberOfArguments, java.lang.String componentInstanceName, java.lang.String portName, java.lang.String propertyName)
Used to notify components that an entity wants to either retrieve the value of a port property or wants to set the value of a port property.

PortPropertiesEvent(java.lang.Object source, int numberOfArguments, java.lang.String componentInstanceName, java.lang.String portName, java.lang.String propertyName, java.lang.String dataTypeOfPropertyValue, java.lang.String propertyValue)
Used to notify components that an entity wants to either retrieve the value of a port property or wants to set the value of a port property.

PortPropertiesEvent(java.lang.Object source, java.lang.String componentInstanceName)
Used to notify components that an entity wants to either retrieve the values of all the properties that are contained inside of a port.

PortPropertiesEvent(java.lang.Object source, java.lang.String componentInstanceName, java.lang.String portName, java.lang.String propertyName)
Used to notify components that an entity wants to either retrieve the value of a port property or wants to set the value of a port property.

Method Summary

java.lang.String	getComponentInstanceName() Get the name of the cca component that contains the property.
java.lang.String	getDataTypeOfPropertyValue() If we are setting the value of a property then we need the datatype of the value.
int	getNumberOfArguments() Get the number of arguments in the "port-properties" command.
java.lang.String	getPortName() Get the name of the port that contains the property.
java.lang.String	getPropertyName() If we are getting or setting the value of a specific property then we need the name of the property.
java.lang.String	getPropertyValue() If we are setting the value of a property then we need the new value.

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

numberOfArguments

protected int numberOfArguments

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"

portName

protected java.lang.String portName

propertyName

protected java.lang.String propertyName

dataTypeOfPropertyValue

protected java.lang.String dataTypeOfPropertyValue

If we are setting the value of a property then we need the datatype of the value.

propertyValue

protected java.lang.String propertyValue

Constructor Detail

PortPropertiesEvent

public PortPropertiesEvent(java.lang.Object source,
                           java.lang.String componentInstanceName)

Used to notify components that an entity wants to either retrieve the values of all the properties that are contained inside of a port. A view entity might respond by displaying the current values of the port properties.

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"

PortPropertiesEvent

public PortPropertiesEvent(java.lang.Object source,
                           int numberOfArguments,
                           java.lang.String componentInstanceName)

Used to notify components that an entity wants to either retrieve the values of all the properties that are contained inside of a port. A view entity might respond by displaying the current values of the port properties.

Parameters:

source - The entity that created this event.

numberOfArguments - The number of arguments in the "port-properties" command.

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"

PortPropertiesEvent

public PortPropertiesEvent(java.lang.Object source,
                           java.lang.String componentInstanceName,
                           java.lang.String portName,
                           java.lang.String propertyName)

Used to notify components that an entity wants to either retrieve the value of a port property or wants to set the value of a port property. A view entity might respond by either displaying the current value of a port property or by setting the value of a port 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"

portName - The name of the port that contains the component.

propertyName - If we want to get or set the value of a specific port property, then we need the name of the property.

PortPropertiesEvent

public PortPropertiesEvent(java.lang.Object source,
                           int numberOfArguments,
                           java.lang.String componentInstanceName,
                           java.lang.String portName,
                           java.lang.String propertyName)

Used to notify components that an entity wants to either retrieve the value of a port property or wants to set the value of a port property. A view entity might respond by either displaying the current value of a port property or by setting the value of a port property.

Parameters:

source - The entity that created this event.

numberOfArguments - The number of arguments in the "port-properties" command.

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"

portName - The name of the port that contains the property

propertyName - If we want to get or set the value of a specific port property, then we need the name of the property.

PortPropertiesEvent

public PortPropertiesEvent(java.lang.Object source,
                           int numberOfArguments,
                           java.lang.String componentInstanceName,
                           java.lang.String portName,
                           java.lang.String propertyName,
                           java.lang.String dataTypeOfPropertyValue,
                           java.lang.String propertyValue)

Used to notify components that an entity wants to either retrieve the value of a port property or wants to set the value of a port property. A view entity might respond by either displaying the current value of a port property or by setting the value of a port property.

Parameters:

source - The entity that created this event.

numberOfArguments - The number of arguments in the "port-properties" command.

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"

portName - The name of the port that contains the property.

propertyName - If we want to get or set the value of a specific port property, then we need the name of the property.

dataTypeOfPropertyValue - If we are setting the value of a specific port property, then we need the datatype of the property value.

propertyValue - If we are setting the value of a specific port property, then we need the value of the property.

Method Detail

getNumberOfArguments

public int getNumberOfArguments()

Get the number of arguments in the "port-properties" command.

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.

getPortName

public java.lang.String getPortName()

Get the name of the port that contains the property.

Returns:

getPropertyName

public java.lang.String getPropertyName()

If we are getting or setting the value of a specific property then we need the name of the property.

Returns:

The name of the property.

getDataTypeOfPropertyValue

public java.lang.String getDataTypeOfPropertyValue()

If we are setting the value of a property then we need the datatype of the value.

getPropertyValue

public java.lang.String getPropertyValue()

If we are setting the value of a property then we need the new value.

Returns:

The value of the property.