de.galan.dmsexchange

Class DmsExchange

java.lang.Object

de.galan.dmsexchange.DmsExchange

public class DmsExchange
extends Object

Entry-point for DmsExchange use-cases.

Author:

daniel

Constructor Summary

Constructors

Constructor and Description
DmsExchange()

Method Summary

Modifier and Type	Method and Description
static DmsReader	createReader(File file) Provides a export-archive reader for Documents that are contained in the passed file.
static DmsReader	createReader(InputStream inputstream) Provides a export-archive reader for Documents that are read from the passed InputStream.
static DmsReader	createReader(String file) Provides a export-archive reader for Documents that are contained in the passed file.
static DmsWriter	createWriter(File file) Provides a writer to create an export-archive with Documents that is written to the given File.
static ConditionalDmsWriter	createWriter(File directory, Integer thresholdDocuments) Provides a conditional writer to create (potentially) multiple export-archives with Documents in the given directory.
static ConditionalDmsWriter	createWriter(File directory, Integer thresholdDocuments, Integer thresholdFilesize) Provides a conditional writer to create (potentially) multiple export-archives with Documents in the given directory.
static DmsWriter	createWriter(OutputStream outputstream) Provides a writer to create an export-archive with Documents that is written to the given OutputStream.

Methods inherited from class java.lang.Object

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

Constructor Detail

DmsExchange

public DmsExchange()

Method Detail

createReader

public static DmsReader createReader(String file)
                              throws DmsExchangeException

Provides a export-archive reader for Documents that are contained in the passed file.

Parameters:

file - Absolute path to an export-archive with Documents

Returns:

A non thread-safe DmsReader that is used to read documents from a file.

Throws:

DmsExchangeException - If the file can't be read or other bad things happen

createReader

public static DmsReader createReader(File file)
                              throws DmsExchangeException

Provides a export-archive reader for Documents that are contained in the passed file.

Parameters:

file - Location of the export-archive with Documents

Returns:

A non thread-safe DmsReader that is used to read documents from a file.

Throws:

DmsExchangeException - If the file can't be read or other bad things happen

createReader

public static DmsReader createReader(InputStream inputstream)

Provides a export-archive reader for Documents that are read from the passed InputStream.

Parameters:

inputstream - Stream containing data from an export-archive

Returns:

A non thread-safe DmsReader that is used to read documents from the given InputStream.

Throws:

DmsExchangeException - If the data can't be read or other bad things happen

createWriter

public static DmsWriter createWriter(File file)
                              throws DmsExchangeException

Provides a writer to create an export-archive with Documents that is written to the given File.

Parameters:

file - The file which is used to store the export-archive data. If the file already exists, it will be overwritten. Non-existing parent-directories will be created. If file is a directory, an IllegalArgumentException will be thrown.

Returns:

A DmsWriter that accepts Documents and must be closed when finished.

Throws:

DmsExchangeException - Encapsulating parent Exception for erroneous behaviour

createWriter

public static DmsWriter createWriter(OutputStream outputstream)
                              throws DmsExchangeException

Provides a writer to create an export-archive with Documents that is written to the given OutputStream.

Parameters:

outputstream - OutputStream the export-archive is written to.

Returns:

A DmsWriter that accepts Documents and must be closed when finished.

Throws:

DmsExchangeException - Encapsulating parent Exception for erroneous behaviour

createWriter

public static ConditionalDmsWriter createWriter(File directory,
                                                Integer thresholdDocuments)
                                         throws DmsExchangeException

Provides a conditional writer to create (potentially) multiple export-archives with Documents in the given directory. If the given condition (thesholdDocuments) is matched, the export continuous on a new export-archive.

Parameters:

directory - Location where to create the export-archive files with a generated unique name.

thresholdDocuments - Limit of Documents a single export-archive can have, before creating a new export-archive.

Returns:

A ConditionalDmsWriter that accepts Documents and must be closed when finished. The files written by the instance can be queried using the getFiles() method.

Throws:

DmsExchangeException - Encapsulating parent Exception for erroneous behaviour

createWriter

public static ConditionalDmsWriter createWriter(File directory,
                                                Integer thresholdDocuments,
                                                Integer thresholdFilesize)
                                         throws DmsExchangeException

Provides a conditional writer to create (potentially) multiple export-archives with Documents in the given directory. If one of the the given conditions (thesholdDocuments or thresholdFilesize) is matched, the export continuous on a new export-archive.

Parameters:

directory - Location where to create the export-archive files with a generated unique name.

thresholdDocuments - Limit of Documents a single export-archive can have, before creating a new export-archive.

thresholdFilesize - Filesize in bytes the final export (approximately) can become, before creating a new export-archive.

Returns:

A ConditionalDmsWriter that accepts Documents and must be closed when finished. The files written by the instance can be queried using the getFiles() method.

Throws:

DmsExchangeException - Encapsulating parent Exception for erroneous behaviour