Package org.anchoranalysis.feature.io.results

Class FeatureOutputMetadata

Object

FeatureOutputMetadata

public class FeatureOutputMetadata
extends Object

Information needed for the outputting differnt types of feature-table CSV files.

e.g. headers, the output-name etc.

Two types of CSV files may be written:

• non-aggregated (using the features directly on the underlying entities)
• aggregated (aggregating the results from the above)

Author:

Owen Feehan

Constructor Summary

Constructors

Constructor	Description
FeatureOutputMetadata(LabelHeaders labelHeaders, FeatureNameList featureNamesNonAggregated, FeatureOutputNames outputNames)	Creates a new FeatureOutputMetadata instance.

Method Summary

Modifier and Type	Method	Description
Optional<FeatureCSVMetadataForOutput>	csvAggregated(FeatureNameList featureNamesAggregated)	Specific metadata for writing an aggregated CSV file.
FeatureCSVMetadataForOutput	csvNonAggregated()	Specific metadata for writing a non-aggregated CSV file.
FeatureNameList	featureNamesNonAggregated()	Names of each feature in the feature columns, for non-aggregated features.
LabelHeaders	labelHeaders()	Headers for the CSV File.
FeatureOutputNames	outputNames()	Names for any outputs produced by LabelledResultsCollector.

Methods inherited from class java.lang.Object

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

Constructor Details

FeatureOutputMetadata

public FeatureOutputMetadata(LabelHeaders labelHeaders,
 FeatureNameList featureNamesNonAggregated,
 FeatureOutputNames outputNames)

Creates a new FeatureOutputMetadata instance.

Parameters:

labelHeaders - Headers for the CSV File.

featureNamesNonAggregated - Names of each feature in the feature columns, for non-aggregated features.

outputNames - Names for any outputs produced by LabelledResultsCollector.

Method Details

csvNonAggregated

public FeatureCSVMetadataForOutput csvNonAggregated()

Specific metadata for writing a non-aggregated CSV file.

Returns:

a newly created FeatureCSVMetadataForOutput.

csvAggregated

public Optional<FeatureCSVMetadataForOutput> csvAggregated(FeatureNameList featureNamesAggregated)

Specific metadata for writing an aggregated CSV file.

Parameters:

featureNamesAggregated - the feature-names to use for the aggregated CSV file (which usually differ from featureNamesNonAggregate.

Returns:

a newly created FeatureCSVMetadataForOutput.

labelHeaders

public LabelHeaders labelHeaders()

Headers for the CSV File.

featureNamesNonAggregated

public FeatureNameList featureNamesNonAggregated()

Names of each feature in the feature columns, for non-aggregated features.

outputNames

public FeatureOutputNames outputNames()

Names for any outputs produced by LabelledResultsCollector.