com.ibm.dse.tools.workbench.base
Interface Externalizer

All Known Implementing Classes:
DTDGenerator, SGMLExternalizer, TBGEntitiesExternalizer, TemplateBasedExternalizer, XMLExternalizer

public interface Externalizer

This interface groups all the methods common to all the externalizers.


Method Summary
 java.lang.String externalize(TableRow row)
          This method externalizes a given row of instances or groups to a String.
 void externalize(TableRow[] rows)
          This method externalizes a given rows of instances or groups to one or several files, it depends of the number of different base_groups or groups.
 java.lang.String getFormat()
          This method returns the output format acronym.
 java.lang.String getName()
          This method returns the name of the externalizer.
 void invokeSetup()
          This method shows, if available, the setup or options view to configure the externalizer.
 void invokeWizard(Repository repository)
          This method invokes the externalizer wizard, if available, to guide the user in the externalization process.
 void setProperties(java.util.Properties properties)
          This method sets the properties for the externalizer, instead of using invokeSetup method.
 

Method Detail

externalize

public void externalize(TableRow[] rows)
                 throws WorkbenchException
This method externalizes a given rows of instances or groups to one or several files, it depends of the number of different base_groups or groups.
Parameters:
rows - com.ibm.dse.tools.workbench.base.TableRow[]
Throws:
WorkbenchException - There is an error externalizing the TableRow.

externalize

public java.lang.String externalize(TableRow row)
                             throws WorkbenchException
This method externalizes a given row of instances or groups to a String.
Parameters:
row - com.ibm.dse.tools.workbench.base.TableRow
Returns:
java.lang.String
Throws:
WorkbenchException - There is an error externalizing the TableRow.

getFormat

public java.lang.String getFormat()
This method returns the output format acronym.
Returns:
java.lang.String

getName

public java.lang.String getName()
This method returns the name of the externalizer.
Returns:
java.lang.String

invokeSetup

public void invokeSetup()
This method shows, if available, the setup or options view to configure the externalizer.

invokeWizard

public void invokeWizard(Repository repository)
This method invokes the externalizer wizard, if available, to guide the user in the externalization process.
Parameters:
repository - com.ibm.dse.tools.workbench.base.Repository

setProperties

public void setProperties(java.util.Properties properties)
This method sets the properties for the externalizer, instead of using invokeSetup method.
Parameters:
properties - java.util.Properties