public class ExperimentResultsExperimentStructure extends FilesProviderWithoutDirectory
A convenience method for commonly used prefixer settings when the output occurs in an experiment/$1/ filesystem structure where $1 is the experimentType
Constructor and Description |
---|
ExperimentResultsExperimentStructure() |
Modifier and Type | Method and Description |
---|---|
void |
checkMisconfigured(BeanInstanceMap defaultInstances)
Checks that a bean's properties conform to expectations.
|
List<File> |
create(InputManagerParameters parameters)
Creates or provides a list of files.
|
String |
getDatasetName()
The name of the experiment including version suffix
|
String |
getDatasetVersion()
A version-suffix appended to the dataset name extracted from the reg exp
|
RootedExperiment |
getExperiment() |
String |
getFileFilter()
Files to search for
|
int |
getMaxDirectoryDepth() |
String |
getRootNameForStructure()
If rootInStructure==true, the rootName is placed in the folder structure.
|
String |
getSubdirectory()
If non-empty than an additional subdirectory is appended as a suffix
${DATASET_NAME}_${DATASET_SUFFIX}/${SUBDIRECTORY}/
|
boolean |
isDatasetNameSubdirectory()
If true the datasetName is appended as a subdirectory e.g.
|
boolean |
isRecursive()
Whether to apply the search recursively or not
|
boolean |
isRootInStructure()
If true the directory structure is
ROOT/experiments/${ROOT_NAME}/${DATASET_NAME}_${DATASET_SUFFIX} If false, the directory
structure is ROOT/experiments/${DATASET_NAME}_${DATASET_SUFFIX}
|
void |
setDatasetName(String datasetName)
The name of the experiment including version suffix
|
void |
setDatasetNameSubdirectory(boolean datasetNameSubdirectory)
If true the datasetName is appended as a subdirectory e.g.
|
void |
setDatasetVersion(String datasetVersion)
A version-suffix appended to the dataset name extracted from the reg exp
|
void |
setExperiment(RootedExperiment experiment) |
void |
setFileFilter(String fileFilter)
Files to search for
|
void |
setMaxDirectoryDepth(int maxDirectoryDepth) |
void |
setRecursive(boolean recursive)
Whether to apply the search recursively or not
|
void |
setRootInStructure(boolean rootInStructure)
If true the directory structure is
ROOT/experiments/${ROOT_NAME}/${DATASET_NAME}_${DATASET_SUFFIX} If false, the directory
structure is ROOT/experiments/${DATASET_NAME}_${DATASET_SUFFIX}
|
void |
setRootNameForStructure(String rootNameForStructure)
If rootInStructure==true, the rootName is placed in the folder structure.
|
void |
setSubdirectory(String subdirectory)
If non-empty than an additional subdirectory is appended as a suffix
${DATASET_NAME}_${DATASET_SUFFIX}/${SUBDIRECTORY}/
|
rootDirectory
describeBean, describeChildren, duplicateBean, fields, findFieldsOfClass, getBeanName, getLocalPath, localise, toString
public ExperimentResultsExperimentStructure()
public void checkMisconfigured(BeanInstanceMap defaultInstances) throws BeanMisconfiguredException
AnchorBean
checkMisconfigured
in class AnchorBean<FilesProvider>
defaultInstances
- all available default instances if the DefaultInstance
annotation is usedBeanMisconfiguredException
- if the bean has not been configured properly as XMLpublic List<File> create(InputManagerParameters parameters) throws FilesProviderException
FilesProvider
create
in class FilesProvider
parameters
- parameters influencing how input-files are obtained.FilesProviderException
- if list of files cannot be successfully established.public String getDatasetName()
public void setDatasetName(String datasetName)
public String getDatasetVersion()
public void setDatasetVersion(String datasetVersion)
public RootedExperiment getExperiment()
public void setExperiment(RootedExperiment experiment)
public String getFileFilter()
public void setFileFilter(String fileFilter)
public boolean isRootInStructure()
public void setRootInStructure(boolean rootInStructure)
public String getRootNameForStructure()
public void setRootNameForStructure(String rootNameForStructure)
public String getSubdirectory()
public void setSubdirectory(String subdirectory)
public boolean isDatasetNameSubdirectory()
public void setDatasetNameSubdirectory(boolean datasetNameSubdirectory)
public boolean isRecursive()
public void setRecursive(boolean recursive)
public int getMaxDirectoryDepth()
public void setMaxDirectoryDepth(int maxDirectoryDepth)
Copyright © 2010–2023 Owen Feehan, ETH Zurich, University of Zurich, Hoffmann-La Roche. All rights reserved.