Changeset 3054


Ignore:
Timestamp:
27/11/07 09:57:11 (12 years ago)
Author:
mpritcha
Message:

Mostly cosmetic tweaks to javadoc comments, removed a few unused imports etc.

Location:
TI01-discovery/trunk/ws-Discovery2/src/ndg/services/discovery
Files:
8 edited

Legend:

Unmodified
Added
Removed
  • TI01-discovery/trunk/ws-Discovery2/src/ndg/services/discovery/AuthorSearchAgent.java

    r2838 r3054  
    22 
    33/** 
    4  *  Agent class for full-text search 
     4 *  Agent class for author search. 
    55 * 
    6  *  @author     Matt Pritchard <m.j.pritchard@rl.ac.uk> 
     6 *  @author     Matt Pritchard 
    77 */ 
    88public class AuthorSearchAgent extends SearchAgent implements Searchable { 
    99 
    1010        /** 
    11          * Default no-arg constructor. 
     11         * Default no-argument constructor. 
    1212         */ 
    1313        public AuthorSearchAgent() {} 
    1414 
    1515        /** 
    16          * Constructor to set term. 
     16         * Constructor method, sets author search term 
     17         * @param term String containing author search term 
    1718         */ 
    1819        public AuthorSearchAgent(String term)  
     
    2223 
    2324        /** 
    24          * Sets the fullTextSearch term 
    25          * Overrides setTerm method of SearchAgent 
    26          * @param s String 
     25         * Sets the search term for an author search, wrapped in collection / xpath location template. 
     26         * @param s String containing author search term 
    2727         */ 
    2828        public void setTerm(String s) 
  • TI01-discovery/trunk/ws-Discovery2/src/ndg/services/discovery/DiscoveryServiceClient.java

    r2992 r3054  
    22 
    33/** 
    4  * Helper class providing proxy methods for operations of NDG Discovery Web Service. Main() method demonstrate usage. 
     4 * Helper class providing proxy methods for operations of NDG Discovery Web Service. 
     5 * <p><code>main</code> method is hardcoded with example below to demonstrate usage:</p> 
     6 * <pre> 
     7 *try 
     8 *{ 
     9 *      DiscoveryServiceClient client = new DiscoveryServiceClient("http://glue.badc.rl.ac.uk/axis2/services/DiscoveryService"); 
     10 * 
     11 *      System.out.println( "Trying a doSearch..." ); 
     12 *      String doSearchResult = client.doSearch( 
     13 *              "&lt;m:doSearch xmlns:m=\"urn:DiscoveryServiceAPI\"&gt;&lt;m:term&gt;*neodc*&lt;/m:term&gt;&lt;m:termType&gt;fullText&lt;/m:termType&gt;&lt;/m:doSearch&gt;" 
     14 *      ); 
     15 *      System.out.println( doSearchResult ); 
     16 * 
     17 *      System.out.println( "Trying a doPresent..." ); 
     18 *      String doPresentResult = client.doPresent( 
     19 *              "&lt;m:doPresent xmlns:m=\"urn:DiscoveryServiceAPI\">&lt;m:documents>&lt;m:document>neodc.nerc.ac.uk__DIF__dataent_11924879127625221.xml&lt;/m:document>&lt;/m:documents>&lt;m:presentFormat>original&lt;/m:presentFormat>&lt;/m:doPresent&gt;" 
     20 *      ); 
     21 *      System.out.println( doPresentResult ); 
     22 * 
     23 *} 
     24 *catch (Exception e) 
     25 *{ 
     26 *      System.out.println( e.toString() ); 
     27 *} 
     28 * </pre> 
    529 */ 
    630public class DiscoveryServiceClient 
     
    4670         
    4771        /** 
    48          * Proxy method for doSearch operation 
     72         * Acts as proxy method for doSearch operation 
    4973         * @param reqDocAsString String containing XML request doc (see WSDL for structure) 
    5074         * @return String containing SearchReturn (see WSDL for structure) 
     
    6084 
    6185        /** 
    62          * Proxy method for doPresent operation 
     86         * Acts as proxy method for doPresent operation 
    6387         * @param reqDocAsString String containing XML request doc (see WSDL for structure) 
    6488         * @return String containing PresentReturn (see WSDL for structure) 
  • TI01-discovery/trunk/ws-Discovery2/src/ndg/services/discovery/DiscoveryServiceSkeleton.java

    r2840 r3054  
    99 
    1010/** 
    11  *  DiscoveryServiceSkeleton 
    12   * Implementation class for NERC DataGrid Discovert Web Service 
     11  * Implementation class for NERC DataGrid Discovery Web Service. 
    1312  * Based on DiscoveryServiceSkeleton.java which is generated by WSDL2Java 
    1413  * @author Matt Pritchard 
     
    1817        /** 
    1918         * Performs the doFullTextSearch operation 
     19         * @param discoveryserviceapi.DoSearchDocument containing search request 
     20         * @return discoveryserviceapi.DoSearchReturnDocument containing search result 
    2021         */ 
    2122        public  discoveryserviceapi.DoSearchReturnDocument doSearch 
     
    141142                                                Hashtable document = (Hashtable)i.next(); 
    142143                                                responseDocuments.addDocument( (String)document.get("name") ); 
    143                                                 //thisDoc.setPosition( ((Integer)document.get("position")).intValue() ); 
    144                                                 //thisDoc.setMatches( ((Integer)document.get("matches")).intValue() ); 
    145                                                 //thisDoc.setUri( (String)document.get("name") ); 
    146                                  
    147144                                        } 
    148145 
     
    161158        /** 
    162159         * Performs the doPresent operation 
     160         * @param discoveryserviceapi.DoPresentDocument containing search request 
     161         * @return discoveryserviceapi.DoPresentReturnDocument containing search result 
    163162         */ 
    164163         public  discoveryserviceapi.DoPresentReturnDocument doPresent 
     
    216215    /** 
    217216         * Performs the getListNames operation 
     217         * @param discoveryserviceapi.GetListNamesDocument containing request 
     218         * @return discoveryserviceapi.GetListNamesReturnDocument containing result 
    218219         */ 
    219220         public  discoveryserviceapi.GetListNamesReturnDocument getListNames 
     
    235236    /** 
    236237         * Performs the getList operation 
     238         * @param discoveryserviceapi.GetListDocument containing request 
     239         * @return discoveryserviceapi.GetListReturnDocument containing result 
    237240         */ 
    238241         public  discoveryserviceapi.GetListReturnDocument getList 
  • TI01-discovery/trunk/ws-Discovery2/src/ndg/services/discovery/FullTextSearchAgent.java

    r1801 r3054  
    22 
    33/** 
    4  *  Agent class for full-text search 
     4 *  Agent class for full-text search. 
    55 * 
    6  *  @author     Matt Pritchard <m.j.pritchard@rl.ac.uk> 
     6 *  @author     Matt Pritchard 
    77 */ 
    88public class FullTextSearchAgent extends SearchAgent implements Searchable { 
    99 
    1010        /** 
    11          * Default no-arg constructor. 
     11         * Default no-argument constructor. 
    1212         */ 
    1313        public FullTextSearchAgent() {} 
    1414 
    1515        /** 
    16          * Constructor to set term. 
     16         * Constructor method, sets full-text search term. 
     17         * @param term String containing full-text search term 
    1718         */ 
    1819        public FullTextSearchAgent(String term)  
     
    2223 
    2324        /** 
    24          * Sets the fullTextSearch term 
    25          * Overrides setTerm method of SearchAgent 
    26          * @param s String 
     25         * Sets the search term for a full-text search, wrapped in collection / xpath location template. 
     26         * @param s String containing author search term 
    2727         */ 
    2828        public void setTerm(String s) 
  • TI01-discovery/trunk/ws-Discovery2/src/ndg/services/discovery/ParameterSearchAgent.java

    r2514 r3054  
    22 
    33/** 
    4  *  Agent class for full-text search 
     4 *  Agent class for parameter search 
    55 * 
    66 *  @author     Matt Pritchard <m.j.pritchard@rl.ac.uk> 
     
    99 
    1010        /** 
    11          * Default no-arg constructor. 
     11         * Default no-argument constructor. 
    1212         */ 
    1313        public ParameterSearchAgent() {} 
    1414 
    1515        /** 
    16          * Constructor to set term. 
     16         * Constructor method, sets parameter search term. 
     17         * @param term String containing parameter search term 
    1718         */ 
    1819        public ParameterSearchAgent(String term)  
     
    2223 
    2324        /** 
    24          * Sets the fullTextSearch term 
    25          * Overrides setTerm method of SearchAgent 
    26          * @param s String 
     25         * Sets the search term for a parameter search, wrapped in collection / xpath location template. 
     26         * @param s String containing parameter search term 
    2727         */ 
    2828        public void setTerm(String s) 
  • TI01-discovery/trunk/ws-Discovery2/src/ndg/services/discovery/PresentSummary.java

    r1751 r3054  
    55/** 
    66 * Simple container for the summary results of a present. 
    7  *  
    87 */ 
    98public class PresentSummary 
     
    1413        private Vector documents; 
    1514         
    16         /** Default no-arg constructor */ 
     15        /** 
     16         * Default no-argument constructor 
     17         */ 
    1718        public PresentSummary() {} 
    1819 
     
    2122         * 
    2223         * @param  status  boolean, true for success, false for failure  
    23          * @param  statusMessage  String contianing message about success or failure of present 
     24         * @param  statusMessage  String containing message about success or failure of present 
    2425         * @param  documents  String containing XML document 
    2526         */ 
  • TI01-discovery/trunk/ws-Discovery2/src/ndg/services/discovery/SearchAgent.java

    r2559 r3054  
    55import java.util.Vector; 
    66import java.util.Properties; 
    7 import java.util.Date; 
    87import java.math.BigInteger; // needed because xmlbeans uses this for xsd:positiveInteger 
    98import java.math.BigDecimal; // needed because xmlbeans uses this for xsd:decimal 
    109import java.util.Calendar;  // needed because xmlbeans uses this for xsd:date 
    11 import java.io.BufferedReader; 
    12 import java.io.InputStreamReader; 
    1310import java.io.ByteArrayInputStream; 
    14 import java.io.IOException; 
    1511import java.text.DecimalFormat; 
    1612import java.text.SimpleDateFormat; 
     
    1814import javax.xml.namespace.*; 
    1915import javax.xml.xpath.*; 
    20 import javax.xml.*; 
    2116import org.xml.sax.InputSource; 
    2217import org.w3c.dom.*; 
     
    3429        static Properties properties = new ServiceProperties().getProperties(); 
    3530 
    36         // Defaults 
    37         public static final BigInteger startDefault = new BigInteger("1"); 
    38         public static final BigInteger howManyDefault = new BigInteger("30"); 
    39         boolean doSpatio = false; // flags whether spatio search should be included in search 
    40         boolean doTemporal = false;             // flags whether temporal search should be included in search 
    41         boolean doTerm = false;         // flags whether term should be included in search 
    42         boolean doScope = false; 
    43         boolean doOrderBy = false; 
    44         String xqueryStr = ""; // set intial value from template 
    45  
    46         // Input parameters 
     31        // Internal defaults 
     32        static final BigInteger startDefault = new BigInteger("1"); // default value for first record to display in result set 
     33        static final BigInteger howManyDefault = new BigInteger("30"); // default values for how many results to display in result set 
     34        boolean doSpatio = false; // flags whether spatial search should be done 
     35        boolean doTemporal = false;             // flags whether temporal search should be done 
     36        boolean doTerm = false;         // flags whether term search should be done 
     37        boolean doScope = false;        // flags whether search should be restricted by scope (dataCentre etc) 
     38        boolean doOrderBy = false; // flags whether ordering should be applied to result set 
     39        String xqueryStr = ""; // set initial value for xquery string 
     40         
     41        // Initiallise input parameters, setting values to internal defaults 
    4742        int resultId = 0; 
    4843        BigInteger start = startDefault; 
     
    7267 
    7368        /** 
    74          * Default no-arg constructor. 
     69         * Default no-argument constructor. 
    7570         */ 
    7671        public SearchAgent() {} 
     
    10499        /** 
    105100         * Sets the search term. 
    106          * Overridden by FullTextSearchAgent 
    107101         * @param s String 
    108102         */ 
     
    115109        /** 
    116110         * Sets the field by which to sort the result set 
    117          * @param s String, one of "date", "dataCentre" 
     111         * @param s String, one of "date", "dataCentre", list defined in <code>orderByFieldList</code> returned by <code>getList</code> operation. 
    118112         */ 
    119113        public void setOrderBy(String s) 
     
    135129        /** 
    136130         * Sets the direction in which to sort the result set 
    137          * @param s String, one of "ascending", "descending" 
     131         * <p>Works around current typo in WSDL which requires "descnding"</p> 
     132         * @param s String, one of "ascending", "descending". 
     133         * @see DiscoveryServiceSkeleton 
    138134         */ 
    139135        public void setOrderByDirection(String s) 
     
    151147        /** 
    152148         * Adds new scope item to the search, telling Agent to search only documents containing these keywords 
    153          * @param s String, one of "NERC-DDC", etc 
     149         * @param s String, values in list <code>scopeList</code> returned by <code>getList</code> operation. 
     150         * @see DiscoveryServiceSkeleton 
    154151         */ 
    155152        public void addNewScope(String s) 
     
    190187        /** 
    191188         * Sets north bound of BoundingBox. 
    192          * <p>Value should be BigDecimal. 
    193          * @param f value of north bound of search box 
    194          */ 
    195  
    196  
     189         * @param f BigDecimal value of north bound of search box 
     190         */ 
    197191        public void setLimitNorth(BigDecimal f) 
    198192        { 
     
    205199        /** 
    206200         * Sets south bound of BoundingBox. 
    207          * <p>Value should be BigDecimal. 
    208          * @param f value of south bound of search box 
     201         * @param f BigDecimal value of south bound of search box 
    209202         */ 
    210203        public void setLimitSouth(BigDecimal f) 
     
    218211        /** 
    219212         * Sets south bound of BoundingBox. 
    220          * <p>Value should be BigDecimal. 
    221          * @param f value of west bound of search box 
     213         * @param f BigDecimal value of west bound of search box 
    222214         */ 
    223215        public void setLimitWest(BigDecimal f) 
     
    231223        /** 
    232224         * Sets south bound of BoundingBox. 
    233          * <p>Value should be BigDecimal. 
    234          * @param f value of west bound of search box 
     225         * @param f BigDecimal value of west bound of search box 
    235226         */ 
    236227        public void setLimitEast(BigDecimal f) 
     
    244235        /** 
    245236         * Sets start of date range. 
    246          * <p>Value should be Date. 
    247          * @param f value of north bound of search box 
     237         * @param c Calendar value of start date of date range 
    248238         */ 
    249239        public void setDateRangeStart(Calendar c) 
     
    254244        /** 
    255245         * Sets start of date range. 
    256          * <p>Value should be Date. 
    257          * @param f value of north bound of search box 
     246         * @param c Calendar value of end date of date range 
    258247         */ 
    259248        public void setDateRangeEnd(Calendar c) 
     
    263252 
    264253        /** 
    265          * Sets whether spatio search should be done. 
    266          * <p>Value should be boolean. 
    267          * @param b 
     254         * Sets whether spatial search should be done. 
     255         * @param b boolean flag true if spatial search is to be done 
    268256         */ 
    269257        public void setDoSpatio(boolean b) 
     
    274262        /** 
    275263         * Sets whether temporal search should be done. 
    276          * <p>Value should be boolean. 
    277          * @param b 
     264         * @param b boolean flag true if temporal search is to be done 
    278265         */ 
    279266        public void setDoTemporal(boolean b) 
     
    284271        /** 
    285272         * Sets whether term search should be done. 
    286          * <p>Value should be boolean. 
    287          * @param b 
     273         * @param b boolean flag true if term search is to be done 
    288274         */ 
    289275        public void setDoTerm(boolean b) 
     
    293279 
    294280        /** 
    295          * Sets whether orderby should be done. 
    296          * <p>Value should be boolean. 
    297          * @param b 
     281         * Sets whether result set should be ordered. 
     282         * @param b boolean flag true if result set should be ordered 
    298283         */ 
    299284        public void setDoOrderBy(boolean b) 
     
    304289        /** 
    305290         * Sets whether scope check should be done. 
    306          * <p>Value should be boolean. 
    307          * @param b 
     291         * @param b boolean flag true if search should be limited to scope keywords 
    308292         */ 
    309293        public void setDoScope(boolean b) 
     
    314298        /** 
    315299         * Sets operator used for spatial search 
    316          * @param s va;id value from list <code>spatialOperatorsList</code> 
     300         * @param s String spatial operator to be applied, must be member of list <code>spatialOperatorsList</code> returned by <code>getList</code> operation. 
    317301        */ 
    318302        public void setSpatialOperator(String s) 
     
    332316        /** 
    333317         * Executes the search and returns a SearchSummary object 
     318         * @return SearchSummary object containing result of search 
    334319         */ 
    335320        public SearchSummary doSearch() { 
     
    337322                SearchSummary result = new SearchSummary(); 
    338323                XmlRpc.setEncoding("UTF-8"); 
    339                 Vector myResultDocuments = new Vector(); 
    340324                xqueryStr = xqueryStrTemplate; //set initial value from template 
    341325 
     
    586570 
    587571 
    588         public static String xqueryStrTemplate =  
     572        static String xqueryStrTemplate =  
    589573"xquery version \"1.0\"; \n"+ 
    590574"import module namespace voclib=\"http://ndg.nerc.ac.uk/xquery/lib/vocab\" at \"xmldb:exist:///db/xqueryLib/Vocabs/vocab_xquery_lib.xquery\"; \n"+ 
  • TI01-discovery/trunk/ws-Discovery2/src/ndg/services/discovery/SearchSummary.java

    r1573 r3054  
    88/** 
    99 * Simple container for the summary results of a search. 
    10  *  
    1110 */ 
    1211public class SearchSummary 
Note: See TracChangeset for help on using the changeset viewer.