jasima.core.util.ResultSaver Maven / Gradle / Ivy
/*******************************************************************************
* Copyright (c) 2010-2015 Torsten Hildebrandt and jasima contributors
*
* This file is part of jasima, v1.2.
*
* jasima is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* jasima is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with jasima. If not, see
*
* This file can later is later converted to a final output format, so usually a
* subclass of {@code ResultSaver} is used, e.g., {@link ExcelSaver}.
*
* @author Torsten Hildebrandt
* @version
* "$Id: ResultSaver.java 550 2015-01-23 15:07:23Z [email protected] $"
*/
public class ResultSaver extends AbstractResultSaver {
public static final String SER_EXTENSION = ".jasResBin";
private static final long serialVersionUID = -6333367038346285154L;
// save intermediate results after 100 results
private static final int MAX_UNSAVED = 100;
// or save every 5 minutes
private static final long SAVE_INTERVAL = 5 * 60 * 1000;
protected static class ColumnData implements Serializable {
private static final long serialVersionUID = 3548750636065811872L;
public ColumnData(String name, boolean isParamColumn) {
super();
this.name = name;
this.isParamColumn = isParamColumn;
}
public final String name;
public final boolean isParamColumn;
public int sortedIndex;
}
protected static class CellData implements Serializable {
private static final long serialVersionUID = -1799390860125722470L;
public CellData(int colIdx, Object value) {
super();
this.colIdx = colIdx;
this.value = value;
}
public final int colIdx;
public final Object value;
}
// parameters
private boolean saveSubExperiments = true;
// fields used during run
private ObjectOutputStream tmpDatOut;
private int unsavedResults;
private long nextSaveTime;
private ArrayList columns;
@Override
protected void starting(Experiment e) {
columns = new ArrayList();
unsavedResults = 0;
nextSaveTime = 0;
String f = getActualResultBaseName() + SER_EXTENSION;
// create output stream
try {
tmpDatOut = new ObjectOutputStream(new BufferedOutputStream(
new FileOutputStream(f)));
} catch (IOException ex) {
throw new RuntimeException(ex);
}
}
@Override
public boolean checkBaseName(String base) {
if (new File(base + SER_EXTENSION).exists())
return false;
return true;
}
@Override
protected void multiExperimentCompletedTask(Experiment me, Experiment e,
Map runRes) {
if (isSaveSubExperiments())
saveExperiment(e, runRes);
}
@Override
protected void finished(Experiment e, Map results) {
// write marker for begin of main results
addCell(-3, null);
columns.clear();
saveExperiment(e, results);
try {
tmpDatOut.close();
} catch (IOException ex) {
throw new RuntimeException(ex);
}
}
protected void flushTmpFile() {
try {
tmpDatOut.flush();
tmpDatOut.reset();
} catch (IOException e) {
throw new RuntimeException(e);
}
}
private void addCell(int colIdx, Object value) {
value = convertValue(value);
try {
tmpDatOut.writeObject(new CellData(colIdx, value));
} catch (IOException e) {
throw new RuntimeException(e);
}
}
private int getColumnIndex(String s, boolean isParamColumn) {
int res = -1;
for (int i = 0; i < columns.size(); i++) {
ColumnData cd = columns.get(i);
if (cd.name.equals(s) && cd.isParamColumn == isParamColumn) {
res = i;
break;
}
}
// new column?
if (res < 0) {
res = columns.size();
ColumnData cd = new ColumnData(s, isParamColumn);
addCell(-2, cd);
columns.add(cd);
}
return res;
}
private void saveExperiment(Experiment e, Map runRes) {
// save parameters
saveExperiment("", e, true);
// save results
saveData(runRes);
// write marker for end of record
addCell(-1, null);
unsavedResults++;
if (unsavedResults >= MAX_UNSAVED
|| System.currentTimeMillis() > nextSaveTime) {
flushTmpFile();
unsavedResults = 0;
nextSaveTime = System.currentTimeMillis() + SAVE_INTERVAL;
}
}
private void saveData(Map res) {
for (String name : res.keySet()) {
Object value = res.get(name);
if (value != null && value instanceof Experiment) {
saveExperiment(name + '.', (Experiment) value, false);
} else {
int colIdx = getColumnIndex(name, false);
addCell(colIdx, value);
}
}
}
private void saveExperiment(String prefix, Experiment e, boolean isParam) {
// write experiment's class name as a separate column
String cn = prefix + "className";
int cnIdx = getColumnIndex(cn, isParam);
addCell(cnIdx, e.getClass().getName());
// write all properties
Map ps = e.getPropsWithValues();
for (String s : ps.keySet()) {
Object v = ps.get(s);
if (v != null && v instanceof Experiment) {
saveExperiment(prefix + s + '.', (Experiment) v, isParam);
} else {
int colIdx = getColumnIndex(prefix + s, isParam);
addCell(colIdx, v);
}
}
}
private Object convertValue(Object v) {
// convert everything not Serializable to a String
if (v == null) {
return "null";
} else if (v.getClass().isArray()) {
// an array which is not Serializable, i.e., components are not
// Serializable
return Util.arrayToString(v);
} else if (v instanceof Serializable) {
return v;
} else
return v.toString();
}
public boolean isSaveSubExperiments() {
return saveSubExperiments;
}
/**
* Whether to save parameters and results of sub-experiments.
*
* @param saveSubExperiments
* @see MultipleReplicationExperiment
* @see FullFactorialExperiment
*/
public void setSaveSubExperiments(boolean saveSubExperiments) {
this.saveSubExperiments = saveSubExperiments;
}
}