wt.ixb.publicforapps
Class IxbHelper

java.lang.Object
  wt.ixb.publicforapps.IxbHelper

public class IxbHelper

extends Object

This class contents several static methods that can be used in export/import application.

Supported API: true

Extendable: false

Field Summary

private static String	CLASSNAME
static String	DEFAULT_DTD_EXPORT_TAG Supported API: false
private static String	RESOURCE
static String	STANDARD_DTD Supported API: false
static String	STANDARD_DTD_60 Supported API: false
static String	STANDARD_DTD_62 Supported API: false
static String	STANDARD_DTD_70 Supported API: false
static String	STANDARD_DTD_X05 Supported API: false
private static String	VERSION_60
private static String	VERSION_62
private static String	VERSION_70

Constructor Summary

IxbHelper()

Method Summary

static String	calculateStringDTD()
private static WTContainerRef	getClassicContainer() returns the ClassicContainer for this system
static Exporter	newExporter(ApplicationExportHandler applicationExportHandler, String targetDtd, IxbElement localMappingRules) Deprecated.
static Exporter	newExporter(ApplicationExportHandler applicationExportHandler, String targetDtd, IxbElement localMappingRules, File policyRuleFile, String actionName) Deprecated.
static Exporter	newExporter(ApplicationExportHandler appExpHandler, WTContainerRef container, String targetDtd, File localMappingRuleFile, File policyRuleFile, String actionName) Creates the instance of the Exporter class.
static Exporter	newExporter(ApplicationExportHandler appExpHandler, WTContainerRef container, String targetDtd, IxbElement localMappingRules) Creates the instance of the Exporter class.
static Exporter	newExporter(ApplicationExportHandler appExpHandler, WTContainerRef container, String targetDtd, IxbElement localMappingRules, File policyRuleFile, String actionName) Creates the instance of the Exporter class.
static Importer	newImporter(ApplicationImportHandler applicationImportHandler, String dtd, IxbElement localMappingRules, Boolean overrideConflicts) Deprecated.
static Importer	newImporter(ApplicationImportHandler applicationImportHandler, String dtd, IxbElement localMappingRules, Boolean overrideConflicts, Boolean validate) Deprecated. use newImporter(ApplicationImportHandler handler, WTContainerRef targetContainer, String dtd, IxbElement mapRules, Boolean overrideConflicts, Boolean validate) instead Supported API: true
static Importer	newImporter(ApplicationImportHandler applicationImportHandler, String dtd, IxbElement localMappingRules, Boolean overrideConflicts, Boolean validate, Boolean performConflictResolution) Deprecated. Supported API: false
static Importer	newImporter(ApplicationImportHandler applicationImportHandler, String dtd, String ruleFileName, Boolean overrideConflicts, Boolean validate) Deprecated. Supported API: false
static Importer	newImporter(ApplicationImportHandler appImpHandler, WTContainerRef targetContainer, String dtd, IxbElement localMappingRules, Boolean overrideConflicts, Boolean validate) Creates the instance of the Importer class.
static Importer	newImporter(ApplicationImportHandler appImpHandler, WTContainerRef targetContainer, String dtd, IxbElement localMappingRules, Boolean overrideConflicts, Boolean validate, Boolean conflictResolution) Creates the instance of the Importer class.
static Importer	newImporter(ApplicationImportHandler appImpHandler, WTContainerRef targetContainer, String dtd, String ruleFileName, String policyFileName, String containerMappingFileName, String actorName, Boolean overrideConflicts, Boolean validate) Creates the instance of the Importer class.
static IxbDocument	newIxbDocument() Creates the instance of the IxbDocument class.
static IxbDocument	newIxbDocument(Element domXmlFile) Creates the instance of the IxbDocument class and initializes it with the content of XML file, given as an Element parameter.
static IxbDocument	newIxbDocument(InputStream xmlFile, boolean validate) Creates the instance of the IxbDocument class and initializes it with the content of XML file, given as an InputStream parameter.

Methods inherited from class java.lang.Object

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

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

STANDARD_DTD

public static final String STANDARD_DTD

Supported API: false

STANDARD_DTD_60

public static final String STANDARD_DTD_60

Supported API: false

See Also:

Constant Field Values

STANDARD_DTD_62

public static final String STANDARD_DTD_62

Supported API: false

See Also:

Constant Field Values

STANDARD_DTD_70

public static final String STANDARD_DTD_70

Supported API: false

See Also:

Constant Field Values

STANDARD_DTD_X05

public static final String STANDARD_DTD_X05

Supported API: false

See Also:

Constant Field Values

DEFAULT_DTD_EXPORT_TAG

public static final String DEFAULT_DTD_EXPORT_TAG

Supported API: false

See Also:

Constant Field Values

VERSION_60

private static final String VERSION_60

See Also:

Constant Field Values

VERSION_62

private static final String VERSION_62

See Also:

Constant Field Values

VERSION_70

private static final String VERSION_70

See Also:

Constant Field Values

Constructor Detail

IxbHelper

public IxbHelper()

Method Detail

newExporter

public static Exporter newExporter(ApplicationExportHandler appExpHandler,
                                   WTContainerRef container,
                                   String targetDtd,
                                   IxbElement localMappingRules)
                            throws WTException

Creates the instance of the Exporter class. This instance should be used as a context for the export process.

Supported API: true

Parameters:

appExpHandler -

container - The context container that this Exporter instance is launched.

targetDtd - specifies the language used by XML documents to be exported.

localMappingRules - XML document with export mapping rules and WTProperties entries, which will override the properties set in server context for this export session.

Returns:

Exporter

Throws:

WTException

newExporter

public static Exporter newExporter(ApplicationExportHandler appExpHandler,
                                   WTContainerRef container,
                                   String targetDtd,
                                   IxbElement localMappingRules,
                                   File policyRuleFile,
                                   String actionName)
                            throws WTException

Creates the instance of the Exporter class. This instance should be used as a context for the export process.

Supported API: true

Parameters:

appExpHandler -

container - The context container that this Exporter instance is launched.

targetDtd - specifies the language used by XML documents to be exported.

localMappingRules - XML document with export mapping rules and WTProperties entries, which will override the properties set in server context for this export session.

policyRuleFile - XSL document with export policy and mapping rules

actionName - The action name for export. If this value is null, no action will be applied during export for all objects.

Returns:

Exporter

Throws:

WTException

newExporter

public static Exporter newExporter(ApplicationExportHandler appExpHandler,
                                   WTContainerRef container,
                                   String targetDtd,
                                   File localMappingRuleFile,
                                   File policyRuleFile,
                                   String actionName)
                            throws WTException

Creates the instance of the Exporter class. This instance should be used as a context for the export process.

Supported API: true

Parameters:

appExpHandler -

container - The context container that this Exporter instance is launched.

targetDtd - specifies the language used by XML documents to be exported.

localMappingRuleFile - XML document with export mapping rules and WTProperties entries, which will override the properties set in server context for this export session.

policyRuleFile - XSL document with export policy and mapping rules

actionName - The action name for export. If this value is null, no action will be applied during export for all objects.

Returns:

Exporter

Throws:

WTException

newImporter

public static Importer newImporter(ApplicationImportHandler appImpHandler,
                                   WTContainerRef targetContainer,
                                   String dtd,
                                   IxbElement localMappingRules,
                                   Boolean overrideConflicts,
                                   Boolean validate)
                            throws WTException

Creates the instance of the Importer class. This instance should be used as a context for the import process.

Supported API: true

Parameters:

appImpHandler -

targetContainer - The context container that this importer instance is launched.

dtd - specifies the language used by imported XML document

localMappingRules - XML document with import mapping rules and WTProperties entries, which will override the properties set in server context for this import session..

overrideConflicts - specifies, whether import will be done if overridable conflicts were detected. This parameter can be null; in this case the value from property wt.ixb.import.overrideConflicts will be used.

validate - specifies, whether used validating XML parser. This parameter can be null; in this case the value from property wt.ixb.import.validate will be used.

Returns:

Importer

Throws:

WTException

newImporter

public static Importer newImporter(ApplicationImportHandler appImpHandler,
                                   WTContainerRef targetContainer,
                                   String dtd,
                                   String ruleFileName,
                                   String policyFileName,
                                   String containerMappingFileName,
                                   String actorName,
                                   Boolean overrideConflicts,
                                   Boolean validate)
                            throws WTException

Creates the instance of the Importer class. This instance should be used as a context for the import process.

Supported API: true

Parameters:

appImpHandler -

targetContainer - The context container that this importer instance is launched.

dtd - specifies the language used by imported XML document

ruleFileName - XML document with import mapping rules and WTProperties entries, which will override the properties set in server context for this import session..

policyFileName - XSL document with import mapping rules

containerMappingFileName - Container mapping rule file in XML format.

actorName - Name of the action. If the value is null, the default action will be applied.

overrideConflicts - specifies, whether import will be done if overridable conflicts were detected. This parameter can be null; in this case the value from property wt.ixb.import.overrideConflicts will be used.

validate - specifies, whether used validating XML parser. This parameter can be null; in this case the value from property wt.ixb.import.validate will be used.

Returns:

Importer

Throws:

WTException

newImporter

public static Importer newImporter(ApplicationImportHandler appImpHandler,
                                   WTContainerRef targetContainer,
                                   String dtd,
                                   IxbElement localMappingRules,
                                   Boolean overrideConflicts,
                                   Boolean validate,
                                   Boolean conflictResolution)
                            throws WTException

Creates the instance of the Importer class. This instance should be used as a context for the import process

Supported API: true

Parameters:

appImpHandler -

targetContainer - The context container that this importer instance is launched.

dtd - specifies the language used by imported XML document

localMappingRules - XML document with import mapping rules and WTProperties entries, which will override the properties set in server context for this import session..

overrideConflicts - specifies, whether import will be done if overridable conflicts were detected. This parameter can be null; in this case the value from property wt.ixb.import.overrideConflicts will be used.

validate - specifies, whether used validating XML parser. This parameter can be null; in this case the value from property wt.ixb.import.validate will be used.

conflictResolution -

Returns:

Importer

Throws:

WTException

newIxbDocument

public static IxbDocument newIxbDocument()
                                  throws WTException

Creates the instance of the IxbDocument class.

Supported API: true

Returns:

IxbDocument

Throws:

WTException

newIxbDocument

public static IxbDocument newIxbDocument(InputStream xmlFile,
                                         boolean validate)
                                  throws WTException

Creates the instance of the IxbDocument class and initializes it with the content of XML file, given as an InputStream parameter.

Supported API: true

Parameters:

xmlFile -

validate -

Returns:

IxbDocument

Throws:

WTException

newIxbDocument

public static IxbDocument newIxbDocument(Element domXmlFile)
                                  throws WTException

Creates the instance of the IxbDocument class and initializes it with the content of XML file, given as an Element parameter.

Supported API: true

Parameters:

domXmlFile -

Returns:

IxbDocument

Throws:

WTException

newExporter

public static Exporter newExporter(ApplicationExportHandler applicationExportHandler,
                                   String targetDtd,
                                   IxbElement localMappingRules)
                            throws WTException

Deprecated.

Creates the instance of the Exporter class to be used as a context for the export process.

Supported API: false

Parameters:

applicationExportHandler - application handler

targetDtd - target DTD. The value STANDARD_DTD can be used for general purpose

localMappingRules - XML document with export mapping rules. Can be null

Returns:

Exporter

Throws:

WTException

newExporter

public static Exporter newExporter(ApplicationExportHandler applicationExportHandler,
                                   String targetDtd,
                                   IxbElement localMappingRules,
                                   File policyRuleFile,
                                   String actionName)
                            throws WTException

Deprecated.

Creates the instance of the Exporter class to be used as a context for the export process.

Supported API: false

Throws:

WTException

newImporter

public static Importer newImporter(ApplicationImportHandler applicationImportHandler,
                                   String dtd,
                                   IxbElement localMappingRules,
                                   Boolean overrideConflicts)
                            throws WTException

Deprecated.

Creates the instance of the Exporter class to be used as a context for the export process.

Supported API: false

Throws:

WTException

newImporter

public static Importer newImporter(ApplicationImportHandler applicationImportHandler,
                                   String dtd,
                                   IxbElement localMappingRules,
                                   Boolean overrideConflicts,
                                   Boolean validate)
                            throws WTException

Deprecated. use newImporter(ApplicationImportHandler handler, WTContainerRef targetContainer, String dtd, IxbElement mapRules, Boolean overrideConflicts, Boolean validate) instead

Supported API: true

Creates the instance of the Importer class. This instance should be used as a context for the import process

Parameters:

applicationImportHandler - application handler

dtd - specifies the language used by imported XML document

localMappingRules - XML document with import mapping rules. Can be null

overrideConflicts - specifies, whether import will be done if overridable conflicts were detected. This parameter can be null; in this case the value from property wt.ixb.import.overrideConflicts will be used.

validate - specifies, whether used validating XML parser. This parameter can be null; in this case the value from property wt.ixb.import.validate will be used.

Throws:

WTException

newImporter

public static Importer newImporter(ApplicationImportHandler applicationImportHandler,
                                   String dtd,
                                   String ruleFileName,
                                   Boolean overrideConflicts,
                                   Boolean validate)
                            throws WTException

Deprecated.

Supported API: false

Creates the instance of the Importer class. This instance should be used as a context for the import process

Parameters:

applicationImportHandler - application handler

dtd - specifies the language used by imported XML document

ruleFileName - Name of the mapping rule file (XML or XSL) Can be null

overrideConflicts - specifies, whether import will be done if overridable conflicts were detected. This parameter can be null; in this case the value from property wt.ixb.import.overrideConflicts will be used.

validate - specifies, whether used validating XML parser. This parameter can be null; in this case the value from property wt.ixb.import.validate will be used.

Throws:

WTException

newImporter

public static Importer newImporter(ApplicationImportHandler applicationImportHandler,
                                   String dtd,
                                   IxbElement localMappingRules,
                                   Boolean overrideConflicts,
                                   Boolean validate,
                                   Boolean performConflictResolution)
                            throws WTException

Deprecated.

Supported API: false

Creates the instance of the Importer class. This instance should be used as a context for the import process

Parameters:

applicationImportHandler - application handler

dtd - specifies the language used by imported XML document

localMappingRules - XML document with import mapping rules. Can be null

overrideConflicts - specifies, whether import will be done if overridable conflicts were detected. This parameter can be null; in this case the value from property wt.ixb.import.overrideConflicts will be used.

validate - specifies, whether used validating XML parser. This parameter can be null; in this case the value from property wt.ixb.import.validate will be used.

Throws:

WTException

calculateStringDTD

public static String calculateStringDTD()

getClassicContainer

private static WTContainerRef getClassicContainer()
                                           throws WTException

returns the ClassicContainer for this system

Throws:

WTException