Changeset 3235 for trunk/gsdl3/src/java/org/greenstone/gsdl3/service

Timestamp:

2002-07-06T14:25:01+12:00 (22 years ago)

Author:

say1

Message:

added GNU headers to all java files. added @author and @version tags. added a fair number of javadoc comments (but not as many as I probably should).

Location:

trunk/gsdl3/src/java/org/greenstone/gsdl3/service

Files:

• MGGDBMService.java (modified) (6 diffs)
• MGPPService.java (modified) (7 diffs)
• PhindService.java (modified) (2 diffs)
• ServiceModule.java (modified) (3 diffs)

trunk/gsdl3/src/java/org/greenstone/gsdl3/service/MGGDBMService.java

@@ +1 @@
+/*
+ *    MGGDBMService.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.service;
 
@@ -6 +24 @@
 import org.w3c.dom.Element; 
 import org.w3c.dom.NodeList; 
+/**
+ *
+ * @author <a href="mailto:[email protected]">Katherine Don</a>
+ * @version $Revision$
+ */
 
-  
 public class MGGDBMService 
     extends ServiceModule {
@@ -26 +48 @@
     return null;
     }
-    
+  /** configure this service */
     public boolean configure(Element info) {
 
@@ -69 +91 @@
     return true;
     }
-   
+  /** process a text query */
     protected Element processTextQuery(Element request) {
     Element result = doc_.createElement("response");
@@ -81 +103 @@
     }
 
+  /** retrieve a document */
     protected Element processDocRetrieve(Element request) {
     Element result = doc_.createElement("response");
@@ -92 +115 @@
     }
 
+  /** retrieve metadata */
     protected Element processMetadataRetrieve(Element request) {
     Element result = doc_.createElement("response");

trunk/gsdl3/src/java/org/greenstone/gsdl3/service/MGPPService.java

@@ +1 @@
+/*
+ *    MGPPService.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.service;
 
@@ -6 +24 @@
 import org.w3c.dom.Element; 
 import org.w3c.dom.NodeList; 
+/**
+ * A Service class for MGPP
+ *
+ * @author <a href="mailto:[email protected]">Katherine Don</a>
+ * @version $Revision$
+ */
 
 
@@ -32 +56 @@
     
 
+    /** confifure this service */
     public boolean configure(Element info) {
 
@@ -83 +108 @@
     }
 
+    /** process a text query */
     protected Element processTextQuery(Element request) {
     Element result = doc_.createElement("response");
@@ -94 +120 @@
     }
 
+    /** process a fielded query */
     protected Element processFieldQuery(Element request) {
     Element result = doc_.createElement("response");
@@ -105 +132 @@
     }
 
+    /** retrieve a document */
     protected Element processDocRetrieve(Element request) {
     Element result = doc_.createElement("response");
@@ -116 +144 @@
     }
 
+    /** retrieve metadata */
     protected Element processMetadataRetrieve(Element request) {
     Element result = doc_.createElement("response");

trunk/gsdl3/src/java/org/greenstone/gsdl3/service/PhindService.java

@@ +1 @@
+/*
+ *    PhindService.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.service;
 
@@ -6 +24 @@
 import org.w3c.dom.Text; 
 
-/** PhindService - the phind phrase browsing service
+/** 
+ * PhindService - the phind phrase browsing service
  * 
+ * @author <a href="mailto:[email protected]">Katherine Don</a>
+ * @version $Revision$
  */
 public class PhindService 

trunk/gsdl3/src/java/org/greenstone/gsdl3/service/ServiceModule.java

@@ +1 @@
+/*
+ *    ServiceModule.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.service;
 
@@ -26 +44 @@
  * MGGDBMServiceModule may support "DocRetrieve", "TextQuery", "MetadataRetrieve" services
  *
+ * @author <a href="mailto:[email protected]">Katherine Don</a>
+ * @version $Revision$
  */
 public abstract class ServiceModule 
@@ -52 +72 @@
     protected HashMap service_info_map_ = null;
 
+    /** sets the collect name */
     public void setCollectionName(String coll_name) {
     collection_name_ = coll_name;
     }
     
+    /** sets the site home */
     public void setSiteHome(String site_home) {
     site_home_ = site_home;
     }
 
+    /** sets the message router */
     public void setMessageRouter(ModuleInterface m) {
        router_ = m;
     }
 
+    /** the no-args constructor */
     public ServiceModule() {
     converter_ = new XMLConverter();