com.net2plan.interfaces.networkDesign

Interface IReport

All Superinterfaces:

com.net2plan.internal.IExternal

public interface IReport
extends com.net2plan.internal.IExternal

Contract that must be fulfilled such that a report can be run in Net2Plan.

Integration of new reports follows a similar scheme as for IAlgorithm.

Since:

0.2.0

Author:

Pablo Pavon-Marino, Jose-Luis Izquierdo-Zaragoza

Method Summary

Modifier and Type	Method and Description
String	executeReport(NetPlan netPlan, Map<String,String> reportParameters, Map<String,String> net2planParameters) Executes a report.
String	getDescription() Returns the description.
List<Triple<String,String,String>>	getParameters() Returns the list of required parameters, where the first item of each element is the parameter name, the second one is the parameter value, and the third one is the parameter description.
String	getTitle() Returns the title.

Method Detail

executeReport

String executeReport(NetPlan netPlan,
                     Map<String,String> reportParameters,
                     Map<String,String> net2planParameters)

Executes a report.

Parameters:

netPlan - A network plan

reportParameters -

A key-value map with specific report parameters.

Important: The algorithm developer is responsible to convert values from String to their respective type, and to check that values

net2planParameters - A key-value map with Net2Plan-wide configuration options

Returns:

A String with HTML code

Since:

0.2.0

getDescription

String getDescription()

Returns the description.

Specified by:

getDescription in interface com.net2plan.internal.IExternal

Returns:

Description

Since:

0.2.0

getParameters

List<Triple<String,String,String>> getParameters()

Returns the list of required parameters, where the first item of each element is the parameter name, the second one is the parameter value, and the third one is the parameter description.

It is possible to define type-specific parameters if the default value is set according to the following rules (but user is responsible of checking in its own code):

• If the default value is #select# and a set of space- or comma-separated values, the GUI will show a combobox with all the values, where the first one will be the selected one by default. For example: "#select# hops km" will allow choosing in the GUI between hops and km, where hops will be the default value.
• If the default value is #boolean# and true or false, the GUI will show a checkbox, where the default value will be true or false, depending on the value accompanying to #boolean#. For example: "#boolean# true" will show a checkbox marked by default.
• If the default value is #algorithm#, the GUI will prepare a new interface to select an algorithm as parameter. Three new fields will be added, including "_file", "_classname" and "_parameters" suffixes to the indicated parameter name, refer to the .class or .jar file where the code is located, the class name, and a set of parameters (pair of key-values separated by commas, where individual key and value are separated with an equal symbol. The same applies to reports (#report#), event generators (#eventGenerator#) and event processors (#eventProcessor#).

Specified by:

getParameters in interface com.net2plan.internal.IExternal

Returns:

List of specific parameters

Since:

0.2.0

getTitle

String getTitle()

Returns the title.

Returns:

Title

Since:

0.2.0