Merge pull request #33 from martiner/rep

Add MetadataService.getObj() method returning Obj instance by restrictions

Author: Libor Rysavy

README.md

@@ -52,7 +52,10 @@ Query, create and update project metadata - attributes, facts, metrics, reports,
 ```java
 MetadataService md = gd.getMetadataService();
 
-String factUri = md.findObjUri(project, Fact.class, Restriction.title("myfact"));
+String factUri = md.getObjUri(project, Fact.class, Restriction.title("myfact"));
+Metric m = new Metric("my sum", "SELECT SUM([" + factUri + "])", "#,##0");
+Metric metric = md.createObj(project, m);
+Attribute attr = md.getObj(project, Attribute.class, Restriction.title("myattr"));
 
 Metric m = md.createObj(project, new Metric("My Sum", "SELECT SUM([" + factUri + "])", "#,##0"));
 

src/main/java/com/gooddata/Validate.java

@@ -59,4 +59,14 @@ public static <T extends Collection> T noNullElements(T collection, String argum
         return collection;
     }
 
+    public static <T> T[] noNullElements(T[] array, String argument) {
+        notNull(array, argument);
+        for (int i = 0; i<array.length; i++) {
+            if (array[i] == null) {
+                throw new IllegalArgumentException(argument + " contains null element at index: " + i);
+            }
+        }
+        return array;
+    }
+
 }

src/main/java/com/gooddata/md/AbstractObj.java

@@ -0,0 +1,103 @@
+/*
+ * Copyright (C) 2007-2014, GoodData(R) Corporation. All rights reserved.
+ */
+package com.gooddata.md;
+
+import org.codehaus.jackson.annotate.JsonIgnore;
+import org.codehaus.jackson.annotate.JsonProperty;
+
+import static com.gooddata.Validate.noNullElements;
+
+/**
+ * Metadata object (common part)
+ */
+public abstract class AbstractObj implements Obj {
+
+    @JsonProperty("meta")
+    protected final Meta meta;
+
+    protected AbstractObj(@JsonProperty("meta") Meta meta) {
+        this.meta = meta;
+    }
+
+    @JsonIgnore
+    public String getAuthor() {
+        return meta.getAuthor();
+    }
+
+    @JsonIgnore
+    public String getContributor() {
+        return meta.getContributor();
+    }
+
+    @JsonIgnore
+    public String getCreated() {
+        return meta.getCreated();
+    }
+
+    @JsonIgnore
+    public String getSummary() {
+        return meta.getSummary();
+    }
+
+    @JsonIgnore
+    public String getTitle() {
+        return meta.getTitle();
+    }
+
+    @JsonIgnore
+    public String getUpdated() {
+        return meta.getUpdated();
+    }
+
+    @JsonIgnore
+    public String getCategory() {
+        return meta.getCategory();
+    }
+
+    @JsonIgnore
+    public String getTags() {
+        return meta.getTags();
+    }
+
+    @JsonIgnore
+    public String getUri() {
+        return meta.getUri();
+    }
+
+    @JsonIgnore
+    public String getDeprecated() {
+        return meta.getDeprecated();
+    }
+
+    @JsonIgnore
+    public String getIdentifier() {
+        return meta.getIdentifier();
+    }
+
+    @JsonIgnore
+    public Integer getLocked() {
+        return meta.getLocked();
+    }
+
+    @JsonIgnore
+    public Integer getUnlisted() {
+        return meta.getUnlisted();
+    }
+
+    /**
+     * Get list of URIs of the given {@link Obj}s
+     * @param objs metadata objects
+     * @return list of URIs
+     */
+    @SafeVarargs
+    protected static <T extends Obj> String[] uris(T... objs) {
+        noNullElements(objs, "objs");
+        final String[] uris = new String[objs.length];
+        for (int i=0; i<objs.length; i++) {
+            uris[i] = objs[i].getUri();
+        }
+        return uris;
+    }
+
+}

src/main/java/com/gooddata/md/Attribute.java

@@ -23,7 +23,7 @@
 @JsonTypeInfo(include = JsonTypeInfo.As.WRAPPER_OBJECT, use = JsonTypeInfo.Id.NAME)
 @JsonIgnoreProperties(ignoreUnknown = true)
 @JsonSerialize(include = JsonSerialize.Inclusion.NON_NULL)
-public class Attribute extends Obj implements Queryable {
+public class Attribute extends AbstractObj implements Queryable {
 
     @JsonProperty("content")
     private final Content content;
@@ -55,6 +55,11 @@ public Collection<Key> getForeignKeys() {
         return content.getFk();
     }
 
+    @JsonIgnore
+    public DisplayForm getDefaultDisplayForm() {
+        return getDisplayForms().iterator().next();
+    }
+
     @JsonIgnoreProperties(ignoreUnknown = true)
     @JsonSerialize(include = JsonSerialize.Inclusion.NON_NULL)
     private static class Content {

src/main/java/com/gooddata/md/DisplayForm.java

@@ -14,7 +14,7 @@
  */
 @JsonIgnoreProperties(ignoreUnknown = true)
 @JsonSerialize(include = JsonSerialize.Inclusion.NON_NULL)
-public class DisplayForm extends Obj {
+public class DisplayForm extends AbstractObj {
 
     @JsonProperty("content")
     private final Content content;

src/main/java/com/gooddata/md/Fact.java

@@ -22,7 +22,7 @@
 @JsonTypeInfo(include = JsonTypeInfo.As.WRAPPER_OBJECT, use = JsonTypeInfo.Id.NAME)
 @JsonIgnoreProperties(ignoreUnknown = true)
 @JsonSerialize(include = JsonSerialize.Inclusion.NON_NULL)
-public class Fact extends Obj implements Queryable {
+public class Fact extends AbstractObj implements Queryable {
 
     @JsonProperty("content")
     private final Content content;

src/main/java/com/gooddata/md/MetadataService.java

@@ -121,7 +121,7 @@ public <T extends Obj> T getObjById(Project project, String id, Class<T> cls) {
      * @throws com.gooddata.md.ObjNotFoundException  if metadata object not found
      * @throws com.gooddata.md.NonUniqueObjException if more than one object corresponds to search restrictions
      */
-    public <T extends Queryable> String findObjUri(Project project, Class<T> cls, Restriction... restrictions) {
+    public <T extends Queryable> String getObjUri(Project project, Class<T> cls, Restriction... restrictions) {
         final Collection<String> results = findUris(project, cls, restrictions);
         if (results == null || results.isEmpty()) {
             throw new ObjNotFoundException(cls);
@@ -131,6 +131,27 @@ public <T extends Queryable> String findObjUri(Project project, Class<T> cls, Re
         return results.iterator().next();
     }
 
+    /**
+     * Get metadata object by restrictions like identifier, title or summary.
+     *
+     * @param project      project where to search for the object
+     * @param cls          class of the resulting object
+     * @param restrictions query restrictions
+     * @param <T>          type of the object to be returned
+     * @return metadata object
+     * @throws com.gooddata.md.ObjNotFoundException  if metadata object not found
+     * @throws com.gooddata.md.NonUniqueObjException if more than one object corresponds to search restrictions
+     */
+    public <T extends Queryable> T getObj(Project project, Class<T> cls, Restriction... restrictions) {
+        final Collection<String> results = findUris(project, cls, restrictions);
+        if (results == null || results.isEmpty()) {
+            throw new ObjNotFoundException(cls);
+        } else if (results.size() != 1) {
+            throw new NonUniqueObjException(cls, results);
+        }
+        return getObjByUri(results.iterator().next(), cls);
+    }
+
     /**
      * Find metadata by restrictions like identifier, title or summary.
      *

src/main/java/com/gooddata/md/Metric.java

@@ -18,7 +18,7 @@
 @JsonTypeInfo(include = JsonTypeInfo.As.WRAPPER_OBJECT, use = JsonTypeInfo.Id.NAME)
 @JsonIgnoreProperties(ignoreUnknown = true)
 @JsonSerialize(include = JsonSerialize.Inclusion.NON_NULL)
-public class Metric extends Obj implements Queryable {
+public class Metric extends AbstractObj implements Queryable {
 
     @JsonProperty("content")
     private final Content content;

src/main/java/com/gooddata/md/Obj.java

@@ -1,90 +1,15 @@
-/*
- * Copyright (C) 2007-2014, GoodData(R) Corporation. All rights reserved.
- */
 package com.gooddata.md;
 
-import org.codehaus.jackson.annotate.JsonIgnore;
-import org.codehaus.jackson.annotate.JsonProperty;
 import org.springframework.web.util.UriTemplate;
 
 /**
- * Metadata object (common part)
+ * Metadata object
  */
-public abstract class Obj {
-    public static final String URI = "/gdc/md/{projectId}/obj";
-    public static final String OBJ_URI = URI + "/{objId}";
-    public static final UriTemplate OBJ_TEMPLATE = new UriTemplate(OBJ_URI);
-
-    @JsonProperty("meta")
-    protected final Meta meta;
-
-    protected Obj(@JsonProperty("meta") Meta meta) {
-        this.meta = meta;
-    }
-
-    @JsonIgnore
-    public String getAuthor() {
-        return meta.getAuthor();
-    }
-
-    @JsonIgnore
-    public String getContributor() {
-        return meta.getContributor();
-    }
-
-    @JsonIgnore
-    public String getCreated() {
-        return meta.getCreated();
-    }
-
-    @JsonIgnore
-    public String getSummary() {
-        return meta.getSummary();
-    }
-
-    @JsonIgnore
-    public String getTitle() {
-        return meta.getTitle();
-    }
-
-    @JsonIgnore
-    public String getUpdated() {
-        return meta.getUpdated();
-    }
-
-    @JsonIgnore
-    public String getCategory() {
-        return meta.getCategory();
-    }
-
-    @JsonIgnore
-    public String getTags() {
-        return meta.getTags();
-    }
-
-    @JsonIgnore
-    public String getUri() {
-        return meta.getUri();
-    }
-
-    @JsonIgnore
-    public String getDeprecated() {
-        return meta.getDeprecated();
-    }
-
-    @JsonIgnore
-    public String getIdentifier() {
-        return meta.getIdentifier();
-    }
-
-    @JsonIgnore
-    public Integer getLocked() {
-        return meta.getLocked();
-    }
+public interface Obj {
 
-    @JsonIgnore
-    public Integer getUnlisted() {
-        return meta.getUnlisted();
-    }
+    String URI = "/gdc/md/{projectId}/obj";
+    String OBJ_URI = URI + "/{objId}";
+    UriTemplate OBJ_TEMPLATE = new UriTemplate(OBJ_URI);
 
+    String getUri();
 }

src/main/java/com/gooddata/md/Queryable.java

@@ -3,5 +3,5 @@
 /**
  * Marker interface for metadata objects which can be found using query resource (see MetadataService.find* methods).
  */
-public interface Queryable {
+public interface Queryable extends Obj {
 }