Changeset 24812 for main/trunk/greenstone3

Timestamp:

2011-11-14T13:01:00+13:00 (12 years ago)

Author:

sjm84

Message:

Reformatting this for some modifications

File:

• main/trunk/greenstone3/src/java/org/greenstone/gsdl3/action/DocumentAction.java (modified) (50 diffs)

main/trunk/greenstone3/src/java/org/greenstone/gsdl3/action/DocumentAction.java

@@ -1 +1 @@
 /*
-*    DocumentAction.java
-*    Copyright (C) 2002 New Zealand Digital Library, http://www.nzdl.org
-*
-*    This program is free software; you can redistribute it and/or modify
-*    it under the terms of the GNU General Public License as published by
-*    the Free Software Foundation; either version 2 of the License, or
-*    (at your option) any later version.
-*
-*    This program is distributed in the hope that it will be useful,
-*    but WITHOUT ANY WARRANTY; without even the implied warranty of
-*    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-*    GNU General Public License for more details.
-*
-*    You should have received a copy of the GNU General Public License
-*    along with this program; if not, write to the Free Software
-*    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
-*/
+ *    DocumentAction.java
+ *    Copyright (C) 2002 New Zealand Digital Library, http://www.nzdl.org
+ *
+ *    This program is free software; you can redistribute it and/or modify
+ *    it under the terms of the GNU General Public License as published by
+ *    the Free Software Foundation; either version 2 of the License, or
+ *    (at your option) any later version.
+ *
+ *    This program is distributed in the hope that it will be useful,
+ *    but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *    GNU General Public License for more details.
+ *
+ *    You should have received a copy of the GNU General Public License
+ *    along with this program; if not, write to the Free Software
+ *    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+ */
 package org.greenstone.gsdl3.action;
 
@@ -24 +24 @@
 
 // XML classes
-import org.w3c.dom.Document; 
-import org.w3c.dom.Element; 
-import org.w3c.dom.Node; 
+import org.w3c.dom.Document;
+import org.w3c.dom.Element;
+import org.w3c.dom.Node;
 import org.w3c.dom.Text;
 import org.w3c.dom.NodeList;
@@ -38 +38 @@
 import org.apache.log4j.*;
 
-/** Action class for retrieving Documents  via the message router
-*/
-public class DocumentAction extends Action {
+/** Action class for retrieving Documents via the message router */
+public class DocumentAction extends Action
+{
 
     static Logger logger = Logger.getLogger(org.greenstone.gsdl3.action.DocumentAction.class.getName());
@@ -48 +48 @@
     public static final String GOTO_PAGE_ARG = "gp";
     public static final String ENRICH_DOC_ARG = "end";
-    
-    /** if this is set to true, when a document is displayed, any annotation
-    * type services (enrich) will be offered to the user as well */
-    protected boolean provide_annotations = false; 
-    
+
+    /**
+     * if this is set to true, when a document is displayed, any annotation type
+     * services (enrich) will be offered to the user as well
+     */
+    protected boolean provide_annotations = false;
+
     protected boolean highlight_query_terms = false;
 
-    public boolean configure() {
+    public boolean configure()
+    {
         super.configure();
-        String highlight = (String)config_params.get("highlightQueryTerms");
-        if (highlight != null && highlight.equals("true")) {
+        String highlight = (String) config_params.get("highlightQueryTerms");
+        if (highlight != null && highlight.equals("true"))
+        {
             highlight_query_terms = true;
         }
-        String annotate = (String)config_params.get("displayAnnotationService");
-        if (annotate != null && annotate.equals("true")) {
+        String annotate = (String) config_params.get("displayAnnotationService");
+        if (annotate != null && annotate.equals("true"))
+        {
             provide_annotations = true;
         }
         return true;
     }
-    public Node process (Node message_node)
+
+    public Node process(Node message_node)
     {
         // for now, no subaction eventually we may want to have subactions such as text assoc or something ?
-        
+
         Element message = this.converter.nodeToElement(message_node);
 
@@ -79 +85 @@
 
         // get the request - assume only one
-        Element request = (Element)GSXML.getChildByTagName(message, GSXML.REQUEST_ELEM);
-        Element cgi_paramList = (Element)GSXML.getChildByTagName(request, GSXML.PARAM_ELEM+GSXML.LIST_MODIFIER);
+        Element request = (Element) GSXML.getChildByTagName(message, GSXML.REQUEST_ELEM);
+        Element cgi_paramList = (Element) GSXML.getChildByTagName(request, GSXML.PARAM_ELEM + GSXML.LIST_MODIFIER);
         HashMap params = GSXML.extractParams(cgi_paramList, false);
 
         // just in case there are some that need to get passed to the services
-        HashMap service_params = (HashMap)params.get("s0"); 
-
-        
+        HashMap service_params = (HashMap) params.get("s0");
+
         String has_rl = null;
         String has_href = null;
@@ -95 +100 @@
         String uid = request.getAttribute(GSXML.USER_ID_ATT);
         String document_name = (String) params.get(GSParams.DOCUMENT);
-        if ((document_name == null || document_name.equals("")) && (has_href == null || has_href.equals(""))) {
+        if ((document_name == null || document_name.equals("")) && (has_href == null || has_href.equals("")))
+        {
             logger.error("no document specified!");
             return result;
         }
         String document_type = (String) params.get(GSParams.DOCUMENT_TYPE);
-        if (document_type == null) {
+        if (document_type == null)
+        {
             document_type = "simple";
         }
@@ -106 +113 @@
         boolean get_siblings = false;
         String sibs = (String) params.get(SIBLING_ARG);
-        if (sibs != null && sibs.equals("1")) {
+        if (sibs != null && sibs.equals("1"))
+        {
             get_siblings = true;
         }
-        
+
         String sibling_num = (String) params.get(GOTO_PAGE_ARG);
-        if (sibling_num != null && !sibling_num.equals("")) {
+        if (sibling_num != null && !sibling_num.equals(""))
+        {
             // we have to modify the doc name
-            document_name = document_name+"."+sibling_num+".ss";
-        }
-        
+            document_name = document_name + "." + sibling_num + ".ss";
+        }
+
         boolean expand_document = false;
         String ed_arg = (String) params.get(GSParams.EXPAND_DOCUMENT);
-        if (ed_arg != null && ed_arg.equals("1")) {
+        if (ed_arg != null && ed_arg.equals("1"))
+        {
             expand_document = true;
         }
-        
 
         boolean expand_contents = false;
-        if (expand_document) { // we always expand the contents with the text
+        if (expand_document)
+        { // we always expand the contents with the text
             expand_contents = true;
-        } else {
+        }
+        else
+        {
             String ec_arg = (String) params.get(GSParams.EXPAND_CONTENTS);
-            if (ec_arg != null && ec_arg.equals("1")) {
+            if (ec_arg != null && ec_arg.equals("1"))
+            {
                 expand_contents = true;
             }
@@ -134 +147 @@
 
         //append site metadata
-        addSiteMetadata( page_response, lang, uid);
+        addSiteMetadata(page_response, lang, uid);
 
         // get the additional data needed for the page
         getBackgroundData(page_response, collection, lang, uid);
-        Element format_elem = (Element)GSXML.getChildByTagName(page_response, GSXML.FORMAT_ELEM);
-        
+        Element format_elem = (Element) GSXML.getChildByTagName(page_response, GSXML.FORMAT_ELEM);
+
         // the_document is where all the doc info - structure and metadata etc
         // is added into, to be returned in the page
@@ -149 +162 @@
 
         // create a basic doc list containing the current node
-        Element basic_doc_list = this.doc.createElement(GSXML.DOC_NODE_ELEM+GSXML.LIST_MODIFIER);
+        Element basic_doc_list = this.doc.createElement(GSXML.DOC_NODE_ELEM + GSXML.LIST_MODIFIER);
         Element current_doc = this.doc.createElement(GSXML.DOC_NODE_ELEM);
         basic_doc_list.appendChild(current_doc);
-        if (document_name.length()!=0){
+        if (document_name.length() != 0)
+        {
             current_doc.setAttribute(GSXML.NODE_ID_ATT, document_name);
-        }else if (has_href.length()!=0){
+        }
+        else if (has_href.length() != 0)
+        {
             current_doc.setAttribute(GSXML.NODE_ID_ATT, has_href);
             current_doc.setAttribute("externalURL", has_rl);
@@ -160 +176 @@
 
         // Create a parameter list to specify the required structure information
-        Element ds_param_list = this.doc.createElement(GSXML.PARAM_ELEM+GSXML.LIST_MODIFIER);
-        
-        if (service_params != null) {
+        Element ds_param_list = this.doc.createElement(GSXML.PARAM_ELEM + GSXML.LIST_MODIFIER);
+
+        if (service_params != null)
+        {
             GSXML.addParametersToList(this.doc, ds_param_list, service_params);
         }
 
-        Element ds_param = null; 
+        Element ds_param = null;
         boolean get_structure = false;
         boolean get_structure_info = false;
-        if (document_type.equals("paged")) {
+        if (document_type.equals("paged"))
+        {
             get_structure_info = true;
             // get teh info needed for paged naviagtion
@@ -184 +202 @@
             ds_param.setAttribute(GSXML.NAME_ATT, "info");
             ds_param.setAttribute(GSXML.VALUE_ATT, "siblingPosition");
-            
-        } else if (document_type.equals("hierarchy")){
+
+        }
+        else if (document_type.equals("hierarchy"))
+        {
             get_structure = true;
-            if (expand_contents) {
+            if (expand_contents)
+            {
                 ds_param = this.doc.createElement(GSXML.PARAM_ELEM);
                 ds_param_list.appendChild(ds_param);
                 ds_param.setAttribute(GSXML.NAME_ATT, "structure");
                 ds_param.setAttribute(GSXML.VALUE_ATT, "entire");
-            } else {
+            }
+            else
+            {
                 // get the info needed for table of contents
                 ds_param = this.doc.createElement(GSXML.PARAM_ELEM);
@@ -202 +225 @@
                 ds_param.setAttribute(GSXML.NAME_ATT, "structure");
                 ds_param.setAttribute(GSXML.VALUE_ATT, "children");
-                if (get_siblings) {
+                if (get_siblings)
+                {
                     ds_param = this.doc.createElement(GSXML.PARAM_ELEM);
                     ds_param_list.appendChild(ds_param);
@@ -209 +233 @@
                 }
             }
-        } else {
+        }
+        else
+        {
             // we dont need any structure
         }
 
         boolean has_dummy = false;
-        if (get_structure || get_structure_info) {
+        if (get_structure || get_structure_info)
+        {
 
             // Build a request to obtain the document structure
             Element ds_message = this.doc.createElement(GSXML.MESSAGE_ELEM);
             String to = GSPath.appendLink(collection, "DocumentStructureRetrieve");// Hard-wired?
-            Element ds_request = GSXML.createBasicRequest(this.doc,GSXML.REQUEST_TYPE_PROCESS, to, lang, uid); 
+            Element ds_request = GSXML.createBasicRequest(this.doc, GSXML.REQUEST_TYPE_PROCESS, to, lang, uid);
             ds_message.appendChild(ds_request);
             ds_request.appendChild(ds_param_list);
-            
+
             // create a doc_node_list and put in the doc_node that we are interested in
             ds_request.appendChild(basic_doc_list);
-            
+
             // Process the document structure retrieve message
             Element ds_response_message = (Element) this.mr.process(ds_message);
-            if (processErrorElements(ds_response_message, page_response)) {
+            if (processErrorElements(ds_response_message, page_response))
+            {
                 return result;
             }
 
             // get the info and print out
-            String path = GSPath.appendLink(GSXML.RESPONSE_ELEM, GSXML.DOC_NODE_ELEM+GSXML.LIST_MODIFIER);
+            String path = GSPath.appendLink(GSXML.RESPONSE_ELEM, GSXML.DOC_NODE_ELEM + GSXML.LIST_MODIFIER);
             path = GSPath.appendLink(path, GSXML.DOC_NODE_ELEM);
             path = GSPath.appendLink(path, "nodeStructureInfo");
             Element ds_response_struct_info = (Element) GSXML.getNodeByPath(ds_response_message, path);
             // get the doc_node bit 
-            if (ds_response_struct_info != null) {
-                the_document.appendChild(this.doc.importNode(ds_response_struct_info, true)); 
-            }
-            path = GSPath.appendLink(GSXML.RESPONSE_ELEM, GSXML.DOC_NODE_ELEM+GSXML.LIST_MODIFIER);
+            if (ds_response_struct_info != null)
+            {
+                the_document.appendChild(this.doc.importNode(ds_response_struct_info, true));
+            }
+            path = GSPath.appendLink(GSXML.RESPONSE_ELEM, GSXML.DOC_NODE_ELEM + GSXML.LIST_MODIFIER);
             path = GSPath.appendLink(path, GSXML.DOC_NODE_ELEM);
             path = GSPath.appendLink(path, GSXML.NODE_STRUCTURE_ELEM);
             Element ds_response_structure = (Element) GSXML.getNodeByPath(ds_response_message, path);
-            
-            if (ds_response_structure != null) {
+
+            if (ds_response_structure != null)
+            {
                 // add the contents of the structure bit into the_document
                 NodeList structs = ds_response_structure.getChildNodes();
-                for (int i=0; i<structs.getLength();i++) {
+                for (int i = 0; i < structs.getLength(); i++)
+                {
                     the_document.appendChild(this.doc.importNode(structs.item(i), true));
                 }
-            } else {
+            }
+            else
+            {
                 // no structure nodes, so put in a dummy doc node
                 Element doc_node = this.doc.createElement(GSXML.DOC_NODE_ELEM);
-                if (document_name.length()!=0){
+                if (document_name.length() != 0)
+                {
                     doc_node.setAttribute(GSXML.NODE_ID_ATT, document_name);
-                }else if (has_href.length()!=0){
+                }
+                else if (has_href.length() != 0)
+                {
                     doc_node.setAttribute(GSXML.NODE_ID_ATT, has_href);
                     doc_node.setAttribute("externalURL", has_rl);
@@ -264 +300 @@
                 has_dummy = true;
             }
-        } else { // a simple type - we dont have a dummy node for simple
+        }
+        else
+        { // a simple type - we dont have a dummy node for simple
             // should think about this more
             // no structure request, so just put in a dummy doc node
             Element doc_node = this.doc.createElement(GSXML.DOC_NODE_ELEM);
-            if (document_name.length()!=0){
+            if (document_name.length() != 0)
+            {
                 doc_node.setAttribute(GSXML.NODE_ID_ATT, document_name);
-            }else if (has_href.length()!=0){
+            }
+            else if (has_href.length() != 0)
+            {
                 doc_node.setAttribute(GSXML.NODE_ID_ATT, has_href);
                 doc_node.setAttribute("externalURL", has_rl);
@@ -277 +318 @@
             has_dummy = true;
         }
-        
+
         // Build a request to obtain some document metadata
         Element dm_message = this.doc.createElement(GSXML.MESSAGE_ELEM);
-        String to = GSPath.appendLink(collection, "DocumentMetadataRetrieve");  // Hard-wired?
+        String to = GSPath.appendLink(collection, "DocumentMetadataRetrieve"); // Hard-wired?
         Element dm_request = GSXML.createBasicRequest(this.doc, GSXML.REQUEST_TYPE_PROCESS, to, lang, uid);
         dm_message.appendChild(dm_request);
         // Create a parameter list to specify the required metadata information
-        
+
         HashSet meta_names = new HashSet();
         meta_names.add("Title"); // the default
-        if (format_elem != null) {
+        if (format_elem != null)
+        {
             extractMetadataNames(format_elem, meta_names);
         }
-        
+
         Element dm_param_list = createMetadataParamList(meta_names);
-        if (service_params != null) {
+        if (service_params != null)
+        {
             GSXML.addParametersToList(this.doc, dm_param_list, service_params);
         }
-        
+
         dm_request.appendChild(dm_param_list);
-        
-        
+
         // create the doc node list for the metadata request
-        Element dm_doc_list = this.doc.createElement(GSXML.DOC_NODE_ELEM+GSXML.LIST_MODIFIER);
+        Element dm_doc_list = this.doc.createElement(GSXML.DOC_NODE_ELEM + GSXML.LIST_MODIFIER);
         dm_request.appendChild(dm_doc_list);
 
         // Add each node from the structure response into the metadata request
         NodeList doc_nodes = the_document.getElementsByTagName(GSXML.DOC_NODE_ELEM);
-        for (int i = 0; i < doc_nodes.getLength(); i++) {
+        for (int i = 0; i < doc_nodes.getLength(); i++)
+        {
             Element doc_node = (Element) doc_nodes.item(i);
             String doc_node_id = doc_node.getAttribute(GSXML.NODE_ID_ATT);
@@ -313 +356 @@
             dm_doc_list.appendChild(dm_doc_node);
             dm_doc_node.setAttribute(GSXML.NODE_ID_ATT, doc_node_id);
-            dm_doc_node.setAttribute(GSXML.NODE_TYPE_ATT,
-            doc_node.getAttribute(GSXML.NODE_TYPE_ATT));
+            dm_doc_node.setAttribute(GSXML.NODE_TYPE_ATT, doc_node.getAttribute(GSXML.NODE_TYPE_ATT));
         }
 
@@ -321 +363 @@
         Element doc_meta_request = GSXML.createBasicRequest(this.doc, GSXML.REQUEST_TYPE_PROCESS, to, lang, uid);
         dm_message.appendChild(doc_meta_request);
-        Element doc_meta_param_list = this.doc.createElement(GSXML.PARAM_ELEM+GSXML.LIST_MODIFIER);
-        if (service_params != null) {
+        Element doc_meta_param_list = this.doc.createElement(GSXML.PARAM_ELEM + GSXML.LIST_MODIFIER);
+        if (service_params != null)
+        {
             GSXML.addParametersToList(this.doc, doc_meta_param_list, service_params);
         }
@@ -333 +376 @@
 
         // create the doc node list for the metadata request
-        Element doc_list = this.doc.createElement(GSXML.DOC_NODE_ELEM+GSXML.LIST_MODIFIER);
+        Element doc_list = this.doc.createElement(GSXML.DOC_NODE_ELEM + GSXML.LIST_MODIFIER);
         doc_meta_request.appendChild(doc_list);
 
         Element doc_node = this.doc.createElement(GSXML.DOC_NODE_ELEM);
         // the node we want is the root document node
-        if (document_name.length()!=0){
-            doc_node.setAttribute(GSXML.NODE_ID_ATT, document_name+".rt");
-        }else if (has_href.length()!=0){
-            doc_node.setAttribute(GSXML.NODE_ID_ATT, has_href+".rt"); 
+        if (document_name.length() != 0)
+        {
+            doc_node.setAttribute(GSXML.NODE_ID_ATT, document_name + ".rt");
+        }
+        else if (has_href.length() != 0)
+        {
+            doc_node.setAttribute(GSXML.NODE_ID_ATT, has_href + ".rt");
             doc_node.setAttribute("externalURL", has_rl);
         }
         doc_list.appendChild(doc_node);
         Element dm_response_message = (Element) this.mr.process(dm_message);
-        if (processErrorElements(dm_response_message, page_response)) {
+        if (processErrorElements(dm_response_message, page_response))
+        {
             return result;
         }
 
-        String path = GSPath.appendLink(GSXML.RESPONSE_ELEM, GSXML.DOC_NODE_ELEM+GSXML.LIST_MODIFIER);
+        String path = GSPath.appendLink(GSXML.RESPONSE_ELEM, GSXML.DOC_NODE_ELEM + GSXML.LIST_MODIFIER);
         Element dm_response_doc_list = (Element) GSXML.getNodeByPath(dm_response_message, path);
 
         // Merge the metadata with the structure information
         NodeList dm_response_docs = dm_response_doc_list.getChildNodes();
-        for (int i = 0; i < doc_nodes.getLength(); i++) {
+        for (int i = 0; i < doc_nodes.getLength(); i++)
+        {
             GSXML.mergeMetadataLists(doc_nodes.item(i), dm_response_docs.item(i));
         }
         // get the top level doc metadata out
-        Element doc_meta_response = (Element)dm_response_message.getElementsByTagName(GSXML.RESPONSE_ELEM).item(1);
-        Element top_doc_node = (Element)GSXML.getNodeByPath(doc_meta_response, "documentNodeList/documentNode");
+        Element doc_meta_response = (Element) dm_response_message.getElementsByTagName(GSXML.RESPONSE_ELEM).item(1);
+        Element top_doc_node = (Element) GSXML.getNodeByPath(doc_meta_response, "documentNodeList/documentNode");
         GSXML.mergeMetadataLists(the_document, top_doc_node);
-        
+
         // Build a request to obtain some document content
         Element dc_message = this.doc.createElement(GSXML.MESSAGE_ELEM);
-        to = GSPath.appendLink(collection, "DocumentContentRetrieve");  // Hard-wired?
+        to = GSPath.appendLink(collection, "DocumentContentRetrieve"); // Hard-wired?
         Element dc_request = GSXML.createBasicRequest(this.doc, GSXML.REQUEST_TYPE_PROCESS, to, lang, uid);
         dc_message.appendChild(dc_request);
-        
 
         // Create a parameter list to specify the request parameters - empty for now
-        Element dc_param_list = this.doc.createElement(GSXML.PARAM_ELEM+GSXML.LIST_MODIFIER);
-        if (service_params != null) {
+        Element dc_param_list = this.doc.createElement(GSXML.PARAM_ELEM + GSXML.LIST_MODIFIER);
+        if (service_params != null)
+        {
             GSXML.addParametersToList(this.doc, dc_param_list, service_params);
         }
@@ -380 +428 @@
         // get the content
         // the doc list for the content request is the same as the one for the structure request unless we want the whole document, in which case its the same as for the metadata request.
-        if (expand_document) {
+        if (expand_document)
+        {
             dc_request.appendChild(dm_doc_list);
-        } else {
+        }
+        else
+        {
             dc_request.appendChild(basic_doc_list);
         }
-        logger.debug("request = "+converter.getString(dc_message));
+        logger.debug("request = " + converter.getString(dc_message));
         Element dc_response_message = (Element) this.mr.process(dc_message);
-        if (processErrorElements(dc_response_message, page_response)) {
+        if (processErrorElements(dc_response_message, page_response))
+        {
             return result;
         }
@@ -393 +445 @@
         Element dc_response_doc_list = (Element) GSXML.getNodeByPath(dc_response_message, path);
 
-        if (expand_document) {
+        if (expand_document)
+        {
             // Merge the content with the structure information
             NodeList dc_response_docs = dc_response_doc_list.getChildNodes();
-            for (int i = 0; i < doc_nodes.getLength(); i++) {
-                Node content = GSXML.getChildByTagName((Element)dc_response_docs.item(i), "nodeContent");
-                if (content != null) {
-                    if (highlight_query_terms) {
-                        content = highlightQueryTerms(request, (Element)content);
+            for (int i = 0; i < doc_nodes.getLength(); i++)
+            {
+                Node content = GSXML.getChildByTagName((Element) dc_response_docs.item(i), "nodeContent");
+                if (content != null)
+                {
+                    if (highlight_query_terms)
+                    {
+                        content = highlightQueryTerms(request, (Element) content);
                     }
                     doc_nodes.item(i).appendChild(this.doc.importNode(content, true));
@@ -406 +462 @@
                 //GSXML.mergeMetadataLists(doc_nodes.item(i), dm_response_docs.item(i));
             }
-        } else {
+        }
+        else
+        {
             //path = GSPath.appendLink(path, GSXML.DOC_NODE_ELEM);
             Element dc_response_doc = (Element) GSXML.getChildByTagName(dc_response_doc_list, GSXML.DOC_NODE_ELEM);
             Element dc_response_doc_content = (Element) GSXML.getChildByTagName(dc_response_doc, GSXML.NODE_CONTENT_ELEM);
             Element dc_response_doc_external = (Element) GSXML.getChildByTagName(dc_response_doc, "external");
-            
-            if (dc_response_doc_content == null) {
+
+            if (dc_response_doc_content == null)
+            {
                 // no content to add
-                if (dc_response_doc_external !=null){
+                if (dc_response_doc_external != null)
+                {
                     String modified_doc_id = dc_response_doc.getAttribute(GSXML.NODE_ID_ATT);
-                    
+
                     the_document.setAttribute("selectedNode", modified_doc_id);
                     the_document.setAttribute("external", dc_response_doc_external.getAttribute("external_link"));
@@ -422 +482 @@
                 return result;
             }
-            if (highlight_query_terms) {
+            if (highlight_query_terms)
+            {
                 dc_response_doc.removeChild(dc_response_doc_content);
-                
+
                 dc_response_doc_content = highlightQueryTerms(request, dc_response_doc_content);
                 dc_response_doc.appendChild(dc_response_doc.getOwnerDocument().importNode(dc_response_doc_content, true));
             }
-            
-            
-            if (provide_annotations) {
-                String service_selected = (String)params.get(ENRICH_DOC_ARG);
-                if (service_selected != null && service_selected.equals("1")) {
+
+            if (provide_annotations)
+            {
+                String service_selected = (String) params.get(ENRICH_DOC_ARG);
+                if (service_selected != null && service_selected.equals("1"))
+                {
                     // now we can modifiy the response doc if needed
-                    String enrich_service = (String)params.get(GSParams.SERVICE);
+                    String enrich_service = (String) params.get(GSParams.SERVICE);
                     // send a message to the service
                     Element enrich_message = this.doc.createElement(GSXML.MESSAGE_ELEM);
@@ -440 +502 @@
                     enrich_message.appendChild(enrich_request);
                     // check for parameters
-                    HashMap e_service_params = (HashMap)params.get("s1");
-                    if (e_service_params != null) { 
-                        Element enrich_pl = this.doc.createElement(GSXML.PARAM_ELEM+GSXML.LIST_MODIFIER);
-                        GSXML.addParametersToList(this.doc, enrich_pl, e_service_params); 
+                    HashMap e_service_params = (HashMap) params.get("s1");
+                    if (e_service_params != null)
+                    {
+                        Element enrich_pl = this.doc.createElement(GSXML.PARAM_ELEM + GSXML.LIST_MODIFIER);
+                        GSXML.addParametersToList(this.doc, enrich_pl, e_service_params);
                         enrich_request.appendChild(enrich_pl);
                     }
-                    Element e_doc_list = this.doc.createElement(GSXML.DOC_NODE_ELEM+GSXML.LIST_MODIFIER);
+                    Element e_doc_list = this.doc.createElement(GSXML.DOC_NODE_ELEM + GSXML.LIST_MODIFIER);
                     enrich_request.appendChild(e_doc_list);
                     e_doc_list.appendChild(this.doc.importNode(dc_response_doc, true));
-                    
+
                     Node enrich_response = this.mr.process(enrich_message);
-                    
-                    String [] links = {GSXML.RESPONSE_ELEM, GSXML.DOC_NODE_ELEM+GSXML.LIST_MODIFIER, GSXML.DOC_NODE_ELEM, GSXML.NODE_CONTENT_ELEM};
+
+                    String[] links = { GSXML.RESPONSE_ELEM, GSXML.DOC_NODE_ELEM + GSXML.LIST_MODIFIER, GSXML.DOC_NODE_ELEM, GSXML.NODE_CONTENT_ELEM };
                     path = GSPath.createPath(links);
-                    dc_response_doc_content = (Element)GSXML.getNodeByPath(enrich_response, path);
-                    
-                } 
+                    dc_response_doc_content = (Element) GSXML.getNodeByPath(enrich_response, path);
+
+                }
             } // if provide_annotations
 
-            
             // use the returned id rather than the sent one cos there may have
             // been modifiers such as .pr that are removed.
             String modified_doc_id = dc_response_doc.getAttribute(GSXML.NODE_ID_ATT);
             the_document.setAttribute("selectedNode", modified_doc_id);
-            if (has_dummy) {
+            if (has_dummy)
+            {
                 // change the id if necessary and add the content
-                Element dummy_node = (Element)doc_nodes.item(0);
-                
+                Element dummy_node = (Element) doc_nodes.item(0);
+
                 dummy_node.setAttribute(GSXML.NODE_ID_ATT, modified_doc_id);
                 dummy_node.appendChild(this.doc.importNode(dc_response_doc_content, true));
                 // hack for simple type
-                if (document_type.equals("simple")) {
+                if (document_type.equals("simple"))
+                {
                     // we dont want the internal docNode, just want the content and metadata in the document
                     // rethink this!!
@@ -478 +542 @@
                     NodeList dummy_children = dummy_node.getChildNodes();
                     //for (int i=0; i<dummy_children.getLength(); i++) {
-                    for (int i=dummy_children.getLength()-1; i>=0; i--) {
+                    for (int i = dummy_children.getLength() - 1; i >= 0; i--)
+                    {
                         // special case as we don't want more than one metadata list
-                        if (dummy_children.item(i).getNodeName().equals(GSXML.METADATA_ELEM+GSXML.LIST_MODIFIER)) {
+                        if (dummy_children.item(i).getNodeName().equals(GSXML.METADATA_ELEM + GSXML.LIST_MODIFIER))
+                        {
                             GSXML.mergeMetadataFromList(the_document, dummy_children.item(i));
-                        } else {
+                        }
+                        else
+                        {
                             the_document.appendChild(dummy_children.item(i));
                         }
                     }
                 }
-            } else {
+            }
+            else
+            {
                 // Merge the document content with the metadata and structure information
-                for (int i = 0; i < doc_nodes.getLength(); i++) {
+                for (int i = 0; i < doc_nodes.getLength(); i++)
+                {
                     Node dn = doc_nodes.item(i);
-                    String dn_id = ((Element)dn).getAttribute(GSXML.NODE_ID_ATT);
-                    if (dn_id.equals(modified_doc_id)) {
+                    String dn_id = ((Element) dn).getAttribute(GSXML.NODE_ID_ATT);
+                    if (dn_id.equals(modified_doc_id))
+                    {
                         dn.appendChild(this.doc.importNode(dc_response_doc_content, true));
                         break;
@@ -502 +574 @@
         return result;
     }
-    
-    /** tell the param class what its arguments are 
-    * if an action has its own arguments, this should add them to the params
-    * object - particularly important for args that should not be saved */
-    public boolean getActionParameters(GSParams params) {
+
+    /**
+     * tell the param class what its arguments are if an action has its own
+     * arguments, this should add them to the params object - particularly
+     * important for args that should not be saved
+     */
+    public boolean getActionParameters(GSParams params)
+    {
         params.addParameter(GOTO_PAGE_ARG, false);
         params.addParameter(ENRICH_DOC_ARG, false);
@@ -512 +587 @@
     }
 
-
-    /** this method gets the collection description, the format info, the
-    * list of enrich services, etc - stuff that is needed for the page,
-    * but is the same whatever the query is - should be cached */
-    protected  boolean getBackgroundData(Element page_response, 
-    String collection, String lang,
-    String uid) {
+    /**
+     * this method gets the collection description, the format info, the list of
+     * enrich services, etc - stuff that is needed for the page, but is the same
+     * whatever the query is - should be cached
+     */
+    protected boolean getBackgroundData(Element page_response, String collection, String lang, String uid)
+    {
 
         // create a message to process - contains requests for the collection 
@@ -531 +606 @@
         // the enrich_services request - only do this if provide_annotations is true
 
-        if (provide_annotations) {
+        if (provide_annotations)
+        {
             Element enrich_services_request = GSXML.createBasicRequest(this.doc, GSXML.REQUEST_TYPE_DESCRIBE, "", lang, uid);
             enrich_services_request.setAttribute(GSXML.INFO_ATT, "serviceList");
             info_message.appendChild(enrich_services_request);
         }
-        
-        Element info_response = (Element)this.mr.process(info_message);
+
+        Element info_response = (Element) this.mr.process(info_message);
 
         // the collection is the first response
         NodeList responses = info_response.getElementsByTagName(GSXML.RESPONSE_ELEM);
         Element format_resp = (Element) responses.item(0);
-        
-        Element format_elem = (Element)GSXML.getChildByTagName(format_resp, GSXML.FORMAT_ELEM);
-        if (format_elem != null) {
+
+        Element format_elem = (Element) GSXML.getChildByTagName(format_resp, GSXML.FORMAT_ELEM);
+        if (format_elem != null)
+        {
             logger.debug("doc action found a format statement");
             // set teh format type
-            format_elem.setAttribute(GSXML.TYPE_ATT, "display");  
+            format_elem.setAttribute(GSXML.TYPE_ATT, "display");
             page_response.appendChild(this.doc.importNode(format_elem, true));
         }
 
-        if (provide_annotations) {
-            Element services_resp = (Element)responses.item(1); 
+        if (provide_annotations)
+        {
+            Element services_resp = (Element) responses.item(1);
 
             // a new message for the mr
             Element enrich_message = this.doc.createElement(GSXML.MESSAGE_ELEM);
-            
+
             NodeList e_services = services_resp.getElementsByTagName(GSXML.SERVICE_ELEM);
             boolean service_found = false;
-            for (int j=0; j<e_services.getLength(); j++) {
-                if (((Element)e_services.item(j)).getAttribute(GSXML.TYPE_ATT).equals("enrich")) {
-                    Element s = GSXML.createBasicRequest(this.doc, GSXML.REQUEST_TYPE_DESCRIBE, ((Element)e_services.item(j)).getAttribute(GSXML.NAME_ATT), lang, uid);
+            for (int j = 0; j < e_services.getLength(); j++)
+            {
+                if (((Element) e_services.item(j)).getAttribute(GSXML.TYPE_ATT).equals("enrich"))
+                {
+                    Element s = GSXML.createBasicRequest(this.doc, GSXML.REQUEST_TYPE_DESCRIBE, ((Element) e_services.item(j)).getAttribute(GSXML.NAME_ATT), lang, uid);
                     enrich_message.appendChild(s);
                     service_found = true;
                 }
             }
-            if (service_found) {
-                Element enrich_response = (Element)this.mr.process(enrich_message);
-                
+            if (service_found)
+            {
+                Element enrich_response = (Element) this.mr.process(enrich_message);
+
                 NodeList e_responses = enrich_response.getElementsByTagName(GSXML.RESPONSE_ELEM);
                 Element service_list = this.doc.createElement(GSXML.SERVICE_ELEM + GSXML.LIST_MODIFIER);
-                for (int i=0; i<e_responses.getLength(); i++) {
-                    Element e_resp = (Element)e_responses.item(i);
-                    Element e_service = (Element)this.doc.importNode(GSXML.getChildByTagName(e_resp, GSXML.SERVICE_ELEM), true); 
+                for (int i = 0; i < e_responses.getLength(); i++)
+                {
+                    Element e_resp = (Element) e_responses.item(i);
+                    Element e_service = (Element) this.doc.importNode(GSXML.getChildByTagName(e_resp, GSXML.SERVICE_ELEM), true);
                     e_service.setAttribute(GSXML.NAME_ATT, e_resp.getAttribute(GSXML.FROM_ATT));
                     service_list.appendChild(e_service);
@@ -581 +663 @@
         } // if provide_annotations
         return true;
-        
+
     }
 
-    /** this involves a bit of a hack to get the equivalent query terms - has to requery the query service - uses the last selected service name. (if it ends in query). should this action do the query or should it send a message to the query action? but that will involve lots of extra stuff. also doesn't handle phrases properly - just highlights all the terms found in the text.
-    */
-    protected Element highlightQueryTerms(Element request, Element dc_response_doc_content) {
+    /**
+     * this involves a bit of a hack to get the equivalent query terms - has to
+     * requery the query service - uses the last selected service name. (if it
+     * ends in query). should this action do the query or should it send a
+     * message to the query action? but that will involve lots of extra stuff.
+     * also doesn't handle phrases properly - just highlights all the terms found
+     * in the text.
+     */
+    protected Element highlightQueryTerms(Element request, Element dc_response_doc_content)
+    {
 
         // do the query again to get term info 
-        Element cgi_param_list = (Element)GSXML.getChildByTagName(request, GSXML.PARAM_ELEM+GSXML.LIST_MODIFIER);
+        Element cgi_param_list = (Element) GSXML.getChildByTagName(request, GSXML.PARAM_ELEM + GSXML.LIST_MODIFIER);
         HashMap params = GSXML.extractParams(cgi_param_list, false);
-        
-        HashMap previous_params = (HashMap)params.get("p");
-        if (previous_params == null) {
+
+        HashMap previous_params = (HashMap) params.get("p");
+        if (previous_params == null)
+        {
             return dc_response_doc_content;
         }
-        String service_name = (String)previous_params.get(GSParams.SERVICE);
-        if (service_name == null || !service_name.endsWith("Query")) { // hack for now - we only do highlighting if we were in a query last - ie not if we were in a browse thingy
+        String service_name = (String) previous_params.get(GSParams.SERVICE);
+        if (service_name == null || !service_name.endsWith("Query"))
+        { // hack for now - we only do highlighting if we were in a query last - ie not if we were in a browse thingy
             logger.debug("invalid service, not doing highlighting");
             return dc_response_doc_content;
         }
-        String collection = (String)params.get(GSParams.COLLECTION);
+        String collection = (String) params.get(GSParams.COLLECTION);
         String lang = request.getAttribute(GSXML.LANG_ATT);
         String uid = request.getAttribute(GSXML.USER_ID_ATT);
         String to = GSPath.appendLink(collection, service_name);
-        
+
         Element mr_query_message = this.doc.createElement(GSXML.MESSAGE_ELEM);
         Element mr_query_request = GSXML.createBasicRequest(this.doc, GSXML.REQUEST_TYPE_PROCESS, to, lang, uid);
         mr_query_message.appendChild(mr_query_request);
-        
+
         // paramList
-        HashMap service_params = (HashMap)params.get("s1");
-        
+        HashMap service_params = (HashMap) params.get("s1");
+
         Element query_param_list = this.doc.createElement(GSXML.PARAM_ELEM + GSXML.LIST_MODIFIER);
         GSXML.addParametersToList(this.doc, query_param_list, service_params);
@@ -618 +709 @@
 
         // do the query
-        Element mr_query_response = (Element)this.mr.process(mr_query_message);
-        
-        String path = GSPath.appendLink(GSXML.RESPONSE_ELEM, GSXML.TERM_ELEM+GSXML.LIST_MODIFIER);
+        Element mr_query_response = (Element) this.mr.process(mr_query_message);
+
+        String path = GSPath.appendLink(GSXML.RESPONSE_ELEM, GSXML.TERM_ELEM + GSXML.LIST_MODIFIER);
         Element query_term_list_element = (Element) GSXML.getNodeByPath(mr_query_response, path);
-        if (query_term_list_element == null) {
+        if (query_term_list_element == null)
+        {
             // no term info
             logger.error("No query term information.\n");
@@ -630 +722 @@
         String content = GSXML.getNodeText(dc_response_doc_content);
 
-        String metadata_path = GSPath.appendLink(GSXML.RESPONSE_ELEM, GSXML.METADATA_ELEM+GSXML.LIST_MODIFIER);
+        String metadata_path = GSPath.appendLink(GSXML.RESPONSE_ELEM, GSXML.METADATA_ELEM + GSXML.LIST_MODIFIER);
         Element metadata_list = (Element) GSXML.getNodeByPath(mr_query_response, metadata_path);
 
         HashSet query_term_variants = new HashSet();
         NodeList equivalent_terms_nodelist = query_term_list_element.getElementsByTagName("equivTermList");
-        if(equivalent_terms_nodelist == null || equivalent_terms_nodelist.getLength() == 0)
+        if (equivalent_terms_nodelist == null || equivalent_terms_nodelist.getLength() == 0)
         {
             NodeList terms_nodelist = query_term_list_element.getElementsByTagName("term");
-            if(terms_nodelist != null && terms_nodelist.getLength() > 0)
-            {
-                for(int i = 0; i < terms_nodelist.getLength(); i++)
-                {
-                    String termValue = ((Element)terms_nodelist.item(i)).getAttribute("name");
+            if (terms_nodelist != null && terms_nodelist.getLength() > 0)
+            {
+                for (int i = 0; i < terms_nodelist.getLength(); i++)
+                {
+                    String termValue = ((Element) terms_nodelist.item(i)).getAttribute("name");
                     String termValueU = null;
                     String termValueL = null;
-                        
-                    if(termValue.length() > 1)
+
+                    if (termValue.length() > 1)
                     {
                         termValueU = termValue.substring(0, 1).toUpperCase() + termValue.substring(1);
@@ -656 +748 @@
                         termValueL = termValue.substring(0, 1).toLowerCase();
                     }
-                    
+
                     query_term_variants.add(termValueU);
                     query_term_variants.add(termValueL);
@@ -664 +756 @@
         else
         {
-            for (int i = 0; i < equivalent_terms_nodelist.getLength(); i++) {
+            for (int i = 0; i < equivalent_terms_nodelist.getLength(); i++)
+            {
                 Element equivalent_terms_element = (Element) equivalent_terms_nodelist.item(i);
                 String[] equivalent_terms = GSXML.getAttributeValuesFromList(equivalent_terms_element, GSXML.NAME_ATT);
-                for (int j = 0; j < equivalent_terms.length; j++) {
+                for (int j = 0; j < equivalent_terms.length; j++)
+                {
                     query_term_variants.add(equivalent_terms[j]);
                 }
@@ -682 +776 @@
         boolean in_term = false;
         boolean in_phrase = false;
-        for (int i = 0; i < performed_query.length(); i++) {
+        for (int i = 0; i < performed_query.length(); i++)
+        {
             char character = performed_query.charAt(i);
             boolean is_character_letter_or_digit = Character.isLetterOrDigit(character);
 
             // Has a query term just started?
-            if (in_term == false && is_character_letter_or_digit == true) {
+            if (in_term == false && is_character_letter_or_digit == true)
+            {
                 in_term = true;
                 term_start = i;
@@ -693 +789 @@
 
             // Or has a term just finished?
-            else if (in_term == true && is_character_letter_or_digit == false) {
+            else if (in_term == true && is_character_letter_or_digit == false)
+            {
                 in_term = false;
                 String term = performed_query.substring(term_start, i);
-                
+
                 Element term_element = GSXML.getNamedElement(query_term_list_element, GSXML.TERM_ELEM, GSXML.NAME_ATT, term);
-                if (term_element != null) {
-                    
+                if (term_element != null)
+                {
+
                     HashSet phrase_query_p_term_x_variants = new HashSet();
-                    
+
                     NodeList term_equivalent_terms_nodelist = term_element.getElementsByTagName("equivTermList");
-                    if(term_equivalent_terms_nodelist == null || term_equivalent_terms_nodelist.getLength() == 0)
+                    if (term_equivalent_terms_nodelist == null || term_equivalent_terms_nodelist.getLength() == 0)
                     {
                         String termValueU = null;
                         String termValueL = null;
-                        
-                        if(term.length() > 1)
+
+                        if (term.length() > 1)
                         {
                             termValueU = term.substring(0, 1).toUpperCase() + term.substring(1);
@@ -718 +816 @@
                             termValueL = term.substring(0, 1).toLowerCase();
                         }
-                        
+
                         phrase_query_p_term_x_variants.add(termValueU);
                         phrase_query_p_term_x_variants.add(termValueL);
@@ -724 +822 @@
                     else
                     {
-                        for (int j = 0; j < term_equivalent_terms_nodelist.getLength(); j++) {
+                        for (int j = 0; j < term_equivalent_terms_nodelist.getLength(); j++)
+                        {
                             Element term_equivalent_terms_element = (Element) term_equivalent_terms_nodelist.item(j);
                             String[] term_equivalent_terms = GSXML.getAttributeValuesFromList(term_equivalent_terms_element, GSXML.NAME_ATT);
-                            for (int k = 0; k < term_equivalent_terms.length; k++) {
+                            for (int k = 0; k < term_equivalent_terms.length; k++)
+                            {
                                 phrase_query_p_term_x_variants.add(term_equivalent_terms[k]);
                             }
@@ -733 +833 @@
                     }
                     phrase_query_p_term_variants_list.add(phrase_query_p_term_x_variants);
-                    
-                    if (in_phrase == false) {
+
+                    if (in_phrase == false)
+                    {
                         phrase_query_term_variants_hierarchy.add(phrase_query_p_term_variants_list);
                         phrase_query_p_term_variants_list = new ArrayList();
@@ -741 +842 @@
             }
             // Watch for phrases (surrounded by quotes)
-            if (character == '\"') {
+            if (character == '\"')
+            {
                 // Has a phrase just started?
-                if (in_phrase == false) {
+                if (in_phrase == false)
+                {
                     in_phrase = true;
                 }
                 // Or has a phrase just finished?
-                else if (in_phrase == true) {
+                else if (in_phrase == true)
+                {
                     in_phrase = false;
                     phrase_query_term_variants_hierarchy.add(phrase_query_p_term_variants_list);
@@ -760 +864 @@
     }
 
-
     /**
-    * Highlights query terms in a piece of text.
-    */
+     * Highlights query terms in a piece of text.
+     */
     private Element highlightQueryTermsInternal(String content, HashSet query_term_variants, ArrayList phrase_query_term_variants_hierarchy)
     {
@@ -775 +878 @@
         boolean in_word = false;
         boolean preceding_word_matched = false;
-        for (int i = 0; i < content_characters.length; i++) {
+        for (int i = 0; i < content_characters.length; i++)
+        {
             boolean is_character_letter_or_digit = Character.isLetterOrDigit(content_characters[i]);
 
             // Has a word just started?
-            if (in_word == false && is_character_letter_or_digit == true) {
+            if (in_word == false && is_character_letter_or_digit == true)
+            {
                 in_word = true;
                 word_start = i;
@@ -785 +890 @@
 
             // Or has a word just finished?
-            else if (in_word == true && is_character_letter_or_digit == false) {
+            else if (in_word == true && is_character_letter_or_digit == false)
+            {
                 in_word = false;
 
                 // Check if the word matches any of the query term equivalents
                 String word = new String(content_characters, word_start, (i - word_start));
-                if (query_term_variants.contains(word)) {
+                if (query_term_variants.contains(word))
+                {
                     // We have found a matching word, so remember its location
                     word_matches.add(new WordMatch(word, word_start, i, preceding_word_matched));
                     preceding_word_matched = true;
                 }
-                else {
+                else
+                {
                     preceding_word_matched = false;
                 }
@@ -802 +910 @@
 
         // Don't forget the last word...
-        if (in_word == true) {
+        if (in_word == true)
+        {
             // Check if the word matches any of the query term equivalents
             String word = new String(content_characters, word_start, (content_characters.length - word_start));
-            if (query_term_variants.contains(word)) {
+            if (query_term_variants.contains(word))
+            {
                 // We have found a matching word, so remember its location
                 word_matches.add(new WordMatch(word, word_start, content_characters.length, preceding_word_matched));
@@ -816 +926 @@
         // Deal with phrases now
         ArrayList partial_phrase_matches = new ArrayList();
-        for (int i = 0; i < word_matches.size(); i++) {
+        for (int i = 0; i < word_matches.size(); i++)
+        {
             WordMatch word_match = (WordMatch) word_matches.get(i);
 
             // See if any partial phrase matches are extended by this word
-            if (word_match.preceding_word_matched) {
-                for (int j = partial_phrase_matches.size() - 1; j >= 0; j--) {
+            if (word_match.preceding_word_matched)
+            {
+                for (int j = partial_phrase_matches.size() - 1; j >= 0; j--)
+                {
                     PartialPhraseMatch partial_phrase_match = (PartialPhraseMatch) partial_phrase_matches.remove(j);
                     ArrayList phrase_query_p_term_variants_list = (ArrayList) phrase_query_term_variants_hierarchy.get(partial_phrase_match.query_phrase_number);
                     HashSet phrase_query_p_term_x_variants = (HashSet) phrase_query_p_term_variants_list.get(partial_phrase_match.num_words_matched);
-                    if (phrase_query_p_term_x_variants.contains(word_match.word)) {
+                    if (phrase_query_p_term_x_variants.contains(word_match.word))
+                    {
                         partial_phrase_match.num_words_matched++;
 
                         // Has a complete phrase match occurred?
-                        if (partial_phrase_match.num_words_matched == phrase_query_p_term_variants_list.size()) {
+                        if (partial_phrase_match.num_words_matched == phrase_query_p_term_variants_list.size())
+                        {
                             // Check for overlaps by looking at the previous highlight range
-                            if (!highlight_end_positions.isEmpty()) {
+                            if (!highlight_end_positions.isEmpty())
+                            {
                                 int last_highlight_index = highlight_end_positions.size() - 1;
                                 int last_highlight_end = ((Integer) highlight_end_positions.get(last_highlight_index)).intValue();
-                                if (last_highlight_end > partial_phrase_match.start_position) {
+                                if (last_highlight_end > partial_phrase_match.start_position)
+                                {
                                     // There is an overlap, so remove the previous phrase match
                                     int last_highlight_start = ((Integer) highlight_start_positions.remove(last_highlight_index)).intValue();
@@ -846 +963 @@
                         }
                         // No, but add the partial match back into the list for next time
-                        else {
+                        else
+                        {
                             partial_phrase_matches.add(partial_phrase_match);
                         }
@@ -852 +970 @@
                 }
             }
-            else {
+            else
+            {
                 partial_phrase_matches.clear();
             }
 
             // See if this word is at the start of any of the phrases
-            for (int p = 0; p < phrase_query_term_variants_hierarchy.size(); p++) {
+            for (int p = 0; p < phrase_query_term_variants_hierarchy.size(); p++)
+            {
                 ArrayList phrase_query_p_term_variants_list = (ArrayList) phrase_query_term_variants_hierarchy.get(p);
                 HashSet phrase_query_p_term_1_variants = (HashSet) phrase_query_p_term_variants_list.get(0);
-                if (phrase_query_p_term_1_variants.contains(word_match.word)) {
+                if (phrase_query_p_term_1_variants.contains(word_match.word))
+                {
                     // If this phrase is just one word long, we have a complete match
-                    if (phrase_query_p_term_variants_list.size() == 1) {
+                    if (phrase_query_p_term_variants_list.size() == 1)
+                    {
                         highlight_start_positions.add(new Integer(word_match.start_position));
                         highlight_end_positions.add(new Integer(word_match.end_position));
                     }
                     // Otherwise we have the start of a potential phrase match
-                    else {
+                    else
+                    {
                         partial_phrase_matches.add(new PartialPhraseMatch(word_match.start_position, p));
                     }
@@ -878 +1001 @@
 
         int last_wrote = 0;
-        for (int i = 0; i < highlight_start_positions.size(); i++) {
+        for (int i = 0; i < highlight_start_positions.size(); i++)
+        {
             int highlight_start = ((Integer) highlight_start_positions.get(i)).intValue();
             int highlight_end = ((Integer) highlight_end_positions.get(i)).intValue();
 
             // Print anything before the highlight range
-            if (last_wrote < highlight_start) {
+            if (last_wrote < highlight_start)
+            {
                 String preceding_text = new String(content_characters, last_wrote, (highlight_start - last_wrote));
                 content_element.appendChild(this.doc.createTextNode(preceding_text));
@@ -889 +1014 @@
 
             // Print the highlight text, annotated
-            if (highlight_end > last_wrote) {
+            if (highlight_end > last_wrote)
+            {
                 String highlight_text = new String(content_characters, highlight_start, (highlight_end - highlight_start));
                 Element annotation_element = GSXML.createTextElement(this.doc, "annotation", highlight_text);
@@ -899 +1025 @@
 
         // Finish off any unwritten text
-        if (last_wrote < content_characters.length) {
+        if (last_wrote < content_characters.length)
+        {
             String remaining_text = new String(content_characters, last_wrote, (content_characters.length - last_wrote));
             content_element.appendChild(this.doc.createTextNode(remaining_text));
@@ -906 +1033 @@
         return content_element;
     }
-
 
     static private class WordMatch
@@ -924 +1050 @@
     }
 
-
     static private class PartialPhraseMatch
     {