MetricParameterReader

java.lang.Object

es.uam.eps.ir.relison.grid.ParametersReader

es.uam.eps.ir.relison.grid.diffusion.metrics.MetricParameterReader

public class MetricParameterReader
extends ParametersReader

Class for reading the parameters for a diffusion metric.

Field Summary

Fields

Modifier and Type Field Description

private java.lang.String name
Name of the diffusion metric.

private Parameters values
Parameter values for the diffusion metric.
Constructor Summary

Constructors

Constructor Description

MetricParameterReader()

Method Summary

Modifier and Type	Method	Description
`java.lang.String`	`getName()`	Obtains the name of the diffusion metric.
`Parameters`	`getParams()`	Obtains the values of the parameters of the diffusion metric.
`java.lang.String`	`printMetric()`	Shows the configuration of a metric.
`void`	`readMetric(java.util.Map.Entry<java.lang.String,java.lang.Object> metric)`	Reads a metric.

Methods inherited from class es.uam.eps.ir.relison.grid.ParametersReader

readBoolean, readDouble, readInteger, readLong, readOrientation, readParameters, readParameterValues, readString

Methods inherited from class java.lang.Object

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

Field Details
- name
  
  private java.lang.String name
  
  Name of the diffusion metric.
- values
  
  private Parameters values
  
  Parameter values for the diffusion metric.
Constructor Details
- MetricParameterReader
  
  public MetricParameterReader()
Method Details
- readMetric
  
  public void readMetric(java.util.Map.Entry<java.lang.String,java.lang.Object> metric)
  
  Reads a metric.
  
  Parameters:
  
  metric - an entry representing the metric in the YAML file.
- getName
  
  public java.lang.String getName()
  
  Obtains the name of the diffusion metric.
  
  Returns:
  
  the name of the diffusion metric.
- getParams
  
  public Parameters getParams()
  
  Obtains the values of the parameters of the diffusion metric.
  
  Returns:
  
  the values of the parameters of the diffusion metric.
- printMetric
  
  public java.lang.String printMetric()
  
  Shows the configuration of a metric.
  
  Returns:
  
  a string containing the configuration of the diffusion metric.