Package wt.ixb.publicforapps

Class Exporter

java.lang.Object
wt.ixb.publicforapps.ExpImporter<ExportContextData>
wt.ixb.publicforapps.Exporter
public class Exporter extends ExpImporter<ExportContextData>
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

  • Method Details

    • addIntoImplicitExportList

      public void addIntoImplicitExportList(Object obj)
      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

    • finalizeExport

      public void finalizeExport() throws WTException
      Finalizes export process. Calls finalizeExport method for all export handlers.

      Supported API: true
      Throws:
      WTException
      See Also:

    • finalizeExport

      public void finalizeExport(boolean writeManifest) throws WTException
      Finalizes export process. Calls finalizeExport method for all export handlers. Depending on the writeManifest value it will generate the manifest, if writeManifest=true

      Supported API: true
      Parameters:
      writeManifest - Whether to add manifest file
      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.facade.ixb.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, String)

    • 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 achieve that export handler should be registered 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 registered for given class, given XML language and given element's tag
      This API doesn't call prepareForExport. If you intend to have it called then use doExport(Object) or doExport(Object, String)

      Supported API: true
      Parameters:
      obj -
      targetDTD -
      targetElem -
      Throws:
      WTException

    • objectWillBeReallyExported

      @Deprecated public boolean objectWillBeReallyExported(Object obj) throws WTException
      Deprecated.
      * @depracated 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)
      Parameters:
      obj -
      Returns:
      Throws:
      WTException
      See Also:


      • Supported API: true

    • getIgnoredObjectList

      public Set 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
      Returns:

    • getFaultToleranceOpHandler

      public ExpFaultToleranceHandler getFaultToleranceOpHandler()
      Get Fault Tolerance handler for export
      Supported API: true
      Returns: