org.daisy.pipeline.client.filestorage

Class JobStorage

java.lang.Object

org.daisy.pipeline.client.filestorage.JobStorage

public class JobStorage
extends Object

Constructor Summary

Constructors

Constructor and Description
JobStorage(Job job, File jobStorage, JobStorage otherJobContext, String id) Create a JobStorage associated with the provided Job, and copy the context from another job.
JobStorage(Job job, File jobStorage, String id) Create a JobStorage associated with the provided Job.

Method Summary

Modifier and Type	Method and Description
void	addContextFile(File file, String contextPath) Add the file to the context.
void	delete() Deletes the job including all its files from the job storage.
boolean	existsInContext(String contextPath) Test whether the given path exists in the context.
File	getContextDir() Returns the root directory for the context files.
File	getContextFile(String contextPath) Get the path in context associated with the File.
String	getContextFilePath(File file) Get the file associated with the given context path.
String	getStorageId()
boolean	isDirectoryInContext(String contextPath) Test whether the given path exists as a directory in the context.
boolean	isFileInContext(String contextPath) Test whether the given path exists as a file in the context.
void	lazyLoad() Load the job.
static List<String>	listJobs(File jobStorage) List all job IDs that are stored in the given job storage folder.
static Job	loadJob(String storageId, File jobStorageDir) Load a job from the job storage folder.
File	makeContextZip() Bundles all context files up as a ZIP archive and returns it.
void	removeContextFile(String contextPath) Remove the file from the context.
void	save() Save the job to the job storage.
void	save(boolean moveFiles) Save the job to the job storage.

Methods inherited from class java.lang.Object

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

Constructor Detail

JobStorage

public JobStorage(Job job,
                  File jobStorage,
                  String id)

Create a JobStorage associated with the provided Job.

Parameters:

job - job

jobStorage - job storage directory

JobStorage

public JobStorage(Job job,
                  File jobStorage,
                  JobStorage otherJobContext,
                  String id)

Create a JobStorage associated with the provided Job, and copy the context from another job.

Parameters:

job - job

jobStorage - job storage directory

Method Detail

lazyLoad

public void lazyLoad()

Load the job. Will be triggered when the caller tries to read from a job.

save

public void save()

Save the job to the job storage. (i.e. stores the job XML) By default, will move the files instead of copying them.

save

public void save(boolean moveFiles)

Save the job to the job storage.

Parameters:

moveFiles - if set to false, will make copies of the context files instead of moving them.

listJobs

public static List<String> listJobs(File jobStorage)

List all job IDs that are stored in the given job storage folder.

Parameters:

jobStorage - the directory where jobs are stored

Returns:

a list of all the job IDs in the job storage

loadJob

public static Job loadJob(String storageId,
                          File jobStorageDir)

Load a job from the job storage folder.

Parameters:

jobId -

jobStorageDir -

Returns:

addContextFile

public void addContextFile(File file,
                           String contextPath)

Add the file to the context.

Parameters:

file -

argument -

removeContextFile

public void removeContextFile(String contextPath)

Remove the file from the context. The file will also be removed from all attached arguments.

Parameters:

file -

argument -

getContextFilePath

public String getContextFilePath(File file)

Get the file associated with the given context path.

Parameters:

contextPath - the context path for the file

Returns:

the context file with the given path

getContextFile

public File getContextFile(String contextPath)

Get the path in context associated with the File.

Parameters:

file - the File object

Returns:

the associated path as a string

getContextDir

public File getContextDir()

Returns the root directory for the context files.

Returns:

the root directory for the context files

makeContextZip

public File makeContextZip()

Bundles all context files up as a ZIP archive and returns it.

Returns:

the zip file

existsInContext

public boolean existsInContext(String contextPath)

Test whether the given path exists in the context. The path must be relative and can refer to either a file or a directory.

Parameters:

contextPath -

Returns:

true if the path exists as either a file or directory in the context.

isFileInContext

public boolean isFileInContext(String contextPath)

Test whether the given path exists as a file in the context.

Parameters:

contextPath -

Returns:

true if the path exists as a file in the context.

isDirectoryInContext

public boolean isDirectoryInContext(String contextPath)

Test whether the given path exists as a directory in the context.

Parameters:

contextPath -

Returns:

true if the path exists as a directory in the context.

delete

public void delete()

Deletes the job including all its files from the job storage.

getStorageId

public String getStorageId()