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

Class FromDescriptiveName

Object

AnchorBean<PathPrefixer>

PathPrefixer

PathPrefixerAvoidResolve

FromDescriptiveName

public class FromDescriptiveName
extends PathPrefixerAvoidResolve

The prefixer uses a combination of a out-path-prefix and the descriptive-name of inputs to create an output prefix.

Author:

Owen Feehan

Constructor Summary

Constructors

Constructor	Description
FromDescriptiveName()

Method Summary

Modifier and Type	Method	Description
boolean	isSuppressDirectories()	If true, any directory separators in the identifier in a descriptive-name are replaced by underscores.
DirectoryWithPrefix	outFilePrefixFromPath(NamedPath path, Path root, PathPrefixerContext context)	Determines the out-file prefix from a path.
void	setSuppressDirectories(boolean suppressDirectories)	If true, any directory separators in the identifier in a descriptive-name are replaced by underscores.

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

getPrefix, outFilePrefix, outFilePrefixAvoidResolve, rootDirectoryPrefix, rootDirectoryPrefixAvoidResolve, setPrefix

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

FromDescriptiveName

public FromDescriptiveName()

Method Details

outFilePrefixFromPath

public DirectoryWithPrefix outFilePrefixFromPath(NamedPath path,
 Path root,
 PathPrefixerContext context)

Description copied from class: PathPrefixerAvoidResolve

Determines the out-file prefix from a path.

Specified by:

outFilePrefixFromPath in class PathPrefixerAvoidResolve

Parameters:

path - path to calculate prefix from with associated descriptive-name

root - root of prefix

context - the path-prefixer context.

Returns:

folder/filename for prefixing.

isSuppressDirectories

public boolean isSuppressDirectories()

If true, any directory separators in the identifier in a descriptive-name are replaced by underscores.

If false, this may still occur if it is requested in the PathPrefixerContext.

setSuppressDirectories

public void setSuppressDirectories(boolean suppressDirectories)

If true, any directory separators in the identifier in a descriptive-name are replaced by underscores.

If false, this may still occur if it is requested in the PathPrefixerContext.