Package com.axemble.vdoc.sdk.impl

Class PortalResourceTransformer

java.lang.Object

com.axemble.vdoc.sdk.impl.AbstractElement

com.axemble.vdoc.sdk.impl.base.BaseTransformer

com.axemble.vdoc.sdk.impl.PortalResourceTransformer

All Implemented Interfaces:

ITransformer, Serializable

public class PortalResourceTransformer
extends com.axemble.vdoc.sdk.impl.base.BaseTransformer
implements ITransformer

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PortalResourceTransformer.IXMLImporter

Field Summary

Fields

Modifier and Type	Field	Description
protected File	attachmentsFolder
protected IDirectoryModule	directoryModule
protected boolean	includeAttachmentsContent
protected boolean	includeLabels
protected boolean	includeLinkedResources
protected boolean	includeLinkedWorkflowInstances
protected boolean	includeStorageResources
protected ILibraryModule	libraryModule
static final String	prefix
protected boolean	stopExecutionOnCriticalError
protected boolean	useGuid
protected static HashMap	xmlImportersMap

Fields inherited from class com.axemble.vdoc.sdk.impl.AbstractElement

module

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PortalResourceTransformer(IModule module)

Method Summary

Modifier and Type	Method	Description
void	buildXMLBody(Element parent, IResource resource)
void	buildXMLBody(Element parent, IResource resource, Collection columns)
void	buildXMLHistory(Element parent, IResource resource)
protected static String	dateToString(Date date)
protected static PortalResourceTransformer.IXMLImporter	getImporter(String key)
protected static void	importHistory(IResource childResource, Element fieldElement)
protected String	notNull(String data)
protected static Date	parseDate(String dateAsString)
void	resourceToXML(IResource resource, OutputStream outputStream)	Allows to transform a IResource object to an XML document.
void	resourceToXML(IResource resource, OutputStream outputStream, File attachmentsFolder)	Allows to transform a IResource object to an XML document.
void	resourceToXML(IResource resource, OutputStream outputStream, File attachmentsFolder, boolean includeAttachmentsContent)	Allows to transform a IResource object to an XML document.
void	resourceToXML(IResource resource, Collection columns, OutputStream outputStream)	Allows to get values of a resource by specifying the columns to retrieve.
void	setIncludeAttachmentsContent(boolean includeAttachmentsContent)	Allows to include or not the files content.
void	setIncludeLabels(boolean includeLabels)	Allows to include or not the labels.
void	setIncludeLinkedResources(boolean includeLinkedResources)	Allows to include or not ILinkedResource objects.
void	setIncludeLinkedWorkflowInstances(boolean includeLinkedWorkflowInstances)	Allows to include or not linked IWorkflowInstance objects.
void	setIncludeStorageResources(boolean includeStorageResources)	Allows to include or not IStorageResource objects.
void	setStopExecutionOnCriticalError(boolean stopExecutionOnCriticalError)	Allows to stop the execution of the treatment if an exception occur.
void	useGuid(boolean generateGuid)	Allows to specify whether to use generate a Guid or not.
IResource	xmlToResource(IResource resource, InputStream inputStream)	Updates a resource.
IResource	xmlToResource(InputStream inputStream)	Import a resource from an XML stream.
IResource	xmlToResource(InputStream inputStream, File resourceFolder)	Import a resource from an XML stream.

Methods inherited from class com.axemble.vdoc.sdk.impl.base.BaseTransformer

resourceToXML, resourceToXML, resourceToXML, resourceToXML

Methods inherited from class com.axemble.vdoc.sdk.impl.AbstractElement

getModule

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.axemble.vdoc.sdk.interfaces.ITransformer

resourceToXML, resourceToXML, resourceToXML

Field Details

prefix

public static final String prefix

See Also:

• Constant Field Values

directoryModule

protected IDirectoryModule directoryModule

libraryModule

protected ILibraryModule libraryModule

attachmentsFolder

protected File attachmentsFolder

includeAttachmentsContent

protected boolean includeAttachmentsContent

includeLabels

protected boolean includeLabels

includeLinkedWorkflowInstances

protected boolean includeLinkedWorkflowInstances

includeStorageResources

protected boolean includeStorageResources

includeLinkedResources

protected boolean includeLinkedResources

useGuid

protected boolean useGuid

stopExecutionOnCriticalError

protected boolean stopExecutionOnCriticalError

xmlImportersMap

protected static HashMap xmlImportersMap

Constructor Details

PortalResourceTransformer

protected PortalResourceTransformer(IModule module)

Method Details

getImporter

protected static PortalResourceTransformer.IXMLImporter getImporter(String key)

resourceToXML

public void resourceToXML(IResource resource,
 OutputStream outputStream,
 File attachmentsFolder,
 boolean includeAttachmentsContent)
                   throws IOException

Description copied from interface: ITransformer

Allows to transform a IResource object to an XML document.

Specified by:

resourceToXML in interface ITransformer

Specified by:

resourceToXML in class com.axemble.vdoc.sdk.impl.base.BaseTransformer

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

resourceToXML

public void resourceToXML(IResource resource,
 OutputStream outputStream,
 File attachmentsFolder)
                   throws IOException

Description copied from interface: ITransformer

Allows to transform a IResource object to an XML document.

Specified by:

resourceToXML in interface ITransformer

Overrides:

resourceToXML in class com.axemble.vdoc.sdk.impl.base.BaseTransformer

Parameters:

resource - The IResource to transform.

outputStream - The OutputStream object to write to.

attachmentsFolder - The directory where to export the attachments.

Throws:

IOException

resourceToXML

public void resourceToXML(IResource resource,
 OutputStream outputStream)
                   throws IOException

Description copied from interface: ITransformer

Allows to transform a IResource object to an XML document.

Specified by:

resourceToXML in interface ITransformer

Overrides:

resourceToXML in class com.axemble.vdoc.sdk.impl.base.BaseTransformer

Parameters:

resource - The IResource to transform.

outputStream - The OutputStream object to write to.

Throws:

IOException

xmlToResource

public IResource xmlToResource(InputStream inputStream)
                        throws IOException

Description copied from interface: ITransformer

Import a resource from an XML stream.

Specified by:

xmlToResource in interface ITransformer

Parameters:

inputStream - The InputStream object to read from.

Returns:

A IResource object.

Throws:

IOException

xmlToResource

public IResource xmlToResource(IResource resource,
 InputStream inputStream)
                        throws IOException

Description copied from interface: ITransformer

Updates a resource.

Specified by:

xmlToResource in interface ITransformer

Parameters:

resource - The IResource to update.

inputStream - The InputStream object to read from.

Returns:

A IResource object.

Throws:

IOException

buildXMLHistory

public void buildXMLHistory(Element parent,
 IResource resource)

buildXMLBody

public void buildXMLBody(Element parent,
 IResource resource,
 Collection columns)
                  throws Exception

Throws:

Exception

buildXMLBody

public void buildXMLBody(Element parent,
 IResource resource)
                  throws Exception

Throws:

Exception

dateToString

protected static String dateToString(Date date)

parseDate

protected static Date parseDate(String dateAsString)

notNull

protected String notNull(String data)

resourceToXML

public void resourceToXML(IResource resource,
 Collection columns,
 OutputStream outputStream)
                   throws IOException

Description copied from interface: ITransformer

Allows to get values of a resource by specifying the columns to retrieve.

Specified by:

resourceToXML in interface ITransformer

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

xmlToResource

public IResource xmlToResource(InputStream inputStream,
 File resourceFolder)
                        throws IOException

Description copied from interface: ITransformer

Import a resource from an XML stream.

Specified by:

xmlToResource in interface ITransformer

Parameters:

inputStream - The InputStream object to read from.

resourceFolder - The directory from where to import the attachments.

Returns:

A IResource object.

Throws:

IOException

importHistory

protected static void importHistory(IResource childResource,
 Element fieldElement)
                             throws WorkflowModuleException,
RemoteException

Throws:

WorkflowModuleException

RemoteException

setIncludeLabels

public void setIncludeLabels(boolean includeLabels)

Description copied from interface: ITransformer

Allows to include or not the labels. By default, the value is set to true.

Specified by:

setIncludeLabels in interface ITransformer

Parameters:

includeLabels - Set to false to avoid labels inclusion.

setIncludeLinkedResources

public void setIncludeLinkedResources(boolean includeLinkedResources)

Description copied from interface: ITransformer

Allows to include or not ILinkedResource objects. By default, the value is set to true.

Specified by:

setIncludeLinkedResources in interface ITransformer

Parameters:

includeLinkedResources - Set to false to avoid linked resources inclusion.

setIncludeLinkedWorkflowInstances

public void setIncludeLinkedWorkflowInstances(boolean includeLinkedWorkflowInstances)

Description copied from interface: ITransformer

Allows to include or not linked IWorkflowInstance objects. By default, the value is set to true.

Specified by:

setIncludeLinkedWorkflowInstances in interface ITransformer

Parameters:

includeLinkedWorkflowInstances - Set to false to avoid linked workflow instances inclusion.

setIncludeAttachmentsContent

public void setIncludeAttachmentsContent(boolean includeAttachmentsContent)

Description copied from interface: ITransformer

Allows to include or not the files content. By default, the value is set to true.

Specified by:

setIncludeAttachmentsContent in interface ITransformer

Parameters:

includeAttachmentsContent - the includeAttachmentsContent to set

useGuid

public void useGuid(boolean generateGuid)

Description copied from interface: ITransformer

Allows to specify whether to use generate a Guid or not.

Specified by:

useGuid in interface ITransformer

Parameters:

generateGuid -

setIncludeStorageResources

public void setIncludeStorageResources(boolean includeStorageResources)

Description copied from interface: ITransformer

Allows to include or not IStorageResource objects. By default, the value is set to false.

Specified by:

setIncludeStorageResources in interface ITransformer

Parameters:

includeStorageResources - Set to true to allow storage resources inclusion.

setStopExecutionOnCriticalError

public void setStopExecutionOnCriticalError(boolean stopExecutionOnCriticalError)

Description copied from interface: ITransformer

Allows to stop the execution of the treatment if an exception occur. By default, the value is set to false.

Specified by:

setStopExecutionOnCriticalError in interface ITransformer

Parameters:

stopExecutionOnCriticalError - Set to true to stop the execution of the treatment if an exception occure.