gov.sandia.ccaffeine.dc.user_iface.MVC
Class CcaPortParameterHelp

java.lang.Object
  extended by gov.sandia.ccaffeine.dc.user_iface.MVC.CcaPortParameterHelp

public class CcaPortParameterHelp
extends java.lang.Object

Cca components contain ports. Some of the ports contain data fields. When the end-user wants more information about a port, he/she can bring up some helpful info. This class holds the contents of this help message.


Field Summary
 java.lang.String componentInstanceName
           
 java.lang.String dataFieldHelp
           
 java.lang.String dataFieldName
           
 java.lang.String portInstanceName
           
 
Constructor Summary
CcaPortParameterHelp(java.lang.String xml)
          Parse the xml contents of the contents of the help message that is attached to a port parameter.
 
Method Summary
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

componentInstanceName

public java.lang.String componentInstanceName

portInstanceName

public java.lang.String portInstanceName

dataFieldName

public java.lang.String dataFieldName

dataFieldHelp

public java.lang.String dataFieldHelp
Constructor Detail

CcaPortParameterHelp

public CcaPortParameterHelp(java.lang.String xml)
Parse the xml contents of the contents of the help message that is attached to a port parameter. The parsed values are copied into the class's attributes.

The XML code will contains something like this:
<paramCurrent>
 <componentInstanceName>
   name1
   </componentInstanceName>
 <portInstanceName>name2</portInstanceName>
 <dataFieldName>name3</dataFieldName>
 <dataFieldHelp>help1</dataFieldHelp>
<paramCurrent>

Parameters:
xmlComponent - The xml code of one component.