metafacture-statistics/ (main): Fix Checkstyle violations.

blackwinter · blackwinter · commit 000f06c8756a · 2021-09-07T20:38:23.000+02:00
diff --git a/metafacture-statistics/src/main/java/org/metafacture/statistics/AbstractCountProcessor.java b/metafacture-statistics/src/main/java/org/metafacture/statistics/AbstractCountProcessor.java
@@ -13,16 +13,17 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.metafacture.statistics;
 
-import java.util.Hashtable;
-import java.util.Map;
-import java.util.regex.Pattern;
+package org.metafacture.statistics;
 
 import org.metafacture.framework.ObjectReceiver;
 import org.metafacture.framework.helpers.DefaultObjectPipe;
 import org.metafacture.framework.objects.Triple;
 
+import java.util.Hashtable;
+import java.util.Map;
+import java.util.regex.Pattern;
+
 /**
  * Base class for operating on count data. The expected inputs are triples
  * containing as subject the variable name and as object the count. Marginal
@@ -33,7 +34,6 @@
  */
 public abstract class AbstractCountProcessor extends DefaultObjectPipe<Triple, ObjectReceiver<Triple>> {
 
-
     private static final Pattern KEY_SPLIT_PATTERN = Pattern.compile("&", Pattern.LITERAL);
 
     private static final String MARGINAL_PREFIX = "1:";
@@ -67,7 +67,8 @@ public final void process(final Triple triple) {
                 marginals.put(triple.getSubject().substring(2), Integer.valueOf(marginal));
             }
 
-        } else {
+        }
+        else {
             inHeader = false;
             if (!triple.getSubject().startsWith(JOINT_PREFIX)) {
                 throw new IllegalArgumentException("Joint counts must start with '2:'");
@@ -84,12 +85,11 @@ public final void process(final Triple triple) {
         }
     }
 
-    protected abstract void processCount(final String varA, final String varB, final int countA, final int countB,
-            final int countAandB);
+    protected abstract void processCount(String varA, String varB, int countA, int countB, int countAandB);
 
     private int getMarginal(final String string) {
         final Integer value = marginals.get(string);
-        if(null==value){
+        if (null == value) {
             return 0;
         }
         return value.intValue();
@@ -104,7 +104,6 @@ protected final void onResetStream() {
 
     protected void reset() {
         // nothing to do
-
     }
 
     @Override
@@ -115,7 +114,6 @@ protected final void onCloseStream() {
 
     protected void close() {
         // nothing to do
-
     }
 
 }
diff --git a/metafacture-statistics/src/main/java/org/metafacture/statistics/CooccurrenceMetricCalculator.java b/metafacture-statistics/src/main/java/org/metafacture/statistics/CooccurrenceMetricCalculator.java
@@ -13,17 +13,18 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.metafacture.statistics;
 
-import java.util.ArrayList;
-import java.util.List;
+package org.metafacture.statistics;
 
 import org.metafacture.framework.FluxCommand;
 import org.metafacture.framework.annotations.Description;
 import org.metafacture.framework.annotations.In;
 import org.metafacture.framework.annotations.Out;
 import org.metafacture.framework.objects.Triple;
 
+import java.util.ArrayList;
+import java.util.List;
+
 /**
  * Calculates values for various co-occurrence metrics. The expected inputs are
  * triples containing as subject the var name and as object the count. Marginal
@@ -32,8 +33,8 @@
  *
  * @author Markus Michael Geipel
  */
-@Description("Calculates values for various cooccurrence metrics. The expected inputs are triples containing as subject the var name and as object the count. "
-        + "Marginal counts must appear first, joint counts second. Marinal counts must be written as 1:A, Joint counts as 2:A&B")
+@Description("Calculates values for various cooccurrence metrics. The expected inputs are triples containing as subject the var name and as object the count. " +
+    "Marginal counts must appear first, joint counts second. Marinal counts must be written as 1:A, Joint counts as 2:A&B")
 @In(Triple.class)
 @Out(Triple.class)
 @FluxCommand("calculate-metrics")
@@ -51,8 +52,7 @@ enum Metric {
                 final double o22 = total - countAandB;
                 final double d = (countAandB * o22) - (o12 * o21);
 
-                final double x2 = total * Math.pow(d, 2)
-                        / ((countAandB + o12) * (countAandB + o21) * (o12 + o22) * (o21 + o22));
+                final double x2 = total * Math.pow(d, 2) / ((countAandB + o12) * (countAandB + o21) * (o12 + o22) * (o21 + o22));
                 return x2 * Math.signum(d);
             }
         },
@@ -87,36 +87,34 @@ enum Metric {
         JACCARD {
             @Override
             double calculate(final int countA, final int countB, final int countAandB, final int total) {
-                return countAandB / (double)(countA + countB - countAandB);
+                return countAandB / (double) (countA + countB - countAandB);
             }
         };
 
-        abstract double calculate(final int countA, final int countB, final int countAandB, final int total);
+        abstract double calculate(int countA, int countB, int countAandB, int total);
     }
 
     private static final int MIN_COUNT = 5;
 
     private final List<Metric> metrics = new ArrayList<Metric>();
 
     public CooccurrenceMetricCalculator(final String allMetrics) {
-        final String[] metrics = allMetrics.split("\\s*,\\s*");
         setMinCount(MIN_COUNT);
-        for (String metric : metrics) {
-            this.metrics.add(Metric.valueOf(metric));
+        for (final String metric : allMetrics.split("\\s*,\\s*")) {
+            metrics.add(Metric.valueOf(metric));
         }
     }
 
     public CooccurrenceMetricCalculator(final Metric... metrics) {
         setMinCount(MIN_COUNT);
-        for (Metric metric : metrics) {
+        for (final Metric metric : metrics) {
             this.metrics.add(metric);
         }
     }
 
     @Override
-    protected void processCount(final String varA, final String varB, final int countA, final int countB,
-            final int countAandB) {
-        for (Metric metric : metrics) {
+    protected void processCount(final String varA, final String varB, final int countA, final int countB, final int countAandB) {
+        for (final Metric metric : metrics) {
             final double value = metric.calculate(countA, countB, countAandB, getTotal());
             getReceiver().process(new Triple(varA + "&" + varB, metric.toString(), String.valueOf(value)));
         }
diff --git a/metafacture-statistics/src/main/java/org/metafacture/statistics/Counter.java b/metafacture-statistics/src/main/java/org/metafacture/statistics/Counter.java
@@ -13,6 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+
 package org.metafacture.statistics;
 
 import org.metafacture.framework.FluxCommand;
@@ -42,6 +43,9 @@ public final class Counter extends DefaultStreamPipe<StreamReceiver> {
     private int numEntities;
     private int numLiterals;
 
+    public Counter() {
+    }
+
     /**
      * @return the numRecords
      */
@@ -67,7 +71,7 @@ public int getNumLiterals() {
     public void startRecord(final String identifier) {
         assert !isClosed();
         ++numRecords;
-        if(getReceiver() != null) {
+        if (getReceiver() != null) {
             getReceiver().startRecord(identifier);
         }
     }
@@ -76,7 +80,7 @@ public void startRecord(final String identifier) {
     public void startEntity(final String name) {
         assert !isClosed();
         ++numEntities;
-        if(getReceiver() != null) {
+        if (getReceiver() != null) {
             getReceiver().startEntity(name);
         }
     }
@@ -85,21 +89,21 @@ public void startEntity(final String name) {
     public void literal(final String name, final String value) {
         assert !isClosed();
         ++numLiterals;
-        if(getReceiver() != null) {
+        if (getReceiver() != null) {
             getReceiver().literal(name, value);
         }
     }
 
     @Override
     public void endRecord() {
-        if(getReceiver() != null) {
+        if (getReceiver() != null) {
             getReceiver().endRecord();
         }
     }
 
     @Override
     public void endEntity() {
-        if(getReceiver() != null) {
+        if (getReceiver() != null) {
             getReceiver().endEntity();
         }
     }
@@ -113,11 +117,7 @@ public void onResetStream() {
 
     @Override
     public String toString() {
-        String streamClosed = "";
-        if (isClosed()) {
-            streamClosed =" Stream has been closed.";
-        }
-
+        final String streamClosed = isClosed() ? " Stream has been closed." : "";
         return "counted " + numRecords + " records, " + numEntities + " entities, " + numLiterals + " literals." + streamClosed;
     }
 }
diff --git a/metafacture-statistics/src/main/java/org/metafacture/statistics/Histogram.java b/metafacture-statistics/src/main/java/org/metafacture/statistics/Histogram.java
@@ -13,15 +13,15 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+
 package org.metafacture.statistics;
 
+import org.metafacture.framework.helpers.DefaultStreamReceiver;
+
 import java.util.Collections;
 import java.util.HashMap;
 import java.util.Map;
 
-import org.metafacture.framework.helpers.DefaultStreamReceiver;
-
-
 /**
  * Counts entity names, literal names, or literal values.
  *
@@ -36,7 +36,6 @@ public final class Histogram extends DefaultStreamReceiver {
     private String countField;
 
     public Histogram() {
-        super();
     }
 
     /**
@@ -45,7 +44,6 @@ public Histogram() {
      * @param countField name of the field whose content is counted
      */
     public Histogram(final String countField) {
-        super();
         setCountField(countField);
     }
 
diff --git a/metafacture-statistics/src/main/java/org/metafacture/statistics/UniformSampler.java b/metafacture-statistics/src/main/java/org/metafacture/statistics/UniformSampler.java
@@ -13,11 +13,8 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.metafacture.statistics;
 
-import java.util.ArrayList;
-import java.util.List;
-import java.util.Random;
+package org.metafacture.statistics;
 
 import org.metafacture.framework.FluxCommand;
 import org.metafacture.framework.ObjectReceiver;
@@ -26,6 +23,9 @@
 import org.metafacture.framework.annotations.Out;
 import org.metafacture.framework.helpers.DefaultObjectPipe;
 
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Random;
 
 /**
  * Draws a uniform sample of records from the input stream.
@@ -50,35 +50,32 @@ public final class UniformSampler<T> extends
     private long count;
 
     public UniformSampler(final int sampleSize) {
-        super();
         this.sampleSize = sampleSize;
         sample = new ArrayList<T>(sampleSize);
     }
 
-
     public UniformSampler(final String sampleSize) {
         this(Integer.parseInt(sampleSize));
     }
 
-
     public int getSampleSize() {
         return sampleSize;
     }
 
-
     public void setSeed(final long seed) {
         random.setSeed(seed);
     }
 
     @Override
     public void process(final T obj) {
         assert !isClosed();
-        assert null!=obj;
+        assert null != obj;
         count += 1;
         if (sample.size() < sampleSize) {
             sample.add(obj);
-        } else {
-            final double p = sampleSize / (double)count;
+        }
+        else {
+            final double p = sampleSize / (double) count;
             if (random.nextDouble() < p) {
                 sample.set(random.nextInt(sampleSize), obj);
             }
@@ -87,7 +84,7 @@ public void process(final T obj) {
 
     @Override
     protected void onCloseStream() {
-        for(T obj : sample) {
+        for (final T obj : sample) {
             getReceiver().process(obj);
         }
         sample.clear();
diff --git a/metafacture-statistics/src/test/java/org/metafacture/statistics/CooccurrenceMetricCalculatorTest.java b/metafacture-statistics/src/test/java/org/metafacture/statistics/CooccurrenceMetricCalculatorTest.java
@@ -13,6 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+
 package org.metafacture.statistics;
 
 import static org.junit.Assert.assertEquals;
diff --git a/metafacture-statistics/src/test/java/org/metafacture/statistics/HistogramTest.java b/metafacture-statistics/src/test/java/org/metafacture/statistics/HistogramTest.java
@@ -13,6 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+
 package org.metafacture.statistics;
 
 import static org.junit.Assert.assertEquals;
diff --git a/metafacture-statistics/src/test/java/org/metafacture/statistics/UniformSamplerTest.java b/metafacture-statistics/src/test/java/org/metafacture/statistics/UniformSamplerTest.java
@@ -13,6 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+
 package org.metafacture.statistics;
 
 import static org.mockito.Mockito.inOrder;

Original file line number	Diff line number	Diff line change
`@@ -13,6 +13,7 @@`
`13`	`13`	`* See the License for the specific language governing permissions and`
`14`	`14`	`* limitations under the License.`
`15`	`15`	`*/`
	`16`	`+`
`16`	`17`	`package org.metafacture.statistics;`
`17`	`18`
`18`	`19`	`import org.metafacture.framework.FluxCommand;`
`@@ -42,6 +43,9 @@ public final class Counter extends DefaultStreamPipe<StreamReceiver> {`
`42`	`43`	`private int numEntities;`
`43`	`44`	`private int numLiterals;`
`44`	`45`
	`46`	`+ public Counter() {`
	`47`	`+ }`
	`48`	`+`
`45`	`49`	`/**`
`46`	`50`	`* @return the numRecords`
`47`	`51`	`*/`
`@@ -67,7 +71,7 @@ public int getNumLiterals() {`
`67`	`71`	`public void startRecord(final String identifier) {`
`68`	`72`	`assert !isClosed();`
`69`	`73`	`++numRecords;`
`70`		`- if(getReceiver() != null) {`
	`74`	`+ if (getReceiver() != null) {`
`71`	`75`	`getReceiver().startRecord(identifier);`
`72`	`76`	`}`
`73`	`77`	`}`
`@@ -76,7 +80,7 @@ public void startRecord(final String identifier) {`
`76`	`80`	`public void startEntity(final String name) {`
`77`	`81`	`assert !isClosed();`
`78`	`82`	`++numEntities;`
`79`		`- if(getReceiver() != null) {`
	`83`	`+ if (getReceiver() != null) {`
`80`	`84`	`getReceiver().startEntity(name);`
`81`	`85`	`}`
`82`	`86`	`}`
`@@ -85,21 +89,21 @@ public void startEntity(final String name) {`
`85`	`89`	`public void literal(final String name, final String value) {`
`86`	`90`	`assert !isClosed();`
`87`	`91`	`++numLiterals;`
`88`		`- if(getReceiver() != null) {`
	`92`	`+ if (getReceiver() != null) {`
`89`	`93`	`getReceiver().literal(name, value);`
`90`	`94`	`}`
`91`	`95`	`}`
`92`	`96`
`93`	`97`	`@Override`
`94`	`98`	`public void endRecord() {`
`95`		`- if(getReceiver() != null) {`
	`99`	`+ if (getReceiver() != null) {`
`96`	`100`	`getReceiver().endRecord();`
`97`	`101`	`}`
`98`	`102`	`}`
`99`	`103`
`100`	`104`	`@Override`
`101`	`105`	`public void endEntity() {`
`102`		`- if(getReceiver() != null) {`
	`106`	`+ if (getReceiver() != null) {`
`103`	`107`	`getReceiver().endEntity();`
`104`	`108`	`}`
`105`	`109`	`}`
`@@ -113,11 +117,7 @@ public void onResetStream() {`
`113`	`117`
`114`	`118`	`@Override`
`115`	`119`	`public String toString() {`
`116`		`- String streamClosed = "";`
`117`		`- if (isClosed()) {`
`118`		`- streamClosed =" Stream has been closed.";`
`119`		`- }`
`120`		`-`
	`120`	`+ final String streamClosed = isClosed() ? " Stream has been closed." : "";`
`121`	`121`	`return "counted " + numRecords + " records, " + numEntities + " entities, " + numLiterals + " literals." + streamClosed;`
`122`	`122`	`}`
`123`	`123`	`}`