Testing performance of external graph usage - performance patch

api/pom.xml

@@ -1,7 +1,4 @@
-<project
-    xmlns="http://maven.apache.org/POM/4.0.0"
-    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
 
     <modelVersion>4.0.0</modelVersion>
 
@@ -18,9 +15,41 @@
     </parent>
 
     <name>Vitro API</name>
-
     <build>
         <plugins>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-antrun-plugin</artifactId>
+                <version>3.1.0</version>
+                <executions>
+                    <execution>
+                        <id>echo-properties</id>
+                        <phase>validate</phase>
+                        <goals>
+                            <goal>run</goal>
+                        </goals>
+                        <configuration>
+                            <skip>false</skip>
+                            <target>
+                                <echo message="###################################################################" />
+                                <echo message="Displaying value of '${project.artifactId}' properties" />
+                                <echo message="###################################################################" />
+                                <echo message="[vitro-version]              ${vitro-version}" />
+                                <echo message="[vivo-version]               ${vivo-version}" />
+                                <echo message="[vivo-dir]                   ${vivo-dir}" />
+                                <echo message="[project.version]            ${project.version}" />
+                                <echo message="[java.vendor.version]        ${java.vendor.version}" />
+                                <echo message="[java.version]               ${java.version}" />
+                                <echo message="[java.specification.version] ${java.specification.version}" />
+                                <echo message="[maven.compiler.release]     ${maven.compiler.release}" />
+                                <echo message="[skip-samples-install]       ${skip-samples-install}" />
+                                <echo message="###################################################################" />
+                                <echo message="###################################################################" />
+                            </target>
+                        </configuration>
+                    </execution>
+                </executions>
+            </plugin>
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-surefire-plugin</artifactId>
@@ -108,4 +137,4 @@
             <scope>test</scope>
         </dependency>
     </dependencies>
-</project>
+</project>

api/src/main/java/edu/cornell/mannlib/vitro/webapp/controller/json/GetRenderedSearchIndividualsByVClass.java

@@ -5,6 +5,9 @@
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
+import java.util.concurrent.ExecutorService;
+import java.util.concurrent.Executors;
+import java.util.concurrent.TimeUnit;
 
 import com.fasterxml.jackson.databind.node.ArrayNode;
 import com.fasterxml.jackson.databind.node.ObjectNode;
@@ -20,70 +23,118 @@
 import edu.cornell.mannlib.vitro.webapp.services.shortview.ShortViewServiceSetup;
 
 /**
- * Does a search for individuals, and uses the short view to render each of
- * the results.
+ * Does a search for individuals, and uses the short view to render each of the
+ * results.
  */
 public class GetRenderedSearchIndividualsByVClass extends GetSearchIndividualsByVClasses {
-	private static final Log log = LogFactory
-			.getLog(GetRenderedSearchIndividualsByVClass.class);
+    private static final Log log = LogFactory.getLog(GetRenderedSearchIndividualsByVClass.class);
 
-	protected GetRenderedSearchIndividualsByVClass(VitroRequest vreq) {
-		super(vreq);
-	}
+    protected GetRenderedSearchIndividualsByVClass(VitroRequest vreq) {
+        super(vreq);
+    }
 
-	/**
-	 * Search for individuals by VClass or VClasses in the case of multiple parameters. The class URI(s) and the paging
-	 * information are in the request parameters.
-	 */
-	@Override
-	protected ObjectNode process() throws Exception {
-		ObjectNode rObj = null;
+    /**
+     * Search for individuals by VClass or VClasses in the case of multiple
+     * parameters. The class URI(s) and the paging information are in the request
+     * parameters.
+     */
+    @Override
+    protected ObjectNode process() throws Exception {
+        ObjectNode rObj = null;
 
-		//This gets the first vclass value and sets that as display type
-		List<String> vclassIds = super.getVclassIds(vreq);
-		String vclassId = null;
-		if(vclassIds.size() > 1) {
-			//This ensures the second class instead of the first
-			//This is a temporary fix in cases where institutional internal classes are being sent in
-			//and thus the second class is the actual class with display information associated
-			vclassId = vclassIds.get(1);
-		} else {
-			vclassId = vclassIds.get(0);
-		}
-		vreq.setAttribute("displayType", vclassId);
+        // This gets the first vclass value and sets that as display type
+        List<String> vclassIds = super.getVclassIds(vreq);
+        String vclassId = null;
+        if (vclassIds.size() > 1) {
+            // This ensures the second class instead of the first
+            // This is a temporary fix in cases where institutional internal classes are
+            // being sent in
+            // and thus the second class is the actual class with display information
+            // associated
+            vclassId = vclassIds.get(1);
+        } else {
+            vclassId = vclassIds.get(0);
+        }
+        vreq.setAttribute("displayType", vclassId);
 
-		//This will get all the solr individuals by VClass (if one value) or the intersection
-		//i.e. individuals that have all the types for the different vclasses entered
-		rObj = super.process();
-		addShortViewRenderings(rObj);
-		return rObj;
-	}
+        // This will get all the solr individuals by VClass (if one value) or the
+        // intersection
+        // i.e. individuals that have all the types for the different vclasses entered
+        rObj = super.process();
+        addShortViewRenderings(rObj);
+        return rObj;
+    }
 
-	/**
-	 * Look through the return object. For each individual, render the short
-	 * view and insert the resulting HTML into the object.
-	 */
-	private void addShortViewRenderings(ObjectNode rObj) {
-		ArrayNode individuals = (ArrayNode) rObj.get("individuals");
-		String vclassName = rObj.get("vclass").get("name").asText();
-		for (int i = 0; i < individuals.size(); i++) {
-			ObjectNode individual = (ObjectNode) individuals.get(i);
-			individual.put("shortViewHtml",
-					renderShortView(individual.get("URI").asText(), vclassName));
-		}
-	}
+    /**
+     * Look through the return object. For each individual, render the short view
+     * and insert the resulting HTML into the object.
+     * ORIGINAL CODE 
+     * This code segment is never called. 
+     * It is kept for the time being for performance comparison tests. 
+     * It should be deleted when PR is accepted.
+     */
+    private void addShortViewRenderings_ORIG(ObjectNode rObj) {
+        ArrayNode individuals = (ArrayNode) rObj.get("individuals");
+        String vclassName = rObj.get("vclass").get("name").asText();
+        for (int i = 0; i < individuals.size(); i++) {
+            ObjectNode individual = (ObjectNode) individuals.get(i);
+            individual.put("shortViewHtml", renderShortView(individual.get("URI").asText(), vclassName));
+        }
+    }
 
-	private String renderShortView(String individualUri, String vclassName) {
-		IndividualDao iDao = vreq.getWebappDaoFactory().getIndividualDao();
-		Individual individual = iDao.getIndividualByURI(individualUri);
+    /**
+     * Look through the return object. For each individual, render the short view
+     * and insert the resulting HTML into the object.
+     * The use of multi treading allows to submit the requests and the processing in 
+     * parallel of the necessary elements to the html objects of the page. 
+     * Parallel processing allows to use the network bandwidth to the maximum
+     */
+    private void addShortViewRenderings(ObjectNode rObj) {
 
-		Map<String, Object> modelMap = new HashMap<String, Object>();
-		modelMap.put("individual",
-				IndividualTemplateModelBuilder.build(individual, vreq));
-		modelMap.put("vclass", vclassName);
+        ArrayNode individuals = (ArrayNode) rObj.get("individuals");
+        String vclassName = rObj.get("vclass").get("name").asText();
+        int indvSize = individuals.size();
+        ExecutorService es = Executors.newFixedThreadPool(indvSize);
+        for (int i = 0; i < indvSize; i++) {
+            ObjectNode individual = (ObjectNode) individuals.get(i);
+               ProcessIndividual pi = new ProcessIndividual();
+               pi.setIndividual(individual);
+               pi.setVclassName(vclassName);
+               es.execute(pi);
+        }
+        es.shutdown();
+        try {
+            while(!es.awaitTermination(250, TimeUnit.MILLISECONDS)){
+            }
+        } catch (InterruptedException e1) {
+        }
+    }
+    private class ProcessIndividual implements Runnable {
+        private ObjectNode individual = null;
+        private String vclassName;
+        public String getVclassName() {
+            return vclassName;
+        }
+        public void setVclassName(String vclassName) {
+            this.vclassName = vclassName;
+        }
+        // Method
+        public void run() {
+            individual.put("shortViewHtml", renderShortView(individual.get("URI").asText(), vclassName));
+        }
+        public void setIndividual(ObjectNode individual) {
+            this.individual = individual;
+        }
+    }
+    private String renderShortView(String individualUri, String vclassName) {
+        IndividualDao iDao = vreq.getWebappDaoFactory().getIndividualDao();
+        Individual individual = iDao.getIndividualByURI(individualUri);
 
-		ShortViewService svs = ShortViewServiceSetup.getService(ctx);
-		return svs.renderShortView(individual, ShortViewContext.BROWSE,
-				modelMap, vreq);
-	}
+        Map<String, Object> modelMap = new HashMap<String, Object>();
+        modelMap.put("individual", IndividualTemplateModelBuilder.build(individual, vreq));
+        modelMap.put("vclass", vclassName);
+
+        ShortViewService svs = ShortViewServiceSetup.getService(ctx);
+        return svs.renderShortView(individual, ShortViewContext.BROWSE, modelMap, vreq);
+    }
 }