Changeset 3965

Timestamp:

29/05/08 17:36:35 (13 years ago)

Author:

cbyrom

Message:

Create new Utitilities class to store generic methods for reuse across
the different classes + implement usage in various server code.

Add more logging + fix one or two issues.

Location:

TI01-discovery/branches/ws-Discovery2-upgrade/src/ndg

Files:

• services/discovery/DiscoveryServiceSkeleton.java (modified) (4 diffs)
• services/discovery/SearchAgent.java (modified) (7 diffs)
• services/discovery/Utilities.java (added)
• testclient/discovery/DiscoveryServiceClient.java (modified) (7 diffs)

TI01-discovery/branches/ws-Discovery2-upgrade/src/ndg/services/discovery/DiscoveryServiceSkeleton.java

@@ -32 +32 @@
         public static final String NO_OVERLAP_OPERATOR_TYPE = "doesNotOverlap";
         
+        public static final String DELIMITER = "-------------------------------------";
         /**
          * Performs the doFullTextSearch operation 
@@ -41 +42 @@
          
         { 
+                logger.info(DELIMITER);
                 logger.info("doSearch() invoked");
+                logger.info(DELIMITER);
                 discoveryserviceapi.DoSearchReturnDocument response = 
                         discoveryserviceapi.DoSearchReturnDocument.Factory.newInstance();
@@ -126 +129 @@
         private SearchAgent setupSearchAgent(DoSearchDocument request) throws DiscoveryWSException 
         {
+                logger.info("Setting up search agent");
                 discoveryserviceapi.SearchType requestContent = request.getDoSearch();
                 SearchAgent agent = new SearchAgent();
                 
                 // check if we're doing a term type search - if so, check there is a term to search on
-                if (requestContent.getTermType() != null && requestContent.getTermType().length() > 0)
-                {
-                        logger.info("Term type set - checking for term value");
-
-                        if (requestContent.getTerm() != null &&  requestContent.getTerm().length() > 0 )
+                if (Utilities.isStringDefined(requestContent.getTerm()))
+                {
+                        logger.info("Term set to search on: " + requestContent.getTerm());
+                        agent.setTerm(requestContent.getTerm());
+                }
+                
+                // check if we're doing a term type search - if so, check there is a term to search on
+                if (Utilities.isStringDefined(requestContent.getTermType()))
+                {
+                        logger.info("Term type set: " + requestContent.getTermType()); 
+                        logger.info("- checking for term value");
+
+                        if (Utilities.isStringDefined(requestContent.getTerm()))
                         {
                                 logger.info("Term set - will do term search");
                                 agent.setTermType(requestContent.getTermType());
-                                agent.setTerm(requestContent.getTerm());
                         }
                         else
@@ -198 +209 @@
                         agent.setDateRangeEnd( requestContent.getDateRange().getDateRangeEnd() );
                 }
+                logger.info("Search agent ready for searching");
                 return agent;
         }

TI01-discovery/branches/ws-Discovery2-upgrade/src/ndg/services/discovery/SearchAgent.java

@@ -29 +29 @@
     private String termType = null;
     
-        static final BigInteger startDefault = new BigInteger("1"); // default value for first record to display in result set
-        static final BigInteger howManyDefault = new BigInteger("30"); // default values for how many results to display in result set
-        
         // Initialise input parameters, setting values to internal defaults
 //      private int resultId = 0;
-        private BigInteger start = startDefault;
-        private BigInteger howMany = howManyDefault;
+        private BigInteger start = new BigInteger("0"); // what row of results to start retrieval from
+        private BigInteger howMany = new BigInteger("30");      // how many results to display in result set
         private String term = "";
         private String orderByField = null;     // representation used in WSDL e.g. "date", "dataCentre"
@@ -365 +362 @@
         private SearchSummary processResults(String[][] results) 
         {
+                logger.info("Extracting results");
                 SearchSummary result = new SearchSummary();
                 result.setHits(results.length); // NB ensure this is 0 if not data returned
@@ -375 +373 @@
                                 Hashtable<String, String> thisDoc = new Hashtable<String, String>();
                                 thisDoc.put("name", results[i][0]);
+                                
                                 // TODO: these next two are not used anywhere - remove or use?
                                 thisDoc.put("matches", String.valueOf(1));
@@ -382 +381 @@
                         result.setStatus( true );
                         result.setStatusMessage( "Success" );
-                        result.setDocuments( documents );       
+                        result.setDocuments( documents );
+                        logger.info("Results added to search summary");
                 }
                 else
                 {
                         result.setStatus( false );
-                        result.setStatusMessage("Search was successful but generated no results.");
+                        String outMessage = "Search was successful but generated no results.";
+                        result.setStatusMessage(outMessage);
+                        logger.info(outMessage);
                 }
                 
@@ -426 +428 @@
                 StringBuffer whereSqlCmd = new StringBuffer();
                 
-                if (this.getTerm() != null && this.getTerm().length() > 0)
-                {
-                        logger.info("Adjusting query for " + this.getTermType() + " type search");
+                if (Utilities.isStringDefined(this.getTerm()))
+                {
+                        if (Utilities.isStringDefined(this.getTermType()))
+                                logger.info("Adjusting query for " + this.getTermType() + " type search");
                         
-                        if (this.getTermType().equals(DiscoveryServiceSkeleton.FULL_TEXT_TERM_TYPE))
+                        // NB, if no term type provided, assume full text search
+                        if (! Utilities.isStringDefined(this.getTermType()) || 
+                                        this.getTermType().equals(DiscoveryServiceSkeleton.FULL_TEXT_TERM_TYPE))
                         {
                                 appendWhereClause(whereSqlCmd, " to_tsquery('" + this.term + "') @@ ts_vector ");
@@ -506 +511 @@
                 }
                 
+                // add the WHERE statement, if required
+                if (whereSqlCmd.length() > 0)
+                        whereSqlCmd.insert(0, WHERE_STATEMENT);
+                
                 // lastly, add the size limit and offset of the returned data set
                 logger.info("Adding size limit and offset of results set");
@@ -511 +520 @@
                 whereSqlCmd.append(LIMIT_STATEMENT + this.getHowMany());
                 
-                String fullCmd = fromSqlCmd.toString() + WHERE_STATEMENT + whereSqlCmd.toString() + ";";
+                String fullCmd = fromSqlCmd.toString() + whereSqlCmd.toString() + ";";
                 logger.info("SQL query generated");
                 logger.fine("Value: " + fullCmd);

TI01-discovery/branches/ws-Discovery2-upgrade/src/ndg/testclient/discovery/DiscoveryServiceClient.java

@@ -4 +4 @@
 import java.util.Date;
 import ndg.clients.discovery.*;
+import ndg.services.discovery.Utilities;
 
 /**
@@ -132 +133 @@
         
         /**
-         * Test if a string has a value set
-         * @param str - string to test
-         * @return true if str is non null and not empty, false otherwise
-         */
-        private boolean isStringDefined(String str)
-        {
-                if (str != null && str.length() > 0)
-                        return true;
-                return false;
-        }
-        
-        /**
          * Run a search - return results as a String
          * 
@@ -175 +164 @@
                 StringBuilder soapMessage = new StringBuilder("<doSearch xmlns=\"urn:DiscoveryServiceAPI\">");
 
-                if (isStringDefined(term))
+                if (Utilities.isStringDefined(term))
                         soapMessage.append("<term>" + term + "</term>");
-                if (isStringDefined(termType))
+                if (Utilities.isStringDefined(termType))
                         soapMessage.append("<termType>" + termType + "</termType>");
 
-                if (isStringDefined(start))
+                if (Utilities.isStringDefined(start))
                 {
                         // NB, check the input val is a valid int
@@ -187 +176 @@
                 }
 
-                if (isStringDefined(howMany))
+                if (Utilities.isStringDefined(howMany))
                 {
                         // NB, check the input val is a valid int
@@ -194 +183 @@
                 }
 
-                if (isStringDefined(orderBy))
+                if (Utilities.isStringDefined(orderBy))
                         soapMessage.append("<orderBy>" + orderBy + "</orderBy>");
 
-                if (isStringDefined(orderByDirection))
+                if (Utilities.isStringDefined(orderByDirection))
                         soapMessage.append("<orderByDirection>" + orderByDirection + "</orderByDirection>");
 
-                if (isStringDefined(scope))
+                if (Utilities.isStringDefined(scope))
                         soapMessage.append("<scope>" + scope + "</scope>");
 
-                if (isStringDefined(spatialOperator))
+                if (Utilities.isStringDefined(spatialOperator))
                         soapMessage.append("<spatialOperator>" + spatialOperator + "</spatialOperator>");
 
-                if (isStringDefined(limitNorth))
+                if (Utilities.isStringDefined(limitNorth))
                 {
                         soapMessage.append("<BoundingBox>");
@@ -222 +211 @@
                 
 
-                if (isStringDefined(temporalOperator))
+                if (Utilities.isStringDefined(temporalOperator))
                         soapMessage.append("<temporalOperator>" + temporalOperator + "</temporalOperator>");
 
-                if (isStringDefined(dateRangeStart))
+                if (Utilities.isStringDefined(dateRangeStart))
                 {
                         soapMessage.append("<DateRange>");
@@ -262 +251 @@
                 soapMessage.append("</documents>");
                 
-                if (isStringDefined(format))
+                if (Utilities.isStringDefined(format))
                         soapMessage.append("<format>" + format + "</format>");