metric tags

Author: guoyuepeng

griffin-metric/pom.xml

@@ -28,7 +28,6 @@ under the License.
         <version>2.0.0-SNAPSHOT</version>
     </parent>
 
-
     <artifactId>griffin-metric</artifactId>
     <name>${project.artifactId}</name>
     <packaging>jar</packaging>

griffin-metric/readme.md

@@ -18,12 +18,13 @@ Licensed to the Apache Software Foundation (ASF) under one
 */
 package org.apache.griffin.metric.model;
 
-import java.util.Date;
-
 import lombok.Data;
 
+import java.util.Date;
 
-
+/**
+ * A base class in metric function in griffin, which contains timestamp properties of entity creation/update.
+ */
 @Data
 public abstract class BaseEntity implements java.io.Serializable {
 

griffin-metric/src/main/java/org/apache/griffin/metric/model/BaseEntity.java

@@ -18,24 +18,39 @@ Licensed to the Apache Software Foundation (ASF) under one
 */
 package org.apache.griffin.metric.model;
 
-import lombok.*;
-
-import java.util.Map;
-
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Data;
+import lombok.EqualsAndHashCode;
+import lombok.NoArgsConstructor;
+
+/**
+ * A metric definition entity represents fundamental metadata.
+ */
 @Builder
 @Data
 @NoArgsConstructor
 @AllArgsConstructor
 @EqualsAndHashCode(callSuper = false)
 public class MetricD extends BaseEntity {
 
+    /**
+     * An unique identity for a metric.
+     */
     private long metricId;
 
+    /**
+     * The name of a metric entity.
+     */
     private String metricName;
 
+    /**
+     * The owner of a metric entity.
+     */
     private String owner;
 
+    /**
+     * The details of a metric entity.
+     */
     private String description;
-
-    private Map<String, String> tags;
 }

griffin-metric/src/main/java/org/apache/griffin/metric/model/MetricD.java

@@ -0,0 +1,51 @@
+/*
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements.  See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership.  The ASF licenses this file
+to you 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.
+*/
+package org.apache.griffin.metric.model;
+
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Data;
+import lombok.EqualsAndHashCode;
+import lombok.NoArgsConstructor;
+
+/**
+ * A metric tag entity represents fundamental information.
+ */
+@Builder
+@Data
+@NoArgsConstructor
+@AllArgsConstructor
+@EqualsAndHashCode(callSuper = false)
+public class MetricTag extends BaseEntity {
+
+    /**
+     * An unique identity for a metric tag.
+     */
+    private long id;
+
+    /**
+     * Key name
+     */
+    private String tagKey;
+
+    /**
+     * The value corresponding to a key
+     */
+    private String tagValue;
+}

griffin-metric/src/main/java/org/apache/griffin/metric/model/MetricTag.java

@@ -18,10 +18,16 @@ Licensed to the Apache Software Foundation (ASF) under one
 */
 package org.apache.griffin.metric.model;
 
-import lombok.*;
-
-import java.util.Map;
-
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Data;
+import lombok.EqualsAndHashCode;
+import lombok.NoArgsConstructor;
+import lombok.ToString;
+
+/**
+ * A metric value entity represents fundamental information.
+ */
 @Data
 @ToString
 @Builder
@@ -30,10 +36,18 @@ Licensed to the Apache Software Foundation (ASF) under one
 @EqualsAndHashCode(callSuper = false)
 public class MetricV extends BaseEntity {
 
+    /**
+     * An unique identity for a metric.
+     */
     private long metricId;
 
+    /**
+     * A double number to store metric value.
+     */
     private double value;
 
-    private Map<String, String> tags;
-
+    /**
+     * The tag property assigned.
+     */
+    private Tags tags;
 }

griffin-metric/src/main/java/org/apache/griffin/metric/model/MetricV.java

@@ -0,0 +1,30 @@
+package org.apache.griffin.metric.model;
+
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Data;
+import lombok.EqualsAndHashCode;
+import lombok.NoArgsConstructor;
+
+import java.util.List;
+
+/**
+ * A common tag entity represents the relationships among metric entities and metric tag entities.
+ */
+@Data
+@Builder
+@NoArgsConstructor
+@AllArgsConstructor
+@EqualsAndHashCode(callSuper = false)
+public class Tags extends BaseEntity {
+
+    /**
+     * Metric entity's identity.
+     */
+    private long metricId;
+
+    /**
+     * All tag properties assigning to a metric entity.
+     */
+    private List<MetricTag> metricTags;
+}