com.ibm.dse.tools.workbench.base
Class InstanceTagUtil

java.lang.Object
  |
  +--com.ibm.dse.tools.workbench.base.InstanceTagUtil

public class InstanceTagUtil
extends java.lang.Object
implements TagUtil

This class is a utility to convert from a Tag element to an instance


Constructor Summary
InstanceTagUtil()
          This constructor creates a InstanceTagUtil object
 
Method Summary
 Tag convertTableRowsToTag(TableRow[] aTableRowArray)
          This method converts a TableRow array to a Tag object.
 TableRow[] convertTagToTableRows(Tag aTag)
          This method converts a Tag Object to an instance table row.
 java.util.Vector getErrorMessages()
          Returns all the error messages that have been found during the conversion.
 void setGroupName(java.lang.String aName)
          This method creates a new Group which the InstanceTagUtil will include all the instances.
 void setRootEntityTagName(java.lang.String aName)
          To force the InstanceTagUtil to map the main tag (not the subTags) mith the specified entity
 void setTable(Table aTable)
          Sets the Instances Table
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

InstanceTagUtil

public InstanceTagUtil()
This constructor creates a InstanceTagUtil object
Method Detail

convertTableRowsToTag

public Tag convertTableRowsToTag(TableRow[] aTableRowArray)
This method converts a TableRow array to a Tag object. This method will be implemented in a future version.
Specified by:
convertTableRowsToTag in interface TagUtil
Parameters:
aTableRowArray - The table row array to be converted.

convertTagToTableRows

public TableRow[] convertTagToTableRows(Tag aTag)
                                 throws WorkbenchException
This method converts a Tag Object to an instance table row. The tag could contain Tag attributes objects and a list of Sub Tags objects. The method will create table rows in the instance table for the parent Tag and the subTags and table rows as needed for the attributes of the Tags in the properties table.
Specified by:
convertTagToTableRows in interface TagUtil
Parameters:
aTag - com.ibm.dse.tools.workbench.base.Tag
Returns:
com.ibm.dse.tools.workbench.base.TableRow[] The TableRow objects that have been created

getErrorMessages

public java.util.Vector getErrorMessages()
Returns all the error messages that have been found during the conversion.
Returns:
java.util.Vector The vector with all the error messages.

setGroupName

public void setGroupName(java.lang.String aName)
                  throws WorkbenchException
This method creates a new Group which the InstanceTagUtil will include all the instances.
Parameters:
aName - java.lang.String The name of the group.

setRootEntityTagName

public void setRootEntityTagName(java.lang.String aName)
To force the InstanceTagUtil to map the main tag (not the subTags) mith the specified entity
Parameters:
aName - java.lang.String The name of the entity to be mapped.

setTable

public void setTable(Table aTable)
              throws WorkbenchException
Sets the Instances Table
Specified by:
setTable in interface TagUtil
Parameters:
aTable - com.ibm.dse.tools.workbench.base.Table The table to be set.