Merged in feature/refactor_name_api (pull request #2)

getName and setNAme overridings

Approved-by: Daniel Godard <daniel.godard@decisionbrain.com>

Author: guillaume-vantroeyen

src/examples/scala/com/decisionbrain/cplex/cp/SchedCalendar.scala

@@ -92,7 +92,7 @@ object SchedCalendar {
     val results = for ((rd, index) <- houses.zipWithIndex) yield makeHouse(index, rd)
 
     endVars = results.map(_._1)
-    allTaskVars = results.flatMap(_._2).map(v => (v.getName().getOrElse(""), v)).toMap
+    allTaskVars = results.flatMap(_._2).map(v => (v.getName.getOrElse(""), v)).toMap
     joeTaskVars = results.flatMap(_._3)
     jimTaskVars = results.flatMap(_._4)
 

src/examples/scala/com/decisionbrain/cplex/mp/DietMultiObj.scala

@@ -182,9 +182,9 @@ object DietMultiObj {
 
     // Print the objective value(s).
 
-    val costName = cost.getName()
+    val costName = cost.getName
     val costValue = model.getValue(cost.getNumExpr())
-    val varietyName = variety.getName()
+    val varietyName = variety.getName
     val varietyValue = model.getValue(variety.getNumExpr())
     println(s"Solution value 0 ($costName) = $costValue")
     println(s"Solution value 1 ($varietyName) = $varietyValue")

src/main/scala/com/decisionbrain/cplex/Addable.scala

@@ -16,14 +16,17 @@ trait Addable {
     *
     * @return the name of the object
     */
-  def getName: Option[String]
+  def getName: Option[String] = Option(getIloAddable().getName)
 
   /**
     * Set the name of the model addable object.
     *
     * @param name is the name of the object
     */
-  def setName(name: String)
+  def setName(name: String): Addable = {
+    getIloAddable().setName(name)
+    this
+  }
 
   /**
     * Returns the CPLEX addable object.

src/main/scala/com/decisionbrain/cplex/Constraint.scala

@@ -23,20 +23,6 @@ class Constraint(c: IloConstraint)(implicit modeler: Modeler) extends IntExpr(c)
     */
   def getIloConstraint(): IloConstraint = c
 
-  /**
-    * Returns the name of model addable object.
-    *
-    * @return the name of the object
-    */
-  override def getName(): Option[String] = Option(c.getName())
-
-  /**
-    * Set the name of the model addable object.
-    *
-    * @param name is the name of the object
-    */
-  override def setName(name: String): Unit = c.setName(name)
-
   /**
     * Returns the CPLEX addable object.
     *

src/main/scala/com/decisionbrain/cplex/IntVar.scala

@@ -31,19 +31,6 @@ class IntVar(v: IloIntVar)(implicit modeler: Modeler) extends IntExpr(v) with Ad
     */
   def getType(): IloNumVarType = v.getType
 
-  /**
-    * Return the name of the numeric variable
-    * @return the name
-    */
-  def getName(): Option[String] = Option(v.getName())
-
-  /**
-    * Set the name of the numeric variable.
-    *
-    * @param name is the name of the numeric variable
-    */
-  def setName(name: String) = v.setName(name)
-
   /**
     * Return the upper bound of the numeric variable.
     *
@@ -121,7 +108,7 @@ class IntVar(v: IloIntVar)(implicit modeler: Modeler) extends IntExpr(v) with Ad
     */
   override def toString() : String = {
     val strBuilder = new StringBuilder()
-    if (getName().isDefined) strBuilder.append(getName().get)
+    if (getName.isDefined) strBuilder.append(getName.get)
     strBuilder.append("[")
     val vmin = getMin()
     val vmax = getMax()

src/main/scala/com/decisionbrain/cplex/NumVar.scala

@@ -23,19 +23,6 @@ class NumVar(v: IloNumVar)(implicit modeler: Modeler) extends NumExpr(v) with Ad
     */
   def getType(): IloNumVarType = v.getType
 
-  /**
-    * Return the name of the numeric variable
-    * @return the name
-    */
-  def getName(): Option[String] = Option(v.getName())
-
-  /**
-    * Set the name of the numeric variable.
-    *
-    * @param name is the name of the numeric variable
-    */
-  def setName(name: String) = v.setName(name)
-
   /**
     * Return the upper bound of the numeric variable.
     *
@@ -85,7 +72,7 @@ class NumVar(v: IloNumVar)(implicit modeler: Modeler) extends NumExpr(v) with Ad
     */
   override def toString() : String = {
     val strBuilder = new StringBuilder()
-    if (getName().isDefined) strBuilder.append(getName().get)
+    if (getName.isDefined) strBuilder.append(getName.get)
     strBuilder.append("[")
     val vmin = getLB()
     val vmax = getUB()

src/main/scala/com/decisionbrain/cplex/Objective.scala

@@ -16,20 +16,6 @@ import ilog.concert._
   */
 class Objective(o: IloObjective)(implicit modeler: Modeler) extends Addable {
 
-  /**
-    * Returns the name of model addable object.
-    *
-    * @return the name of the object
-    */
-  override def getName(): Option[String] = Option(o.getName())
-
-  /**
-    * Set the name of the model addable object.
-    *
-    * @param name is the name of the object
-    */
-  override def setName(name: String): Unit = o.setName(name)
-
   /**
     * Returns the CPLEX addable object
     *

src/main/scala/com/decisionbrain/cplex/cp/CumulFunctionExpr.scala

@@ -122,20 +122,6 @@ class CumulFunctionExpr(val expr: IloCumulFunctionExpr)(implicit model: CpModel)
     */
   override def toString: String = expr.toString()
 
-  /**
-    * Returns the name of model addable object.
-    *
-    * @return the name of the object
-    */
-  override def getName: Option[String] = Option(expr.getName())
-
-  /**
-    * Set the name of the model addable object.
-    *
-    * @param name is the name of the object
-    */
-  override def setName(name: String): Unit = expr.setName(name)
-
   /**
     * Returns the CPLEX addable object.
     *

src/main/scala/com/decisionbrain/cplex/cp/IntervalSequenceVar.scala

@@ -61,20 +61,6 @@ class IntervalSequenceVar(val expr: IloIntervalSequenceVar)(implicit model: CpMo
     */
   override def toString: String = expr.toString()
 
-  /**
-    * Returns the name of model addable object.
-    *
-    * @return the name of the object
-    */
-  override def getName: Option[String] = Option(expr.getName())
-
-  /**
-    * Set the name of the model addable object.
-    *
-    * @param name is the name of the object
-    */
-  override def setName(name: String): Unit = expr.setName(name)
-
   /**
     * Returns the CPLEX addable object.
     *

src/main/scala/com/decisionbrain/cplex/cp/IntervalVar.scala

@@ -34,20 +34,6 @@ class IntervalVar(v: IloIntervalVar)(implicit model: CpModel) extends Addable {
     */
   def getIloIntervalVar(): IloIntervalVar = v
 
-
-  /**
-    * Return the name of the numeric variable
-    * @return the name
-    */
-  def getName(): Option[String] = Option(v.getName())
-
-  /**
-    * Set the name of the numeric variable.
-    *
-    * @param name is the name of the numeric variable
-    */
-  def setName(name: String) = v.setName(name)
-
   /**
     * Returns the CPLEX numeric variable
     *