com.ibm.di.config.base
Class FormConfigUtil

java.lang.Object
  com.ibm.di.config.base.FormConfigUtil

public class FormConfigUtil
extends java.lang.Object

Constructor Summary

FormConfigUtil(AssemblyLineConfig alc)
Use this constructor to generate an XSD based on the assemblyline' schema.

FormConfigUtil(FormConfig form, java.lang.String nlsCode, boolean expandValues)
Use this constructor when you already have a FormConfig object.

FormConfigUtil(java.lang.String nspath, BaseConfiguration config, java.lang.String nlsCode, boolean expandValues)
Use this constructor to obtain the form that would be used to display settings for the provided config.

Method Summary

static java.lang.String	getFormName(BaseConfiguration bc) Find the name of the Form that should be used for this BaseConfiguration.
static <T> T	getParentConfig(java.lang.Object config, java.lang.Class<T> cls)
static java.util.List<java.lang.String>	getSystemFolderNames(int type) Return all names in the specified system folder
java.lang.String	toXSD() Returns the XSD document as a string.
org.w3c.dom.Document	toXSDDoc() Returns an XSD document that defines the contents of the form.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FormConfigUtil

public FormConfigUtil(java.lang.String nspath,
                      BaseConfiguration config,
                      java.lang.String nlsCode,
                      boolean expandValues)
               throws java.lang.Exception

Use this constructor to obtain the form that would be used to display settings for the provided config.

Parameters:

nspath - The complete path to the component (e.g. system:/Connectors/ibmdi.LDAP)

config - The configuration object (from which the form is derived)

nlsCode - The NLS code for labels

expandValues - true if values for drop-down lists etc should be expanded

Throws:

java.lang.Exception

FormConfigUtil

public FormConfigUtil(AssemblyLineConfig alc)

Use this constructor to generate an XSD based on the assemblyline' schema.

Parameters:

alc -

FormConfigUtil

public FormConfigUtil(FormConfig form,
                      java.lang.String nlsCode,
                      boolean expandValues)
               throws java.lang.Exception

Use this constructor when you already have a FormConfig object.

Parameters:

form - The form config (must not be null)

nlsCode - The NLS code for labels

expandValues - true if values for drop-down lists etc should be expanded

Throws:

java.lang.Exception

Method Detail

toXSDDoc

public org.w3c.dom.Document toXSDDoc()
                              throws java.lang.Exception

Returns an XSD document that defines the contents of the form.

Returns:

Throws:

java.lang.Exception

toXSD

public java.lang.String toXSD()
                       throws java.lang.Exception

Returns the XSD document as a string.

Returns:

Throws:

java.lang.Exception

getSystemFolderNames

public static java.util.List<java.lang.String> getSystemFolderNames(int type)

Return all names in the specified system folder

Parameters:

type -

Returns:

all names in the specified system folder

getFormName

public static java.lang.String getFormName(BaseConfiguration bc)

Find the name of the Form that should be used for this BaseConfiguration.

Parameters:

bc - The BaseConfiguration

Returns:

The name of the Form, or null if nothing found.

Since:

7.1

getParentConfig

public static <T> T getParentConfig(java.lang.Object config,
                                    java.lang.Class<T> cls)