Package org.anchoranalysis.plugin.io.bean.file.path.prefixer

Class HomeSubdirectory

Object

AnchorBean<PathPrefixer>

PathPrefixer

HomeSubdirectory

public class HomeSubdirectory
extends PathPrefixer

Constructor Summary

Constructors

Constructor	Description
HomeSubdirectory()

Method Summary

Modifier and Type	Method	Description
String	getDirectory()	A relative-path (to the user home directory) which is used as an output directory
DirectoryWithPrefix	outFilePrefix(NamedPath path, Optional<String> expName, PathPrefixerContext context)	Provides a prefix which can be prepended to all output files.
DirectoryWithPrefix	rootDirectoryPrefix(Optional<String> expName, PathPrefixerContext context)	Provides a prefix that becomes the root-folder.
void	setDirectory(String directory)	A relative-path (to the user home directory) which is used as an output directory

Methods inherited from class org.anchoranalysis.io.output.bean.path.prefixer.PathPrefixer

resolvePath, resolvePath

Methods inherited from class org.anchoranalysis.bean.AnchorBean

checkMisconfigured, describeBean, describeChildren, duplicateBean, fields, findFieldsOfClass, getBeanName, getLocalPath, localise, toString

Methods inherited from class java.lang.Object

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

Constructor Details

HomeSubdirectory

public HomeSubdirectory()

Method Details

outFilePrefix

public DirectoryWithPrefix outFilePrefix(NamedPath path,
 Optional<String> expName,
 PathPrefixerContext context)
                                  throws PathPrefixerException

Description copied from class: PathPrefixer

Provides a prefix which can be prepended to all output files. The prefix should be an absolute path.

Specified by:

outFilePrefix in class PathPrefixer

Parameters:

path - an input to derive a prefix from

expName - if defined, an identifier for the experiment, to be included in the directory root.

context - the context in which prefixing of paths occurs.

Returns:

a directory with an associated prefix.

Throws:

PathPrefixerException - if unable to successfully determine a prefix.

rootDirectoryPrefix

public DirectoryWithPrefix rootDirectoryPrefix(Optional<String> expName,
 PathPrefixerContext context)
                                        throws PathPrefixerException

Description copied from class: PathPrefixer

Provides a prefix that becomes the root-folder. The prefix should be an absolute path.

Specified by:

rootDirectoryPrefix in class PathPrefixer

Parameters:

expName - if defined, an identifier for the experiment, to be included in the directory root.

context - the context in which prefixing of paths occurs.

Returns:

a directory with an associated prefix.

Throws:

PathPrefixerException - if unable to successfully determine a prefix.

getDirectory

public String getDirectory()

A relative-path (to the user home directory) which is used as an output directory

setDirectory

public void setDirectory(String directory)

A relative-path (to the user home directory) which is used as an output directory