From 1c0aa39da5686b5dec38182bc0e304cfb8a80466 Mon Sep 17 00:00:00 2001
From: rjy7 <rjy7@440791e1-c2bf-4c1e-ad7c-caf3f8b0ebe8>
Date: Tue, 21 Dec 2010 13:41:09 +0000
Subject: [PATCH] NIHVIVO-1341 Added notes to list view config files on
 required and optional elements and how to structure the query. Removed
 edit-object since this can be derived from the ?subject ?property ?object
 statement in the query where clause.

---
 .../ObjectPropertyTemplateModel.java          |  3 ---
 webapp/web/config/listViewConfig-default.xml  | 21 ++++++++++++++++---
 .../dataPropertyList-statements.ftl           |  7 +++++++
 .../individual/individual-properties.ftl      |  8 +++----
 .../objectPropertyList-statements.ftl         |  1 +
 5 files changed, 29 insertions(+), 11 deletions(-)
 create mode 100644 webapp/web/templates/freemarker/body/partials/individual/dataPropertyList-statements.ftl

diff --git a/webapp/src/edu/cornell/mannlib/vitro/webapp/web/templatemodels/individual/ObjectPropertyTemplateModel.java b/webapp/src/edu/cornell/mannlib/vitro/webapp/web/templatemodels/individual/ObjectPropertyTemplateModel.java
index 2ee81ef9f..92e34c5df 100644
--- a/webapp/src/edu/cornell/mannlib/vitro/webapp/web/templatemodels/individual/ObjectPropertyTemplateModel.java
+++ b/webapp/src/edu/cornell/mannlib/vitro/webapp/web/templatemodels/individual/ObjectPropertyTemplateModel.java
@@ -91,13 +91,11 @@ public abstract class ObjectPropertyTemplateModel extends PropertyTemplateModel
         private static final String NODE_NAME_TEMPLATE = "template";
         private static final String NODE_NAME_COLLATION_TARGET = "collation-target";
         private static final String NODE_NAME_POSTPROCESSOR = "postprocessor";
-        private static final String NODE_NAME_EDIT_OBJECT = "edit-object";
         
         private String queryString;
         private String templateName;
         private String collationTarget;
         private String postprocessor;
-        private String editObject;
 
         PropertyListConfig(ObjectProperty op, VitroRequest vreq) throws Exception {
 
@@ -170,7 +168,6 @@ public abstract class ObjectPropertyTemplateModel extends PropertyTemplateModel
                 // Required values
                 queryString = getConfigValue(doc, NODE_NAME_QUERY);
                 templateName = getConfigValue(doc, NODE_NAME_TEMPLATE); 
-                editObject = getConfigValue(doc, NODE_NAME_EDIT_OBJECT);
                 
                 // Optional values
                 collationTarget = getConfigValue(doc, NODE_NAME_COLLATION_TARGET);
diff --git a/webapp/web/config/listViewConfig-default.xml b/webapp/web/config/listViewConfig-default.xml
index d03ee8b48..3fbe49483 100644
--- a/webapp/web/config/listViewConfig-default.xml
+++ b/webapp/web/config/listViewConfig-default.xml
@@ -1,5 +1,22 @@
 <?xml version="1.0" encoding="ISO-8859-1"?>
 <!-- $This file is distributed under the terms of the license in /doc/license.txt$ -->
+
+<!--
+    Required elements: 
+        - query: the sparql query used to retrieve the data
+        - template: the name of the template used to display a single property statement
+    
+    Optional elements: 
+        postprocessor: a Java class that postprocesses the data retrieved from the query before
+                       sending it to the template
+    
+    Query requirements:
+        - WHERE clause must contain a statement ?subject ?property ?objectvariable, with the variables
+          ?subject and ?property named as such. The objectvariable can be given any name, but it must be 
+          included in the SELECT terms retrieved by the query. This is the statement that will be edited 
+          from the edit links.
+-->
+
 <list-view-config>
     <query>    
         PREFIX vitro: &lt;http://vitro.mannlib.cornell.edu/ns/vitro/0.7#&gt;
@@ -13,9 +30,7 @@
     </query>
     
     <collation-target>object</collation-target>
-    
-    <edit-object>object</edit-object>
-    
+
     <postprocessor>edu.cornell.mannlib.vitro.webapp.web.templatemodels.individual.DefaultObjectPropertyDataPostprocessor</postprocessor>
     
     <template>propStatement-default.ftl</template>
diff --git a/webapp/web/templates/freemarker/body/partials/individual/dataPropertyList-statements.ftl b/webapp/web/templates/freemarker/body/partials/individual/dataPropertyList-statements.ftl
new file mode 100644
index 000000000..f484eb8b6
--- /dev/null
+++ b/webapp/web/templates/freemarker/body/partials/individual/dataPropertyList-statements.ftl
@@ -0,0 +1,7 @@
+<#-- $This file is distributed under the terms of the license in /doc/license.txt$ -->
+
+<#-- Template to list statements for a data property -->
+
+<#list property.statements as statement>
+    <li role="listitem">${statement.value}</li>
+</#list>
\ No newline at end of file
diff --git a/webapp/web/templates/freemarker/body/partials/individual/individual-properties.ftl b/webapp/web/templates/freemarker/body/partials/individual/individual-properties.ftl
index 1781a93db..fe3ea5a36 100644
--- a/webapp/web/templates/freemarker/body/partials/individual/individual-properties.ftl
+++ b/webapp/web/templates/freemarker/body/partials/individual/individual-properties.ftl
@@ -22,12 +22,10 @@
                     
                 <#-- List the statements for each property -->   
                 <ul class="property-list" role="list"> 
-                    <#-- data property -->                 
+                    <#-- data property -->  
                     <#if property.type == "data"> 
-                        <#list property.statements as statement>
-                            <li role="listitem">${statement.value}</li>
-                        </#list>
-                    
+                        <#include "dataPropertyList-statements.ftl">               
+
                     <#-- object property -->      
                     <#elseif property.collatedBySubclass>                             
                         <#include "objectPropertyList-collated.ftl">
diff --git a/webapp/web/templates/freemarker/body/partials/individual/objectPropertyList-statements.ftl b/webapp/web/templates/freemarker/body/partials/individual/objectPropertyList-statements.ftl
index 1b340ae21..ed5f5607d 100644
--- a/webapp/web/templates/freemarker/body/partials/individual/objectPropertyList-statements.ftl
+++ b/webapp/web/templates/freemarker/body/partials/individual/objectPropertyList-statements.ftl
@@ -1,6 +1,7 @@
 <#-- $This file is distributed under the terms of the license in /doc/license.txt$ -->
 
 <#-- Template to list statements for an object property -->
+
 <#list property.statements as statement>
     <li role="listitem">
         <#include "${property.template}">