com.opentext.ia.sdk.sip

Class BatchSipAssembler<D>

java.lang.Object

com.opentext.ia.sdk.sip.BatchSipAssembler<D>

Type Parameters:

D - The type of domain object to assemble SIPs from

Direct Known Subclasses:

BatchSipAssemblerWithCallback

public class BatchSipAssembler<D>
extends java.lang.Object

Assemble a batch of SIPs, based on some sort of segmentation strategy that determines which domain objects go into which SIPs.

To create a batch of SIPs, simply add domain objects and end the assembly process. Then access the generated files and metrics about them using getSipsMetrics().

There are several factory methods available to create common segmentation strategies and you can also combine them.

Warning:

This object is not thread-safe. If you want to use multiple threads to assemble SIPs, let each use their own instance.

Constructor Summary

Constructors

Constructor and Description
BatchSipAssembler(SipAssembler<D> assembler, SipSegmentationStrategy<D> segmentationStrategy) Create an instance that assembles SIPs in a temporary directory.
BatchSipAssembler(SipAssembler<D> assembler, SipSegmentationStrategy<D> segmentationStrategy, java.io.File dir) Create an instance that assembles SIPs in the given directory.
BatchSipAssembler(SipAssembler<D> assembler, SipSegmentationStrategy<D> segmentationStrategy, java.util.function.Supplier<java.io.File> fileSupplier) Create an instance that assembles SIPs using the given supplier of SIP files.

Method Summary

Modifier and Type	Method and Description
void	add(D domainObject) Add a domain object to the batch of SIPs.
protected void	closeCurrentSip()
void	end() End the batch assembly process.
java.util.Collection<FileGenerationMetrics>	getSipsMetrics() Returns the files that were generated as part of this batch and metrics about the SIPs stored in them.
protected void	setFinalSipInDss(boolean finalSipInDss)
protected void	sipEnded(FileGenerationMetrics metrics)

Methods inherited from class java.lang.Object

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

Constructor Detail

BatchSipAssembler

public BatchSipAssembler(SipAssembler<D> assembler,
                         SipSegmentationStrategy<D> segmentationStrategy)

Create an instance that assembles SIPs in a temporary directory.

Parameters:

assembler - An assembler that builds up the SIPs in the batch

segmentationStrategy - A strategy that determines when to start new SIPs

BatchSipAssembler

public BatchSipAssembler(SipAssembler<D> assembler,
                         SipSegmentationStrategy<D> segmentationStrategy,
                         java.io.File dir)

Create an instance that assembles SIPs in the given directory.

Parameters:

assembler - An assembler that builds up the SIPs in the batch

segmentationStrategy - A strategy that determines when to start new SIPs

dir - Directory in which to generate SIP files

BatchSipAssembler

public BatchSipAssembler(SipAssembler<D> assembler,
                         SipSegmentationStrategy<D> segmentationStrategy,
                         java.util.function.Supplier<java.io.File> fileSupplier)

Create an instance that assembles SIPs using the given supplier of SIP files.

Parameters:

assembler - An assembler that builds up the SIPs in the batch

segmentationStrategy - A strategy that determines when to start new SIPs

fileSupplier - A supplier of files in which to store the SIPs

Method Detail

setFinalSipInDss

protected final void setFinalSipInDss(boolean finalSipInDss)

add

public void add(D domainObject)
         throws java.io.IOException

Add a domain object to the batch of SIPs.

Parameters:

domainObject - The domain object to add

Throws:

java.io.IOException - When an I/O error occurs

closeCurrentSip

protected final void closeCurrentSip()
                              throws java.io.IOException

Throws:

java.io.IOException

sipEnded

protected void sipEnded(FileGenerationMetrics metrics)

end

public void end()
         throws java.io.IOException

End the batch assembly process.

Throws:

java.io.IOException - When an I/O error occurs

getSipsMetrics

public java.util.Collection<FileGenerationMetrics> getSipsMetrics()

Returns the files that were generated as part of this batch and metrics about the SIPs stored in them.

Returns:

The files that were generated as part of this batch and metrics about the SIPs stored in them