org.moeaframework.analysis.sensitivity
Class ExtractData

java.lang.Object
  org.moeaframework.util.CommandLineUtility
      org.moeaframework.analysis.sensitivity.ExtractData

public class ExtractData
extends CommandLineUtility

Command line utility for extracting data from a result file. The data that can be extracted includes any properties by providing its full name, or any of the following metrics if given the designated +option.

• +hypervolume for Hypervolume
• +generational for GenerationalDistance
• +inverted for InvertedGenerationalDistance
• +epsilon for AdditiveEpsilonIndicator
• +error for MaximumParetoFrontError
• +spacing for Spacing
• +contribution for Contribution
• +R1 for R1Indicator
• +R2 for R2Indicator
• +R3 for R3Indicator

Constructor Summary

ExtractData()
Constructs the command line utility for extracting data from a result file.

Method Summary

protected String	evaluate(String command, ResultEntry entry, org.apache.commons.cli.CommandLine commandLine) Evaluates the special commands.
org.apache.commons.cli.Options	getOptions() Returns the options made available by this command line utility.
static void	main(String[] args) Starts the command line utility for extracting data from a result file.
void	run(org.apache.commons.cli.CommandLine commandLine) Runs this command line utility with the specified command line arguments.

Methods inherited from class org.moeaframework.util.CommandLineUtility

getCommandString, setCommandString, start

Methods inherited from class java.lang.Object

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

Constructor Detail

ExtractData

public ExtractData()

Constructs the command line utility for extracting data from a result file.

Method Detail

getOptions

public org.apache.commons.cli.Options getOptions()

Description copied from class: CommandLineUtility

Returns the options made available by this command line utility. The base implementation automatically provides the -h,--help option. Implementations overriding this method and begin with a call to super.getOptions().

Overrides:

getOptions in class CommandLineUtility

Returns:

the options made available by this command line utility

run

public void run(org.apache.commons.cli.CommandLine commandLine)
         throws Exception

Description copied from class: CommandLineUtility

Runs this command line utility with the specified command line arguments.

Specified by:

run in class CommandLineUtility

Parameters:

commandLine - the command line arguments

Throws:

Exception

evaluate

protected String evaluate(String command,
                          ResultEntry entry,
                          org.apache.commons.cli.CommandLine commandLine)
                   throws IOException

Evaluates the special commands. The + prefix should be removed prior to calling this method. An OptionCompleter is used to auto-complete the commands, so only the unique prefix must be provided.

Parameters:

command - the command identifier

entry - the entry in the result file

commandLine - the command line options

Returns:

the value of the special command

Throws:

FrameworkException - if the command is not supported

IOException - if an I/O error occurred

main

public static void main(String[] args)
                 throws Exception

Starts the command line utility for extracting data from a result file.

Parameters:

args - the command line arguments

Throws:

Exception - if an error occurred