added initial setup for model comparison.

Author: Reiner Jung

analysis/src/main/java/org/iobserve/analysis/cdoruserbehavior/clustering/IVectorQuantizationClustering.java

@@ -23,14 +23,14 @@
 import weka.core.Instances;
 
 /**
- * interface for a clustering usable by {@link TVectorQuantizationClustering}
+ * interface for a clustering usable by {@link TVectorQuantizationClustering}.
  *
  * @author Christoph Dornieden
  *
  */
 public interface IVectorQuantizationClustering extends IClustering {
     /**
-     * get cluster centers of all clusters
+     * get cluster centers of all clusters.
      *
      * @param instances
      *            instances to be clustered

analysis/src/main/java/org/iobserve/analysis/cdoruserbehavior/clustering/XMeansClustering.java

@@ -26,7 +26,7 @@
 import weka.core.NormalizableDistance;
 
 /**
- * xmeans clustering for TClustering
+ * xmeans clustering for TClustering.
  *
  * @author Christoph Dornieden
  *
@@ -37,7 +37,7 @@ public class XMeansClustering implements IVectorQuantizationClustering {
     private final NormalizableDistance distanceMetric;
 
     /**
-     * constructor
+     * constructor.
      *
      * @param expectedUserGroups
      *            number of expected user groups
@@ -48,16 +48,16 @@ public class XMeansClustering implements IVectorQuantizationClustering {
      */
     public XMeansClustering(final int expectedUserGroups, final int variance,
             final NormalizableDistance distanceMetric) {
-        this.minClusters = (expectedUserGroups - variance) < 2 ? 1 : expectedUserGroups - variance;
-        this.maxClusters = (expectedUserGroups + variance) < 2 ? 2 : expectedUserGroups + variance;
+        this.minClusters = expectedUserGroups - variance < 2 ? 1 : expectedUserGroups - variance;
+        this.maxClusters = expectedUserGroups + variance < 2 ? 2 : expectedUserGroups + variance;
         this.distanceMetric = distanceMetric;
     }
 
     @Override
     public Optional<ClusteringResults> clusterInstances(final Instances instances) {
         Optional<ClusteringResults> clusteringResults = Optional.empty();
 
-        // Cluster multiple times to reduce the impact of the initial k of the k-means
+        /** Cluster multiple times to reduce the impact of the initial k of the k-means. */
         for (int i = 0; i < 5; i++) {
 
             final Optional<ClusteringResults> tempClusteringResults = this.getClusteringResults(instances);
@@ -84,10 +84,10 @@ private Optional<ClusteringResults> getClusteringResults(final Instances instanc
         try {
             xMeansClusterer.buildClusterer(instances);
 
-            // **************************************************************
-            // Code used from org.iobserve.analysis.userbehavior.XMeansClustering
-            // to use org.iobserve.analysis.userbehavior.ClusteringResults
-            // **************************************************************
+            /**
+             * Code used from org.iobserve.analysis.userbehavior.XMeansClustering to use
+             * org.iobserve.analysis.userbehavior.ClusteringResults
+             */
             int[] clustersize = null;
             final int[] assignments = new int[instances.numInstances()];
             clustersize = new int[xMeansClusterer.getClusterCenters().numInstances()];
@@ -102,7 +102,6 @@ private Optional<ClusteringResults> getClusteringResults(final Instances instanc
 
             final ClusteringResults xMeansClusteringResults = new ClusteringResults("X-Means",
                     xMeansClusterer.getClusterCenters().numInstances(), assignments, clusteringMetrics);
-            // ****
 
             return Optional.of(xMeansClusteringResults);
 

analysis/src/main/java/org/iobserve/analysis/cdoruserbehavior/filter/TBehaviorModelCreation.java

@@ -32,6 +32,7 @@
 import weka.core.Instances;
 
 /**
+ * Create a behavior model from Weka instances.
  *
  * @author Christoph Dornieden
  *
@@ -71,7 +72,7 @@ public OutputPort<BehaviorModel> getOutputPort() {
     }
 
     /**
-     * create a BehaviorModel from Instance
+     * create a BehaviorModel from Instance.
      *
      * @param instances
      *            instances containing the attribute names
@@ -113,7 +114,7 @@ private Optional<BehaviorModel> createBehaviorModel(final Instances instances, f
     }
 
     /**
-     * Does the attribute name represent an edge?
+     * Test whether the given attribute name represent an edge.
      *
      * @param name
      *            attribute name
@@ -124,7 +125,7 @@ private boolean matchEdge(final String name) {
     }
 
     /**
-     * Does the attribute name represent a node?
+     * Test whether the attribute name represent a node.
      *
      * @param name
      *            attribute name
@@ -135,7 +136,7 @@ private boolean matchNode(final String name) {
     }
 
     /**
-     * does the pattern matches the start of the string
+     * Does the pattern matches the start of the string.
      *
      * @param pattern
      *            pattern
@@ -150,7 +151,7 @@ private boolean matchStart(final Pattern pattern, final String string) {
     }
 
     /**
-     * creates an edge from an edge representing attribute string and value
+     * Creates an edge from an edge representing attribute string and value.
      *
      * @param name
      *            attribute name
@@ -181,7 +182,7 @@ private Optional<EntryCallEdge> createEdge(final String name, final Double value
     }
 
     /**
-     * creates an node from a node representing attribute string and value
+     * Creates an node from a node representing attribute string and value.
      *
      * @param name
      *            attribute name
@@ -208,7 +209,7 @@ private Optional<EntryCallNode> createNode(final String name, final Double value
     }
 
     /**
-     * splits the signature
+     * Splits the signature.
      *
      * @param indicator
      *            indicator

analysis/src/main/java/org/iobserve/analysis/cdoruserbehavior/filter/TBehaviorModelPreperation.java

@@ -76,7 +76,7 @@ protected void execute(final Object object) {
     }
 
     /**
-     * execute case object instanceof EntryCallSequenceModel.
+     * Execute case object instanceof EntryCallSequenceModel.
      *
      * @param entryCallSequenceModel
      *            entryCallSequenceModel
@@ -117,7 +117,7 @@ private void executeEntryCallSequenceModel(final EntryCallSequenceModel entryCal
     }
 
     /**
-     * execute case object instanceof BehaviorModelTable.
+     * Execute case object instanceof BehaviorModelTable.
      *
      * @param behaviorModelTable
      *            behaviorModelTable

analysis/src/main/java/org/iobserve/analysis/cdoruserbehavior/filter/models/EntryCallEdge.java

@@ -16,7 +16,7 @@
 package org.iobserve.analysis.cdoruserbehavior.filter.models;
 
 /**
- * Represents the transition between an entry call
+ * Represents the transition between an entry call.
  *
  * @author Christoph Dornieden
  *
@@ -30,7 +30,7 @@ public class EntryCallEdge {
     private double calls;
 
     /**
-     * constructor
+     * constructor.
      */
     public EntryCallEdge() {
         this.source = null;
@@ -39,7 +39,7 @@ public EntryCallEdge() {
     }
 
     /**
-     * constructor
+     * constructor.
      *
      * @param source
      *            source node
@@ -53,7 +53,7 @@ public EntryCallEdge(final EntryCallNode source, final EntryCallNode target) {
     }
 
     /**
-     * constructor
+     * constructor.
      *
      * @param source
      *            source node
@@ -69,14 +69,14 @@ public EntryCallEdge(final EntryCallNode source, final EntryCallNode target, fin
     }
 
     /**
-     * increment calls
+     * increment calls.
      */
     public void incrementCalls() {
         this.calls = this.calls < 0 ? 0 : this.calls + 1;
     }
 
     /**
-     * decrement calls
+     * decrement calls.
      */
     public void decrementCalls() {
         this.calls = this.calls < 1 ? 0 : this.calls - 1;
@@ -92,7 +92,7 @@ public boolean equals(final Object obj) {
         if (obj instanceof EntryCallEdge) {
 
             final EntryCallEdge edge = (EntryCallEdge) obj;
-            return (this.getSource().equals(edge.getSource())) && (this.getTarget().equals(edge.getTarget()));
+            return this.getSource().equals(edge.getSource()) && this.getTarget().equals(edge.getTarget());
 
         } else {
             return super.equals(obj);
@@ -104,65 +104,32 @@ public int hashCode() {
         return super.hashCode();
     }
 
-    /**
-     * getter
-     *
-     * @return source node
-     */
     public EntryCallNode getSource() {
         return this.source;
     }
 
-    /**
-     * setter
-     *
-     * @param source
-     *            target node
-     */
     public void setSource(final EntryCallNode source) {
         this.source = source;
     }
 
-    /**
-     * getter
-     *
-     * @return target node
-     */
     public EntryCallNode getTarget() {
         return this.target;
     }
 
-    /**
-     * setter
-     *
-     * @param target
-     *            target node
-     */
     public void setTarget(final EntryCallNode target) {
         this.target = target;
     }
 
-    /**
-     * getter
-     *
-     * @return calls
-     */
     public double getCalls() {
         return this.calls;
     }
 
-    /**
-     * setter
-     *
-     * @param calls
-     *            calls
-     */
     public void setCalls(final double calls) {
         this.calls = calls < 0 ? 0 : calls;
     }
 
     /**
-     * add calls to the edge
+     * add calls to the edge.
      *
      * @param calls
      *            calls

analysis/src/main/java/org/iobserve/analysis/cdoruserbehavior/filter/models/EntryCallNode.java

@@ -22,7 +22,7 @@
 import org.iobserve.analysis.cdoruserbehavior.util.SingleOrNoneCollector;
 
 /**
- * Represents the an entry call
+ * Represents the an entry call.
  *
  * @author Christoph Dornieden
  *
@@ -33,7 +33,7 @@ public class EntryCallNode {
     private final Set<CallInformation> entryCallInformations;
 
     /**
-     * constructor
+     * constructor.
      *
      * @param signature
      *            signature
@@ -44,7 +44,7 @@ public EntryCallNode(final String signature) {
     }
 
     /**
-     * adds call information with signatures not present in the entry call information set
+     * adds call information with signatures not present in the entry call information set.
      *
      * @param callInformations
      *            callInformations
@@ -54,7 +54,7 @@ public void mergeInformation(final Set<CallInformation> callInformations) {
     }
 
     /**
-     * adds a call information with a signature not present in the entry call information set
+     * adds a call information with a signature not present in the entry call information set.
      *
      * @param callInformation
      *            callInformation
@@ -91,20 +91,10 @@ public int hashCode() {
         return super.hashCode();
     }
 
-    /**
-     * getter
-     *
-     * @return the signature
-     */
     public String getSignature() {
         return this.signature;
     }
 
-    /**
-     * getter
-     *
-     * @return the entryCallInformation
-     */
     public Set<CallInformation> getEntryCallInformation() {
         return this.entryCallInformations;
     }