slib.sml.sm.core.metrics.ic.utils
Class ICconf

java.lang.Object
  extended by slib.utils.i.Conf
      extended by slib.sml.sm.core.metrics.ic.utils.ICconf
Direct Known Subclasses:
IC_Conf_Corpus, IC_Conf_Topo

public abstract class ICconf
extends slib.utils.i.Conf

Author:
Harispe Sébastien

Field Summary
 String className
          Class name of the computation method.
 String flag
          Flag corresponding to the IC computation method.
 String id
          ID used to represent the IC.
 boolean isCorpusBased
          Define if the IC is corpus-based (extrinsic).
 String label
          label used to plot IC values.
 
Constructor Summary
ICconf(String icFlag)
          Builder of the IC configuration.
ICconf(String id, String label, String flag)
          Advanced builder of an instance of IC configuration.
 
Method Summary
 boolean equals(Object obj)
           
 String getClassName()
          Getter of the class name.
 String getFlag()
          Getter of the flag.
 String getId()
          Getter of the id.
 String getLabel()
          Getter of the label.
 int hashCode()
           
 boolean isCorpusBased()
           
 String toString()
           
 
Methods inherited from class slib.utils.i.Conf
addParam, containsParam, containsParams, getParam, getParamAsDouble, getParamAsString, getParams, removeParam, setParams
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

id

public String id
ID used to represent the IC.


label

public String label
label used to plot IC values.


flag

public String flag
Flag corresponding to the IC computation method.


className

public String className
Class name of the computation method.


isCorpusBased

public boolean isCorpusBased
Define if the IC is corpus-based (extrinsic).

Constructor Detail

ICconf

public ICconf(String icFlag)
       throws slib.utils.ex.SLIB_Ex_Critic
Builder of the IC configuration.

Parameters:
icFlag - the flag of the IC
Throws:
slib.utils.ex.SLIB_Ex_Critic

ICconf

public ICconf(String id,
              String label,
              String flag)
       throws slib.utils.ex.SLIB_Ex_Critic
Advanced builder of an instance of IC configuration.

Parameters:
id - the ID used to represent the IC (must be unique)
label - the label used to plot IC values
flag - the flag corresponding to the IC
Throws:
slib.utils.ex.SLIB_Ex_Critic
Method Detail

getId

public String getId()
Getter of the id.

Returns:
the id associated to the configuration

getLabel

public String getLabel()
Getter of the label.

Returns:
the label associated to the configuration.

getFlag

public String getFlag()
Getter of the flag.

Returns:
the flag associated to the configuration.

getClassName

public String getClassName()
Getter of the class name.

Returns:
the class name associated to the configuration.

isCorpusBased

public boolean isCorpusBased()
Returns:
true if the IC configuration is associated to an IC which is corpus based.

hashCode

public int hashCode()
Overrides:
hashCode in class Object

equals

public boolean equals(Object obj)
Overrides:
equals in class Object

toString

public String toString()
Overrides:
toString in class slib.utils.i.Conf


Copyright © 2013. All Rights Reserved.