Package wt.ixb.publicforapps

Interface ApplicationExportHandler

All Superinterfaces:
ApplicationExpImportHandler
All Known Implementing Classes:
ApplicationExportHandlerForJar, ApplicationExportHandlerForXml, ApplicationExportHandlerTemplate, PDXExportHandler
public interface ApplicationExportHandler extends ApplicationExpImportHandler
This is the base class for export application handlers.
Any export application must supply for export service such a handler to store exported information. IXB service by itself knows nothing about how to store generated XML files. It completely relies here on the handler, supplied by export application.

There are two different types of the information, that should be stored in the export process:

  • XML elements, which are the XML representation of exported objects (of objects' meta data)
  • objects' contents - for objects, that are content holders (ContentHolder), e.g. WTDocument


Supported API: true

Extendable: false

  • Method Details

    • storeDocument

      String storeDocument(IxbElement elem) throws WTException
      Stores the given XML element, which is the XML representation of exported object, based on Windchill's default DTD for export. Return XML file name or some other string identifier for the stored element.

      Supported API: true
      Parameters:
      elem -
      Returns:
      String
      Throws:
      WTException
      See Also:
      • storeDocument (IxbElement elem, String dtd)

    • storeDocument

      String storeDocument(IxbElement elem, String dtd) throws WTException
      Stores the given XML element, which is the XML representation of exported object, based on the provided DTD. If parameter dtd is null, Windchill's default DTD is assumed. Return XML file name or some other string identifier for the stored element.

      Supported API: true
      Parameters:
      elem -
      dtd -
      Returns:
      String
      Throws:
      WTException
      See Also:
      • storeDocument (IxbElement elem)

    • storeDocument

      String storeDocument(IxbElement elem, ByteArrayOutputStream bos) throws WTException
      Stores the given ByteArrayOutputStream, which is the XML representation of exported object, based on the provided DTD. Return XML file name or some other string identifier for the stored element.

      Supported API: true
      Parameters:
      elem -
      bos -
      Returns:
      String
      Throws:
      WTException
      See Also:
      • storeDocument (IxbElement elem)

    • storeContent

      String storeContent(Object contentAttr) throws WTException
      Stores the given content of exported object. The return value is String, that will be used in XML file as an identifier of this content. Application should be able to find the content during the import process by this identifier. The content of the associated object might not be saved, depending on the implementation of the this interface.

      Supported API: true
      Parameters:
      contentAttr - The content attribute which is related to InputStream or BLOB. e.g. it can be ApplicationData , File or String (full path of a file), etc
      Returns:
      String
      Throws:
      WTException

    • storeContent

      String storeContent(File file) throws WTException
      Stores content files residing in the local file system (as in the case of Representation objects).

      Supported API: true
      Parameters:
      file -
      Returns:
      String
      Throws:
      WTException

    • storeContent

      String storeContent(File file, String filename) throws WTException
      Stores content files residing in the local file system (as in the case of Representation objects).

      Supported API: true
      Parameters:
      file -
      filename -
      Returns:
      String
      Throws:
      WTException

    • storeContent

      String storeContent(File file, String filename, boolean deleteAfterStore) throws WTException
      Stores content files residing in the local file system (as in the case of Representation objects). Whether to perform a cleanup when done with the file is denoted by a boolean flag.

      Supported API: true
      Parameters:
      file - Local file
      filename - File name
      deleteAfterStore - Whether the file should be deleted after store.
      Returns:
      String
      Throws:
      WTException

    • reallyStoreContent

      void reallyStoreContent(Object contentHolder, Exporter exporter, InputStream content, String contentId) throws WTException
      Stores the given content of the content parameter "contentAttr". The parameter "contentId" is the unique content ID which was previously computed and returned by storeContent (Object contentAttr).

      Supported API: true
      Parameters:
      contentHolder - The object holding the attribute (directly or indirectly) "contentAttr".
      exporter -
      content - The content as InputStream which is associated with the contentId.
      contentId - The unique content ID which was previously computed by calling "storeContent (Object contentAttr)"
      Throws:
      WTException

    • reallyStoreContent

      void reallyStoreContent(Object contentHolder, Exporter exporter, InputStream content, long contentSize, String contentId) throws WTException
      Stores the given content of the content parameter "contentAttr". The parameter "contentId" is the unique content ID which was previously computed and returned by storeContent (Object contentAttr). *

      Supported API: true
      Parameters:
      contentHolder - The object holding the attribute (directly or indirectly) "contentAttr".
      exporter -
      content - The content as InputStream which is associated with the contentId.
      contentSize - The size of content in bytes.
      contentId - The unique content ID which was previously computed by calling "storeContent (Object contentAttr)"
      Throws:
      WTException

    • storeAdditionalInfo

      void storeAdditionalInfo(Object object, IxbDocument fileXML, String fileId) throws WTException
      Stores additional information related to object and its XML representation.

      Supported API: true
      Parameters:
      object -
      fileXML -
      fileId -
      Throws:
      WTException

    • finalizeAdditionalInfo

      void finalizeAdditionalInfo() throws WTException


      Supported API: true
      Throws:
      WTException

    • finalizeStore

      void finalizeStore() throws WTException
      Finalize objects store, per Object exported.

      Supported API: true
      Throws:
      WTException