magpie.utility.interfaces

Interface Savable

All Known Implementing Classes:

AbstractNonlinearRegression, AbstractParsedNonlinearRegression, BaseClassifier, BaseModel, BaseRegression, BaseStatistics, ClassificationRegression, ClassificationStatistics, CompositeRegression, CompositionDataset, CoulombEwaldMatrixRegression, CoulombSineMatrixRegression, CrystalStructureDataset, CumulantExpansionClassifier, Dataset, ElementDataset, GuessMeanRegression, LASSORegression, LinearCorrectedRegression, MetallurgicalHeuristicRegression, MixingRuleRegression, MultiObjectiveRegression, MultiPropertyDataset, MultiPropertyRegression, NonlinearRegressionExpr, PhaseDiagramExclusionValidator, PolynomialRegression, PRDFRegression, PrototypeDataset, RandomGuessRegression, RegressionStatistics, ScikitLearnClassifier, ScikitLearnRegression, SimpleLinearModelExample, SingleGuessRegression, SplitClassifier, SplitModel, SplitRegression, StagedRegression, StructureKRRBasedRegression, TargetRegressionStatistics, WekaClassifier, WekaRegression

public interface Savable

Dictates commands that must be fulfilled for an object to be "savable".

Method Summary

Modifier and Type	Method and Description
java.lang.String	saveCommand(java.lang.String Basename, java.lang.String Format) Handles complicated saving commands.

Method Detail

saveCommand

java.lang.String saveCommand(java.lang.String Basename,
                             java.lang.String Format)
                      throws java.lang.Exception

Handles complicated saving commands.

Dev Note: Make sure to add save format to Javadoc. See Dataset as an example. Required format:

<save><p><b>format<b> - Description
<br>Optional room to talk more about format </save>

Parameters:

Basename - Name of file without extension

Format - Command specifying format in which to print

Returns:

Filename Path to output file

Throws:

java.lang.Exception - If command not understood