org.dllearner.core.options
Class StringTupleListConfigOption

java.lang.Object
  org.dllearner.core.options.ConfigOption<List<StringTuple>>
      org.dllearner.core.options.StringTupleListConfigOption

public class StringTupleListConfigOption
extends ConfigOption<List<StringTuple>>

A list if string tuples, for instance for specifying several parameters or replacement rules.

Author:

Jens Lehmann

Constructor Summary

StringTupleListConfigOption(String name, String description)

StringTupleListConfigOption(String name, String description, List<StringTuple> defaultValue)

StringTupleListConfigOption(String name, String description, List<StringTuple> defaultValue, boolean mandatory, boolean requiresInit)

Method Summary

boolean	checkType(Object object) Checks whether the object has the correct type to be used as a value for this option (this method is necessary, because generic information is erased at runtime in Java).
SortedSet<String>	getJavaImports() TODO Method should be removed and a mapping table in ConfigJavaGenerator created instead.
String	getValueFormatting(List<StringTuple> value) Get a formatted value to put into configuration file.
String	getValueTypeAsJavaString()
boolean	isValidValue(List<StringTuple> value) Checks whether the value is valid, e.g. passing 1985 as integer value for an option, which requires values between 0 and 1, is not valid.

Methods inherited from class org.dllearner.core.options.ConfigOption

getAllowedValuesDescription, getDefaultValue, getDefaultValueInJava, getDescription, getJavaDocString, getName, isMandatory, requiresInit, setDefaultValue, setMandatory, setRequiresInit, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

StringTupleListConfigOption

public StringTupleListConfigOption(String name,
                                   String description,
                                   List<StringTuple> defaultValue,
                                   boolean mandatory,
                                   boolean requiresInit)

StringTupleListConfigOption

public StringTupleListConfigOption(String name,
                                   String description,
                                   List<StringTuple> defaultValue)

StringTupleListConfigOption

public StringTupleListConfigOption(String name,
                                   String description)

Method Detail

getValueTypeAsJavaString

public String getValueTypeAsJavaString()

Specified by:

getValueTypeAsJavaString in class ConfigOption<List<StringTuple>>

getJavaImports

public SortedSet<String> getJavaImports()

Description copied from class: ConfigOption

TODO Method should be removed and a mapping table in ConfigJavaGenerator created instead. gets java imports

Overrides:

getJavaImports in class ConfigOption<List<StringTuple>>

Returns:

Java imports.

checkType

public boolean checkType(Object object)

Description copied from class: ConfigOption

Checks whether the object has the correct type to be used as a value for this option (this method is necessary, because generic information is erased at runtime in Java).

Specified by:

checkType in class ConfigOption<List<StringTuple>>

Parameters:

object - The object to check.

Returns:

True of the type is correct, false otherwise.

isValidValue

public boolean isValidValue(List<StringTuple> value)

Description copied from class: ConfigOption

Checks whether the value is valid, e.g. passing 1985 as integer value for an option, which requires values between 0 and 1, is not valid.

Specified by:

isValidValue in class ConfigOption<List<StringTuple>>

Parameters:

value - A value for the option.

Returns:

True if the value is valid and false otherwise.

getValueFormatting

public String getValueFormatting(List<StringTuple> value)

Description copied from class: ConfigOption

Get a formatted value to put into configuration file.

Specified by:

getValueFormatting in class ConfigOption<List<StringTuple>>

Parameters:

value - Option value.

Returns:

A string to put into a conf file.