CategoricalValue.java

  1. package org.thegalactic.context.constraint.categorical;

  3. /*
  4.  * CategoricalValue.java
  5.  *
  6.  * Copyright: 2016 The Galactic Organization, France
  7.  *
  8.  * License: http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html CeCILL-B license
  9.  *
  10.  * This file is part of java-lattices.
  11.  * You can redistribute it and/or modify it under the terms of the CeCILL-B license.
  12.  */
  13. /**
  14.  * Categorical Value.
  15.  */
  16. public final class CategoricalValue {

  18.     /**
  19.      * Data.
  20.      */
  21.     private Object data;

  23.     /**
  24.      * Attribute.
  25.      */
  26.     private final CategoricalAttribute attribute;

  28.     /**
  29.      * Create a new CategoricalValue.
  30.      *
  31.      * @param data      Object
  32.      * @param attribute CategoricalAttribute
  33.      *
  34.      * @return a new CategoricalValue
  35.      */
  36.     static CategoricalValue create(final Object data, final CategoricalAttribute attribute) {
  37.         return new CategoricalValue(data, attribute);
  38.     }

  40.     /**
  41.      * This class is nod designed to be publicly instantiated.
  42.      *
  43.      * @param object    Object
  44.      * @param attribute CategoricalAttribute
  45.      */
  46.     private CategoricalValue(final Object object, final CategoricalAttribute attribute) {
  47.         this.setData(object);
  48.         this.attribute = attribute;
  49.     }

  51.     /**
  52.      * Get the underlying attribute.
  53.      *
  54.      * @return the underlying attribute
  55.      */
  56.     public CategoricalAttribute getAttribute() {
  57.         return this.attribute;
  58.     }

  60.     /**
  61.      * Get the underlying model.
  62.      *
  63.      * @return the underlying model
  64.      */
  65.     public CategoricalModel getModel() {
  66.         return this.attribute.getModel();
  67.     }

  69.     /**
  70.      * Get the underlying data.
  71.      *
  72.      * @return the underlying data
  73.      */
  74.     public Object getData() {
  75.         return this.data;
  76.     }

  78.     /**
  79.      * Set the underlying data.
  80.      *
  81.      * @param data the underlying data
  82.      *
  83.      * @return this for chaining
  84.      */
  85.     public CategoricalValue setData(final Object data) {
  86.         this.data = data;
  87.         return this;
  88.     }

  90.     /**
  91.      * Get the index of this value relatively to its model.
  92.      *
  93.      * @return the index of this value
  94.      */
  95.     public int index() {
  96.         return this.attribute.startIndex() + this.attribute.indexOf(this);
  97.     }

  99.     /**
  100.      * Returns a string representation of the data.
  101.      *
  102.      * @return a string representation of the data.
  103.      */
  104.     @Override
  105.     public String toString() {
  106.         final String string = this.data.toString();
  107.         if (string.contains(" ") || string.contains("\"")) {
  108.             return "\"" + string.replace("\"", "\\\"") + "\"";
  109.         } else {
  110.             return string;
  111.         }
  112.     }
  113. }
Created with JaCoCo 0.7.7.201606060606