Package com.axemble.vdoc.sdk.interfaces

Interface ITransformer

All Superinterfaces:
Serializable
All Known Implementing Classes:
PortalResourceTransformer, ProcessResourceTransformer
public interface ITransformer extends Serializable
Allows to transform directory elements to and from XML documents.
Since:
VDocSDK 1.0
Author:
Vassyly Lygeros
See Also:

  • Method Details

    • resourceToXML

      @Deprecated void resourceToXML(IResource resource, OutputStream outputStream) throws IOException
      Deprecated.
      : use resourceToXML( IResource resource, OutputStream outputStream, File attachmentsFolder, boolean includeAttachmentsContent ) method instead.
      Allows to transform a IResource object to an XML document.
      Parameters:
      resource - The IResource to transform.
      outputStream - The OutputStream object to write to.
      Throws:
      IOException

    • resourceToXML

      void resourceToXML(IResource resource, OutputStream outputStream, boolean includeAttachmentsContent, boolean includeWorkflowInstanceBody) throws IOException
      Allows to transform a IResource object to an XML document.
      Parameters:
      resource - The IResource to transform.
      outputStream - The OutputStream object to write to.
      includeAttachmentsContent - If true, includes the attachments into the XML stream.
      Throws:
      IOException

    • resourceToXML

      @Deprecated void resourceToXML(IResource resource, OutputStream outputStream, boolean includeAttachmentsContent) throws IOException
      Deprecated.
      : use resourceToXML( IResource resource, OutputStream outputStream, File attachmentsFolder, boolean includeAttachmentsContent ) method instead.
      Allows to transform a IResource object to an XML document.
      Parameters:
      resource - The IResource to transform.
      outputStream - The OutputStream object to write to.
      includeAttachmentsContent - If true, includes the attachments into the XML stream.
      Throws:
      IOException

    • resourceToXML

      @Deprecated void resourceToXML(IResource resource, OutputStream outputStream, File attachmentsFolder) throws IOException
      Deprecated.
      : use resourceToXML( IResource resource, OutputStream outputStream, File attachmentsFolder, boolean includeAttachmentsContent ) method instead.
      Allows to transform a IResource object to an XML document.
      Parameters:
      resource - The IResource to transform.
      outputStream - The OutputStream object to write to.
      attachmentsFolder - The directory where to export the attachments.
      Throws:
      IOException

    • resourceToXML

      @Deprecated void resourceToXML(IResource resource, File resourceFolder) throws IOException
      Deprecated.
      : use resourceToXML( IResource resource, OutputStream outputStream, File attachmentsFolder, boolean includeAttachmentsContent ) method instead.
      Allows to transform a IResource object to an XML document.
      Parameters:
      resource - The IResource to transform.
      resourceFolder - The directory where to export the XML stream and its attachments.
      Throws:
      IOException

    • resourceToXML

      void resourceToXML(IResource resource, Collection columns, OutputStream outputStream) throws IOException
      Allows to get values of a resource by specifying the columns to retrieve.
      Parameters:
      resource - The IResource object to request property values from.
      columns - A Collection of property names.
      outputStream - The OutputStream object to write to.
      Throws:
      IOException

    • resourceToXML

      void resourceToXML(IResource resource, OutputStream outputStream, File attachmentsFolder, boolean includeAttachmentsContent) throws IOException
      Allows to transform a IResource object to an XML document.
      Parameters:
      resource - The IResource to transform.
      outputStream - The OutputStream object to write to.
      attachmentsFolder - The directory where to export the attachments.
      includeAttachmentsContent - If true, includes the attachments into the XML stream.
      Throws:
      IOException

    • xmlToResource

      IResource xmlToResource(InputStream inputStream) throws IOException
      Import a resource from an XML stream.
      Parameters:
      inputStream - The InputStream object to read from.
      Returns:
      A IResource object.
      Throws:
      IOException

    • xmlToResource

      IResource xmlToResource(InputStream inputStream, File resourceFolder) throws IOException
      Import a resource from an XML stream.
      Parameters:
      inputStream - The InputStream object to read from.
      resourceFolder - The directory from where to import the attachments.
      Returns:
      A IResource object.
      Throws:
      IOException

    • xmlToResource

      IResource xmlToResource(IResource resource, InputStream inputStream) throws IOException
      Updates a resource.
      Parameters:
      resource - The IResource to update.
      inputStream - The InputStream object to read from.
      Returns:
      A IResource object.
      Throws:
      IOException

    • setIncludeAttachmentsContent

      void setIncludeAttachmentsContent(boolean includeAttachmentsContent)
      Allows to include or not the files content. By default, the value is set to true.
      Parameters:
      includeAttachmentsContent - Set to false to avoid file content inclusion.

    • setIncludeLabels

      void setIncludeLabels(boolean includeLabels)
      Allows to include or not the labels. By default, the value is set to true.
      Parameters:
      includeLabels - Set to false to avoid labels inclusion.

    • setIncludeLinkedResources

      void setIncludeLinkedResources(boolean includeLinkedResources)
      Allows to include or not ILinkedResource objects. By default, the value is set to true.
      Parameters:
      includeLinkedResources - Set to false to avoid linked resources inclusion.

    • setIncludeLinkedWorkflowInstances

      void setIncludeLinkedWorkflowInstances(boolean includeLinkedWorkflowInstances)
      Allows to include or not linked IWorkflowInstance objects. By default, the value is set to true.
      Parameters:
      includeLinkedWorkflowInstances - Set to false to avoid linked workflow instances inclusion.

    • useGuid

      void useGuid(boolean generateGuid)
      Allows to specify whether to use generate a Guid or not.
      Parameters:
      generateGuid -

    • setIncludeStorageResources

      void setIncludeStorageResources(boolean includeStorageResources)
      Allows to include or not IStorageResource objects. By default, the value is set to false.
      Parameters:
      includeStorageResources - Set to true to allow storage resources inclusion.

    • setStopExecutionOnCriticalError

      void setStopExecutionOnCriticalError(boolean stopExecutionOnCriticalError)
      Allows to stop the execution of the treatment if an exception occur. By default, the value is set to false.
      Parameters:
      stopExecutionOnCriticalError - Set to true to stop the execution of the treatment if an exception occure.