com.ibm.dse.tools.workbench.gui
Class XMLExternalizer

java.lang.Object
  |
  +--com.ibm.dse.tools.workbench.gui.XMLExternalizer

public class XMLExternalizer
extends java.lang.Object
implements Externalizer, TableNames

This class implements the XML Externalizer.
WARNING: The client, server and client&server DW sites are written in hardcode. To change their values you must check the DW allowed_values table for the site domain


Fields inherited from interface com.ibm.dse.tools.workbench.base.TableNames
ALLOWED_VALUES, ATTRIBUTES, DOMAINS, ENTITIES, ENTITIES_ENTITIES, GROUPS, GROUPS_ENTITIES, GROUPS_GROUPS, GROUPS_INSTANCES, INSTANCE_ERRORS, INSTANCES, PROPERTIES, USERS
 
Constructor Summary
XMLExternalizer()
          This method creates an XMLExternalizer object.
 
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 generateDTD()
          This method generates the DTD of the current XML externalization.
 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 loadDefaultFiles()
          This method loads, if exist, the default filenames for each site/basegroupName and site/groupCode from the Workbench settings
 void saveDefaultFiles(java.util.Hashtable result)
          This method inserts the selected filenames into the Workbench settings to obtain data persistence
 void setProperties(java.util.Properties properties)
          This method sets the properties for the externalizer, instead of using invokeSetup method.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

XMLExternalizer

public XMLExternalizer()
This method creates an XMLExternalizer object.
Method Detail

externalize

public 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.
Specified by:
externalize in interface Externalizer
Parameters:
rows - com.ibm.dse.tools.workbench.base.TableRow[]

externalize

public java.lang.String externalize(TableRow row)
                             throws WorkbenchException
This method externalizes a given row of instances or groups to a String.
Specified by:
externalize in interface Externalizer
Parameters:
row - com.ibm.dse.tools.workbench.base.TableRow An instance or group
Returns:
java.lang.String
Throws:
WorkbenchException - An error occurs during the externalization

generateDTD

public java.lang.String generateDTD()
This method generates the DTD of the current XML externalization. (The implementation will be finished in next releases)
Returns:
java.lang.String

getFormat

public java.lang.String getFormat()
This method returns the output format acronym.
Specified by:
getFormat in interface Externalizer
Returns:
java.lang.String

getName

public java.lang.String getName()
This method returns the name of the externalizer.
Specified by:
getName in interface Externalizer
Returns:
java.lang.String

invokeSetup

public void invokeSetup()
This method shows, if available, the setup or options view to configure the externalizer.
Specified by:
invokeSetup in interface Externalizer

invokeWizard

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

loadDefaultFiles

public void loadDefaultFiles()
This method loads, if exist, the default filenames for each site/basegroupName and site/groupCode from the Workbench settings

saveDefaultFiles

public void saveDefaultFiles(java.util.Hashtable result)
                      throws WBInputOutputException
This method inserts the selected filenames into the Workbench settings to obtain data persistence
Parameters:
result - java.util.Hashtable The pairs (String key,File file)
Throws:
WBInputOutputException - An I/O error occurs

setProperties

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