org.sonar.api.measures.CountDistributionBuilder Maven / Gradle / Ivy
/*
* SonarQube, open source software quality management tool.
* Copyright (C) 2008-2014 SonarSource
* mailto:contact AT sonarsource DOT com
*
* SonarQube is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 3 of the License, or (at your option) any later version.
*
* SonarQube is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program; if not, write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
package org.sonar.api.measures;
import org.apache.commons.collections.SortedBag;
import org.apache.commons.collections.bag.TreeBag;
import org.apache.commons.lang.StringUtils;
import org.apache.commons.lang.math.NumberUtils;
import org.sonar.api.utils.KeyValueFormat;
import org.sonar.api.utils.SonarException;
import java.util.Map;
/**
* Utility to build a distribution based on discrete values
*
* An example of usage : you wish to record the number of violations for each level of rules priority
*
* @since 1.10
*/
public class CountDistributionBuilder implements MeasureBuilder {
private Metric metric;
// TODO to be replaced by com.google.common.collect.SortedMultiset while upgrading to Guava 11+
private SortedBag countBag;
/**
* Creates an empty CountDistributionBuilder for a specified metric
*
* @param metric the metric
*/
public CountDistributionBuilder(Metric metric) {
setMetric(metric);
this.countBag = new TreeBag();
}
/**
* Increments an entry
*
* @param value the value that should be incremented
* @param count the number by which to increment
* @return the current object
*/
public CountDistributionBuilder add(Object value, int count) {
if (count == 0) {
addZero(value);
} else {
if (this.countBag.add(value, count)) {
//hack
this.countBag.add(value, 1);
}
}
return this;
}
/**
* Increments an entry by one
*
* @param value the value that should be incremented
* @return the current object
*/
public CountDistributionBuilder add(Object value) {
return add(value, 1);
}
/**
* Adds an entry without a zero count if it does not exist
*
* @param value the entry to be added
* @return the current object
*/
public CountDistributionBuilder addZero(Object value) {
if (!countBag.contains(value)) {
countBag.add(value, 1);
}
return this;
}
/**
* Adds an existing Distribution to the current one.
* It will create the entries if they don't exist.
* Can be used to add the values of children resources for example
*
* @param measure the measure to add to the current one
* @return the current object
*/
public CountDistributionBuilder add(Measure measure) {
if (measure != null && measure.getData() != null) {
Map map = KeyValueFormat.parse(measure.getData());
for (Map.Entry entry : map.entrySet()) {
String key = entry.getKey();
int value = StringUtils.isBlank(entry.getValue()) ? 0 : Integer.parseInt(entry.getValue());
if (NumberUtils.isNumber(key)) {
add(NumberUtils.toInt(key), value);
} else {
add(key, value);
}
}
}
return this;
}
/**
* @return whether the current object is empty or not
*/
public boolean isEmpty() {
return countBag.isEmpty();
}
/**
* Resets all entries to zero
*
* @return the current object
*/
public CountDistributionBuilder clear() {
countBag.clear();
return this;
}
/**
* Shortcut for build(true)
*
* @return the built measure
*/
public Measure build() {
return build(true);
}
/**
* Used to build a measure from the current object
*
* @param allowEmptyData should be built if current object is empty
* @return the built measure
*/
public Measure build(boolean allowEmptyData) {
if (!isEmpty() || allowEmptyData) {
//-1 is a hack to include zero values
return new Measure(metric, KeyValueFormat.format(countBag, -1));
}
return null;
}
private void setMetric(Metric metric) {
if (metric == null || !metric.isDataType()) {
throw new SonarException("Metric is null or has unvalid type");
}
this.metric = metric;
}
}