com.net2plan.interfaces.networkDesign

Interface IReport

public interface IReport

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

Since:

0.2.0

Author:

Pablo Pavon-Marino, Jose-Luis Izquierdo-Zaragoza

Method Summary

Methods

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

getDescription

String getDescription()

Returns the description.

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.

Returns:

List of specific parameters

Since:

0.2.0

getTitle

String getTitle()

Returns the title.

Returns:

Title

Since:

0.2.0

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