public class Report_availability extends Object implements com.net2plan.interfaces.networkDesign.IReport
|
Constructor and Description |
---|
Report_availability() |
Modifier and Type | Method and Description |
---|---|
String |
executeReport(com.net2plan.interfaces.networkDesign.NetPlan netPlan,
Map<String,String> reportParameters,
Map<String,String> net2planParameters)
Executes a report.
|
String |
getDescription()
Returns the description.
|
List<com.net2plan.utils.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.
|
public Report_availability()
public String executeReport(com.net2plan.interfaces.networkDesign.NetPlan netPlan, Map<String,String> reportParameters, Map<String,String> net2planParameters)
com.net2plan.interfaces.networkDesign.IReport
executeReport
in interface com.net2plan.interfaces.networkDesign.IReport
netPlan
- A network planreportParameters
- 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 optionsString
with HTML codepublic String getDescription()
com.net2plan.interfaces.networkDesign.IReport
getDescription
in interface com.net2plan.interfaces.networkDesign.IReport
getDescription
in interface com.net2plan.internal.IExternal
public List<com.net2plan.utils.Triple<String,String,String>> getParameters()
com.net2plan.interfaces.networkDesign.IReport
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):
.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#).getParameters
in interface com.net2plan.interfaces.networkDesign.IReport
getParameters
in interface com.net2plan.internal.IExternal
public String getTitle()
com.net2plan.interfaces.networkDesign.IReport
getTitle
in interface com.net2plan.interfaces.networkDesign.IReport