net.webpdf.ant.task.files

Class IterativeTaskFile

java.lang.Object

net.webpdf.ant.task.files.IterativeTaskFile

public class IterativeTaskFile
extends Object

This class manages the files processed by a task, it shall start with the original source file and shall provide a temporary target file for each calling sub task. Using this class to manage files enables tasks to manage their sources and targets in a common and centralized way. This class will attempt to prepare the result of a previously calling task as the source of the following task. The original source file will never be altered using an instance of this class. This class will never delete the original source file. This class provides a mechanism to copy the terminal temporary file to the intended target path at the end.

Constructor Summary

Constructors

Constructor and Description
IterativeTaskFile(File originalSourceFile, String targetFileName, TempDir tempDir) An instance of this class manages files for encapsulated tasks - passing results of a previous task, as the source for following task.

Method Summary

Methods

Modifier and Type	Method and Description
void	dropCurrentTarget() Invalidates the current temporary target and will preserve the current source file for the next operation.
File	finalizeAndReset(File targetFile, File targetDirectory) This shall both reset this instance to it's original state and shall copy the last produced result to either the given targetFile (using the exact name and path), or to the given targetDirectory (using the initially set targetName).
File	getCurrentSource() Shall return the file, that is serving as the source file of the currently prepared step.
File	getCurrentTarget() This shall return the current target file - if the current target file has not yet been initialized, a new temporary target file shall be prepared by calling this method.
void	prepareNextOperation() This shall decide whether the current temporary source file shall be deleted or not.
void	preserveCurrentSource() When called the current temporary source file will not be deleted, when it is replaced by the current target in next step.
void	reset() This will drop the current context and will reset this instance to the original source document.
void	setCurrentSource(File currentSource, boolean preserveSource) Shall set the file, that is serving as the source file of the currently prepared step.
void	tryPublish(Variable variable) Attempts to publish the current group result to the Ant context using the given output var name.

Methods inherited from class java.lang.Object

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

Constructor Detail

IterativeTaskFile

public IterativeTaskFile(File originalSourceFile,
                 String targetFileName,
                 TempDir tempDir)
                  throws org.apache.tools.ant.BuildException

An instance of this class manages files for encapsulated tasks - passing results of a previous task, as the source for following task. It shall automatically create temporary files in between the calling tasks, it shall prevent the original source file from being modified or deleted. It shall provide a mechanism to copy the end result to a specified target path.

Parameters:

originalSourceFile - The initial source file, that shall be processed iteratively.

targetFileName - The name of the terminal target file.

tempDir - The directory temporary files shall be placed in.

Throws:

org.apache.tools.ant.BuildException - Shall be thrown if any of the parameters is invalid (null).

Method Detail

setCurrentSource

public void setCurrentSource(File currentSource,
                    boolean preserveSource)

Shall set the file, that is serving as the source file of the currently prepared step.

Parameters:

currentSource - The file, that shall be used as the source of the currently prepared step.

preserveSource - When set to true the prepared source file shall not be deleted after the execution.

getCurrentSource

public File getCurrentSource()

Shall return the file, that is serving as the source file of the currently prepared step.

Returns:

The current source file.

preserveCurrentSource

public void preserveCurrentSource()

When called the current temporary source file will not be deleted, when it is replaced by the current target in next step. This method must be called for each individual step and is only active for the current step.

getCurrentTarget

public File getCurrentTarget()
                      throws IOException

This shall return the current target file - if the current target file has not yet been initialized, a new temporary target file shall be prepared by calling this method.

Returns:

The current temporary target file (the source file of the next step).

Throws:

IOException - Shall be thrown if a temporary target file could not be created for some reason.

prepareNextOperation

public void prepareNextOperation()

This shall decide whether the current temporary source file shall be deleted or not. (the original source file however will never be deleted using this method.) It shall replace said source file with the current target file. This leads to the following behaviour: the result of the previous operation serves as the source of the next. The deletion of the source file can be prevented entirely by calling the "preserveCurrentSource()" method.

finalizeAndReset

public File finalizeAndReset(File targetFile,
                    File targetDirectory)
                      throws IOException

This shall both reset this instance to it's original state and shall copy the last produced result to either the given targetFile (using the exact name and path), or to the given targetDirectory (using the initially set targetName).

Parameters:

targetFile - The file the final result shall be copied to.

targetDirectory - The directory the target file shall be created in.

Returns:

The file the result has been published to.

Throws:

IOException - Shall be thrown if the target file could not be copied/created.

reset

public void reset()

This will drop the current context and will reset this instance to the original source document.

dropCurrentTarget

public void dropCurrentTarget()

Invalidates the current temporary target and will preserve the current source file for the next operation. This method should be called, when an Exception occurred during the processing of an operation.

tryPublish

public void tryPublish(Variable variable)

Attempts to publish the current group result to the Ant context using the given output var name.