stella.util

Class FileRanking

java.lang.Object

util.PropertyContainer

stella.util.FileRanking

All Implemented Interfaces:

Cloneable, TargetProviderDepending, RankingMonitor, PropertySupplying

public class FileRanking
extends PropertyContainer
implements RankingMonitor

Simple ranking monitor that puts all its data into files.

Author:

wooz

See Also:

SchedulerRank

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FileRanking.Inspect

Field Summary

Fields

Modifier and Type	Field and Description
private TargetProviding<? extends TargetDefinition>	all
private static String	DEFMERITEXT The key matching to the target merit save file extension.
private static String	DEFMERITHEAD The key matching to the target merit save file header.
private static String	DEFOBSERVEEXT The key matching to the target constraint fail file extension.
private static String	DEFOBSERVEHEAD The key matching to the target constraint fail file header.
private static boolean	DEFSKIPENGINEERING Per default, also record engineering targets.
static String	KEY_MERITDIR The key matching to the target merit save dir.
static String	KEY_MERITEXT The key matching to the target merit save file extension.
static String	KEY_MERITHEAD The key matching to the target merit save file header.
static String	KEY_OBSERVEDIR The key matching to the target constraint fail dir.
static String	KEY_OBSERVEEXT The key matching to the target constraint fail file extension.
static String	KEY_OBSERVEHEAD The key matching to the target constraint fail file header.
static String	KEY_SKIPENGINEERING If true, engineering targets are skipped.

Fields inherited from class util.PropertyContainer

KEY_LISTSEPARATOR, KEY_MAPKEYVALUECHAR, KEY_MAPSEPARATOR

Fields inherited from interface util.PropertySupplying

CONFIG, KEY_CLASS

Constructor Summary

Constructors

Constructor and Description
FileRanking(Map<String,String> props)

Method Summary

Modifier and Type	Method and Description
boolean	recordCurrent(long ms, String unique) If either the merit file and/or the observe file is given, we save the last merits or the last prohibiting constraint in a unique-enhanced save file.
void	registerProvider(TargetProviding<? extends TargetDefinition> t) Registers the target provider.
static Map<Long,Map<String,Serializable>>	restore(File from)
private boolean	save(Map<String,? extends Serializable> map, long ms, File to) Save the time as a long and serializes the provided mapping into the file.
private boolean	saveConstraint(long ms, File to) Tries to save the denied-by-constraint for the given time.
private boolean	saveMerit(long ms, File to) Tries to save the merit-mapping for the given time

Methods inherited from class util.PropertyContainer

augment, augment, augment, augment, augment, clone, defaultBoolean, defaultChar, defaultDouble, defaultFloat, defaultInt, defaultLong, defaultObject, defaultObject, defaultProperties, defaultProperty, getAsBoolean, getAsChar, getAsDouble, getAsEnums, getAsFloat, getAsInt, getAsList, getAsLong, getAsMap, getAsMap, getAsObject, getAsObject, getProperties, getProperty, has, initProperties, isNew, parseObject, parseObject, reload, reload, removeProperty, requires, rescanned, setObject, setProperties, setProperty, stringProperties, toString

Methods inherited from class java.lang.Object

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

Field Detail

KEY_MERITDIR

public static final String KEY_MERITDIR

The key matching to the target merit save dir. Records on define.

See Also:

Constant Field Values

KEY_MERITHEAD

public static final String KEY_MERITHEAD

The key matching to the target merit save file header.

See Also:

Constant Field Values

KEY_MERITEXT

public static final String KEY_MERITEXT

The key matching to the target merit save file extension.

See Also:

Constant Field Values

KEY_OBSERVEDIR

public static final String KEY_OBSERVEDIR

The key matching to the target constraint fail dir. Record on define.

See Also:

Constant Field Values

KEY_OBSERVEHEAD

public static final String KEY_OBSERVEHEAD

The key matching to the target constraint fail file header.

See Also:

Constant Field Values

KEY_OBSERVEEXT

public static final String KEY_OBSERVEEXT

The key matching to the target constraint fail file extension.

See Also:

Constant Field Values

KEY_SKIPENGINEERING

public static final String KEY_SKIPENGINEERING

If true, engineering targets are skipped.

See Also:

Constant Field Values

DEFMERITHEAD

private static final String DEFMERITHEAD

The key matching to the target merit save file header.

See Also:

Constant Field Values

DEFMERITEXT

private static final String DEFMERITEXT

The key matching to the target merit save file extension.

See Also:

Constant Field Values

DEFOBSERVEHEAD

private static final String DEFOBSERVEHEAD

The key matching to the target constraint fail file header.

See Also:

Constant Field Values

DEFOBSERVEEXT

private static final String DEFOBSERVEEXT

The key matching to the target constraint fail file extension.

See Also:

Constant Field Values

DEFSKIPENGINEERING

private static final boolean DEFSKIPENGINEERING

Per default, also record engineering targets.

See Also:

Constant Field Values

all

private TargetProviding<? extends TargetDefinition> all

Constructor Detail

FileRanking

public FileRanking(Map<String,String> props)

Parameters:

props -

Method Detail

registerProvider

public void registerProvider(TargetProviding<? extends TargetDefinition> t)

Registers the target provider. Will be queried on saves.

Specified by:

registerProvider in interface TargetProviderDepending

See Also:

TargetProviderDepending.registerProvider(stella.TargetProviding)

recordCurrent

public boolean recordCurrent(long ms,
                             String unique)

If either the merit file and/or the observe file is given, we save the last merits or the last prohibiting constraint in a unique-enhanced save file.

Specified by:

recordCurrent in interface RankingMonitor

Parameters:

ms - The time the scheduler was invoked.

unique - The unique-ID of the current pick

Returns:

True if recording was successful.

See Also:

RankingMonitor.recordCurrent(long, java.lang.String)

saveMerit

private boolean saveMerit(long ms,
                          File to)

Tries to save the merit-mapping for the given time

saveConstraint

private boolean saveConstraint(long ms,
                               File to)

Tries to save the denied-by-constraint for the given time.

save

private boolean save(Map<String,? extends Serializable> map,
                     long ms,
                     File to)

Save the time as a long and serializes the provided mapping into the file.

restore

public static Map<Long,Map<String,Serializable>> restore(File from)