Package org.anchoranalysis.bean.shared.path

Class RootPath

Object

AnchorBean<RootPath>

RootPath

public class RootPath
extends AnchorBean<RootPath>

Defines a root path.

This a directory in which files are read/written during analysis.

Analysis scripts may select different root-paths depending on how they are executed (e.g. locally writing to the filesystem during debugging on a single-file, but to a server for many files).

The name of a root must not be unique, but the combination of all fields should be unique i.e. several roots can have the same name, but should vary in their other settings.

Author:

Owen Feehan

Constructor Summary

Constructors

Constructor	Description
RootPath()

Method Summary

Modifier and Type	Method	Description
Path	asPath()	Exposes the path field as a Path.
protected boolean	canEqual(Object other)
boolean	equals(Object o)
String	getName()	The name of the root-path, which need not be unique in itself.
String	getPath()	A path on a file-system to the directory, that defines the root.
int	hashCode()
boolean	isDebug()	If true this root is preferred, when executing a job in debugging mode.
void	setDebug(boolean debug)	If true this root is preferred, when executing a job in debugging mode.
void	setName(String name)	The name of the root-path, which need not be unique in itself.
void	setPath(String path)	A path on a file-system to the directory, that defines the root.
SplitPath	split(Path path)	It splits the root portion of a path from the remainder.

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, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

RootPath

public RootPath()

Method Details

split

public SplitPath split(Path path)
                throws PathDifferenceException

It splits the root portion of a path from the remainder.

Parameters:

path - path to split.

Returns:

the split-path.

Throws:

PathDifferenceException - if the path cannot be matched against the root.

asPath

public Path asPath()

Exposes the path field as a Path.

Returns:

the path.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getName

public String getName()

The name of the root-path, which need not be unique in itself.

setName

public void setName(String name)

The name of the root-path, which need not be unique in itself.

getPath

public String getPath()

A path on a file-system to the directory, that defines the root.

setPath

public void setPath(String path)

A path on a file-system to the directory, that defines the root.

isDebug

public boolean isDebug()

If true this root is preferred, when executing a job in debugging mode.

setDebug

public void setDebug(boolean debug)

If true this root is preferred, when executing a job in debugging mode.