samoa-api/src/main/java/org/apache/samoa/moa/core/Vote.java

package org.apache.samoa.moa.core;

import java.io.Serializable;

/*
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 * 	        http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
 * either express or implied. See the License for the specific
 * language governing permissions and limitations under the
 * License.  
 */

import java.util.ArrayList;
import java.util.List;
import java.util.Locale;

/**
 * Class for storing votes.
 *
 */
public class Vote implements Serializable {

  private static final long serialVersionUID = 1L;

  protected String name;
  protected String value;

  public Vote(String name) {
    this.name = name;
  }

  public Vote(String name, String value) {
    this.name = name;
    this.value = value;
  }

  public Vote(String name, double value) {
    this(name, value, 3);
  }

  public Vote(String name, double value, int fractionDigits) {
    this(name);
    setValue(value, fractionDigits);
  }

  public String getName() {
    return this.name;
  }

  public String getValue() {
    return this.value;
  }

  public void setValue(String value) {
    this.value = value;
  }

  public void setValue(double value, int fractionDigits) {
    // rely on dot as a decimal separator not to confuse CSV parsers
    this.value = String.format(Locale.US, "%." + String.valueOf(fractionDigits) + "f", value);
  }

  public static void getVotesDescription(Vote[] votes,
      StringBuilder out, int indent) {
    if (votes.length > 0) {
      StringUtils.appendIndented(out, indent, votes[0].toString());
      for (int i = 1; i < votes.length; i++) {
        StringUtils.appendNewlineIndented(out, indent, votes[i].toString());
      }
    }
  }

  public void getDescription(StringBuilder sb, int indent) {
    sb.append(getName());
    sb.append(" = ");
    sb.append(this.value);
  }
}