wt.ixb.publicforapps
Class Exporter

java.lang.Object
  wt.ixb.publicforapps.ExpImporter
      wt.ixb.publicforapps.Exporter

public class Exporter
extends ExpImporter

Exporter is the container representing export handlers for the context of the export operation. Exporter instance is not stateless and there should be only one instance for each export request.
To construct an instance of Export, use IxbHelper.newExport() with the desired signatures.
There are two major categories of methods in this class to execute export:

• Various forms of the doExport method convert Windchill objects into XML document.
• The method finalizeExport finalizes export process.

Supported API: true

Extendable: true

Field Summary

Fields inherited from class wt.ixb.publicforapps.ExpImporter

attributeExporterImporterManager, generalContext, ixbHandlersManager

Method Summary

void	addIntoImplicitExportList(Object obj) Adds object into list of object that will be additionally exported in the end of the export process.
void	doExport(Object obj) Performs export of given object under Windchill's default DTD.
void	doExport(Object obj, String targetDTD) Performs export of given object into given target DTD.
void	doExport(Object obj, String targetDTD, String targetElem) Performs export of given object into given target DTD into given element's tag.
void	finalizeExport() Finalizes export process.
HashSet	getIgnoredObjectList() Returns the ignored objects for this export session.
WTContainerRef	getSourceContainerRef() Returns the container reference where the export is launched.
int	getTotalExportedObjects() Returns the number of exported objects for this export session.
void	logMessage(String resourceBundle, String messageKey, Object[] textInserts) Sends log message to export/import application Supported API: true
void	logMessage(String resourceBundle, String messageKey, Object[] textInserts, int importanceLevel) Sends log message to export/import application Supported API: true
boolean	objectWillBeReallyExported(Object obj) Test whether the corresponding object has handler under the default DTD.
String	storeDocument(IxbDocument element) Applies export mapping rules and stores XML document through application handler.

Methods inherited from class java.lang.Object

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

Method Detail

addIntoImplicitExportList

public void addIntoImplicitExportList(Object obj)
                               throws WTException

Adds object into list of object that will be additionally exported in the end of the export process.

Supported API: true

Parameters:

obj - object that will be additionally exported

Throws:

WTException

finalizeExport

public void finalizeExport()
                    throws WTException

Finalizes export process. Calls finalizeExport method for all export handlers.

Supported API: true

Throws:

WTException

storeDocument

public String storeDocument(IxbDocument element)
                     throws WTException

Applies export mapping rules and stores XML document through application handler. Should be used by export handlers. Return the file name (or other file id) if the element is actually stored, null otherwise.

Supported API: true

Parameters:

element - element wt.ixb.publicforapps.IxbDocument, representing the XML document, produced by export handler

Returns:

String

Throws:

WTException

doExport

public void doExport(Object obj)
              throws WTException

Performs export of given object under Windchill's default DTD.

Supported API: true

Parameters:

obj -

Throws:

WTException

See Also:

doExport (Object obj, String targetDTD)

doExport

public void doExport(Object obj,
                     String targetDTD)
              throws WTException

Performs export of given object into given target DTD. IXB service supports an ability to export object into different XML languages. To achive that export handler should be registred for given class and given XML language.

Supported API: true

Parameters:

obj -

targetDTD -

Throws:

WTException

doExport

public void doExport(Object obj,
                     String targetDTD,
                     String targetElem)
              throws WTException

Performs export of given object into given target DTD into given element's tag. IXB service supports an ability to export object into different XML languages and into different element's tag. In order to do this the export handler should be registred for given class, given XML language and given element's tag

Supported API: true

Parameters:

obj -

targetDTD -

targetElem -

Throws:

WTException

logMessage

public void logMessage(String resourceBundle,
                       String messageKey,
                       Object[] textInserts)
                throws WTException

Sends log message to export/import application

Supported API: true

Specified by:

logMessage in class ExpImporter

Parameters:

resourceBundle -

messageKey -

textInserts -

Throws:

WTException

logMessage

public void logMessage(String resourceBundle,
                       String messageKey,
                       Object[] textInserts,
                       int importanceLevel)
                throws WTException

Sends log message to export/import application

Supported API: true

Specified by:

logMessage in class ExpImporter

Parameters:

resourceBundle -

messageKey -

textInserts -

importanceLevel -

Throws:

WTException

objectWillBeReallyExported

public boolean objectWillBeReallyExported(Object obj)
                                   throws WTException

Test whether the corresponding object has handler under the default DTD.
This method is deprecated. To test an object has the corresponding export handler or not, use the method IXBHelper.service.getExportHandler (String obType, String dtd)

Throws:

WTException

See Also:



Supported API: true

getIgnoredObjectList

public HashSet getIgnoredObjectList()

Returns the ignored objects for this export session.

Supported API: true

Returns:

HashSet

getSourceContainerRef

public WTContainerRef getSourceContainerRef()

Returns the container reference where the export is launched.

Supported API: true

Returns:

WTContainerRef

getTotalExportedObjects

public int getTotalExportedObjects()

Returns the number of exported objects for this export session.

Supported API: true