Changeset 2155
- Timestamp:
- 2001-03-11T09:27:28+13:00 (23 years ago)
- Location:
- trunk/java-client
- Files:
-
- 9 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/java-client/Makefile
r2119 r2155 36 36 rm -rf docs 37 37 mkdir docs 38 javadoc -private -version -author -use -d docs -header "Documentation for the <a href=\"http://www.corba.org/\">CORBA</a> interface to the <a href=\"http://www.nzdl.org/\">NZDL</a> \'s Greenstone Digital Library software." -footer "This software is distributed under the <a href=\"http://www.gnu.org/copyleft/gpl.html\">GPL</a>" -windowtitle "Greenstone Digital Library Software from the NZDL" -link "http://www.scms.waikato.ac.nz/help/reference/jdk1.2/docs/api/" gnu.getopt org.nzdl.gsdl org.nzdl.gsdl.service org.nzdl.gsdl.util org.nzdl.gsdl.corba.gsdlInterface org.nzdl.gsdl.ptp39 38 javadoc -private -version -author -use -d docs -header "Documentation for the <a href=\"http://www.corba.org/\">CORBA</a> interface to the <a href=\"http://www.nzdl.org/\">NZDL</a>'s Greenstone Digital Library software." -footer "This software is distributed under the <a href=\"http://www.gnu.org/copyleft/gpl.html\">GPL</a>" -windowtitle "Greenstone Digital Library Software from the NZDL" -link "http://www.scms.waikato.ac.nz/help/reference/jdk1.2/docs/api/" gnu.getopt org.nzdl.gsdl org.nzdl.gsdl.service org.nzdl.gsdl.util org.nzdl.gsdl.corba.gsdlInterface org.nzdl.gsdl.ptp org.nzdl.gsdl.SimpleGraphicalClient -overview overview.html 39 cp org/nzdl/gsdl/service/nzdl-service-package.png docs/org/nzdl/gsdl/service/ 40 40 41 41 clean : -
trunk/java-client/org/nzdl/gsdl/service/NzdlCollectionInfo.java
r2145 r2155 1 /* 2 * NzdlCollectionInfo.java 3 * Copyright (C) 2001 New Zealand Digital Library Project 4 * 5 * This program is free software; you can redistribute it and/or modify 6 * it under the terms of the GNU General Public License as published by 7 * the Free Software Foundation; either version 2 of the License, or 8 * (at your option) any later version. 9 * 10 * This program is distributed in the hope that it will be useful, 11 * but WITHOUT ANY WARRANTY; without even the implied warranty of 12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 * GNU General Public License for more details. 14 * 15 * You should have received a copy of the GNU General Public License 16 * along with this program; if not, write to the Free Software 17 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. 18 */ 1 19 20 //the package we're in 2 21 package org.nzdl.gsdl.service; 3 22 … … 6 25 import org.nzdl.gsdl.util.*; 7 26 27 /** 28 * An object that stores information on a collection. Information is obtained from 29 * {@link NzdlService NzdlService.getCollectionInfo(name)} 30 * Easily interrogated by a user. 31 * 32 * @author Stuart Yeates ([email protected]) 33 * @author Aziz Mahoui ([email protected]) 34 * @author Gordon Paynter ([email protected]) 35 * @author Dave Nichols ([email protected]) 36 * @version $Revision$ 37 */ 8 38 public class NzdlCollectionInfo extends Object { 9 39 10 /** */11 40 private corbaColInfoResponse m_Info = null; 12 41 42 /** 43 * Create an instance of NzdlCollectionInfo. 44 */ 13 45 public NzdlCollectionInfo( corbaColInfoResponse _info ) { 14 46 m_Info = _info; 15 47 } 16 48 49 /** 50 * Returns the corbaInfoResponse. 51 */ 17 52 public corbaColInfoResponse getInfo(){ 18 53 return m_Info; 19 54 } 20 55 21 /** */ 56 /** 57 * Returns the name of a collection. <br> 58 * Pre: Created instance of NzdlCollectionInfo. Used 59 * {@link NzdlService NzdlService.getCollectionInfo(name)} 60 * to extract collection information. 61 * @return A string representing the name of the collection. 62 */ 22 63 public String getName() { 23 64 return NzdlCorbaFactory.toString( m_Info.shoftInfo.name ) ; 24 65 } 25 66 67 /** 68 * Returns true if collection is public. <br> 69 * Pre: Created instance of NzdlCollectionInfo. Used 70 * {@link NzdlService NzdlService.getCollectionInfo(name)} 71 * to extract collection information. 72 * @return Boolean true if collection is public, otherwise returns false. 73 */ 26 74 public boolean isPublic() { 27 75 return m_Info.isPublic; 28 76 } 29 77 78 /** 79 * Returns true if collection is a beta version. <br> 80 * Pre: Created instance of NzdlCollectionInfo. Used 81 * {@link NzdlService NzdlService.getCollectionInfo(name)} 82 * to extract collection information. 83 * @return Boolean true if collection is a beta version, otherwise returns false. 84 */ 30 85 public boolean isBeta() { 31 86 return m_Info.isBeta; 32 87 } 33 88 89 /** 90 * Returns an integer representation of build date. <br> 91 * Pre: Created instance of NzdlCollectionInfo. Used 92 * {@link NzdlService NzdlService.getCollectionInfo(name)} 93 * to extract collection information. 94 * @return Integer representation of date. 95 */ 34 96 public int getBuildDate() { 35 97 return m_Info.buildDate; 36 98 } 37 99 100 /** 101 * Returns the number of documents in a collection. <br> 102 * Pre: Created instance of NzdlCollectionInfo. Used 103 * {@link NzdlService NzdlService.getCollectionInfo(name)} 104 * to extract collection information. 105 * @return An integer representing the number of documents in the collection. 106 */ 38 107 public int getNumOfDocs() { 39 108 return m_Info.numDocs; 40 109 } 41 110 111 /** 112 * Returns the number of words in a collection. <br> 113 * Pre: Created instance of NzdlCollectionInfo. Used 114 * {@link NzdlService NzdlService.getCollectionInfo(name)} 115 * to extract collection information. 116 * @return An integer representing the number of words in the collection. 117 */ 42 118 public int getNumOfWords() { 43 119 return m_Info.numWords; 44 120 } 45 121 122 /** 123 * Returns the number of bytes in the collection. <br> 124 * Pre: Created instance of NzdlCollectionInfo. Used 125 * {@link NzdlService NzdlService.getCollectionInfo(name)} 126 * to extract collection information. 127 * @return An integer representing the number of bytes in the collection. 128 */ 46 129 public int getNumOfBytes() { 47 130 return m_Info.numBytes; 48 131 } 49 132 133 /** 134 * Returns a string describing collection details. <br> 135 * Pre: Created instance of NzdlCollectionInfo. Used 136 * {@link NzdlService NzdlService.getCollectionInfo(name)} 137 * to extract collection information. 138 * @return A string describing collection details such as: collection name; 139 * isPublic; isBeta; buildDate; numOfDocs; numOfWords; numOfBytes 140 */ 50 141 public String toString() { 51 142 StringBuffer buf = new StringBuffer(1000); … … 60 151 } 61 152 62 /** */ 153 /** 154 * Not currently implemented 155 */ 63 156 public void print() { 64 157 /* [email protected] */ -
trunk/java-client/org/nzdl/gsdl/service/NzdlQueryHit.java
r2098 r2155 1 /* 2 * NzdlCollectionInfo.java 3 * Copyright (C) 2001 New Zealand Digital Library Project 4 * 5 * This program is free software; you can redistribute it and/or modify 6 * it under the terms of the GNU General Public License as published by 7 * the Free Software Foundation; either version 2 of the License, or 8 * (at your option) any later version. 9 * 10 * This program is distributed in the hope that it will be useful, 11 * but WITHOUT ANY WARRANTY; without even the implied warranty of 12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 * GNU General Public License for more details. 14 * 15 * You should have received a copy of the GNU General Public License 16 * along with this program; if not, write to the Free Software 17 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. 18 */ 1 19 20 //the package we're in 2 21 package org.nzdl.gsdl.service; 3 22 4 23 import java.util.*; 5 24 25 /** 26 * Holds a single result from a query. NzdlQueryHit is used by 27 * {@link NzdlResponse NzdlResponse} and 28 * {@link NzdlResultSet NzdlResultSet} 29 */ 6 30 public class NzdlQueryHit extends java.lang.Object { 7 31 … … 19 43 private Map m_metaData = null; 20 44 21 /** */ 22 45 /** 46 * Sets the document ID. 47 * @param docID a string representaion of the document ID. 48 */ 23 49 public void setDocumentID( String _docID ) { 24 50 m_docID = _docID; 25 51 } 26 52 53 /** 54 * Sets the ranking. 55 * @param the ranking an integer representaion of the the hit's ranking. 56 */ 27 57 public void setRanking( int _ranking ) { 28 58 m_ranking = _ranking; 29 59 } 30 60 61 /** 62 * Sets the result number. 63 * @param resultNum is the integer representation of the result number. 64 */ 31 65 public void setResultNumber( int _resultNum ) { 32 66 m_resultNum = _resultNum; 33 67 } 34 68 69 /** 70 * Sets the number of terms matched. 71 * @param numTermsMatched the number of terms matched. 72 */ 35 73 public void setNumOfTermsMatched( int _numTermsMatched ) { 36 74 m_numTermsMatched = _numTermsMatched; 37 75 } 38 76 77 /** 78 * Sets the number of phrases matched. 79 * @param numPhrasesMatched the number of phrases matched. 80 */ 39 81 public void setNumOfPhrasesMatched( int _numPhrasesMatched ) { 40 82 m_numPhrasesMatched = _numPhrasesMatched; 41 83 } 42 84 85 /** 86 * Sets the metedata 87 * @param metaData the key in the map will be the metaData tag. 88 * The value for the key will be a Set of strings. 89 * For example: key = "Author", value = {A. Mahoui, S. Franks} 90 */ 43 91 public void setMetaData( Map _metaData ) { 44 92 m_metaData = _metaData; 45 93 } 46 94 47 /** */ 48 95 /** 96 * Gets the document ID of the query hit. 97 * @return document ID in string form. 98 */ 49 99 public String getDocumentID() { 50 100 return m_docID; 51 101 } 52 102 103 /** 104 * Gets the ranking of the query hit. 105 * @return integer representing the hits ranking. 106 */ 53 107 public int getRanking() { 54 108 return m_ranking; 55 109 } 56 110 111 /** 112 * Gets the result number of the query hit. 113 * @return integer representing the result number. 114 */ 57 115 public int getResultNumber() { 58 116 return m_resultNum; 59 117 } 60 118 119 /** 120 * Gets the number of terms matched in the hit. A term is an individual word 121 * in a query phrase. 122 * @return integer representing the number of terms matched. 123 */ 61 124 public int getNumOfTermsMatched() { 62 125 return m_numTermsMatched; 63 126 } 64 127 128 /** 129 * Gets the number of phrases matched in the hit. 130 * @return integer representing the number of phrases matched. 131 */ 65 132 public int getNumOfPhrasesMatched() { 66 133 return m_numPhrasesMatched; 67 134 } 68 135 136 /** 137 * Gets the metaData of the hit document. 138 * @return a map of the metadata. For example: key = "Author", value = 139 * {A. Mahoui, S. Franks} 140 */ 69 141 public Map getMetaData() { 70 142 return m_metaData; 71 143 } 72 144 73 /** returns a set of String objects */ 145 /** 146 * Gets a set of values for a metatag. 147 * @param a metatag, such as author. 148 * @return A set of string values for that metatag. 149 */ 74 150 public Set getMetaDataValues( String _metaTag ) { 75 151 return (Set) m_metaData.get( _metaTag ); 76 152 } 77 153 78 /** returns a set of key (String) objects */ 154 /** Gets the metatags for a hit. 155 * @return a set of key (String) objects such as Author, Title etc. 156 */ 79 157 public Set getMetaDataTags() { 80 158 return m_metaData.keySet(); 81 159 } 82 160 161 /** 162 * Gets a collection of metatag values for a hit. 163 * @return a collection of metatag values. 164 */ 83 165 public Collection getMetaDataValues() { 84 166 return m_metaData.values(); -
trunk/java-client/org/nzdl/gsdl/service/NzdlRequest.java
r2108 r2155 59 59 * Creates an instance of NzdlRequest based on a document ID. When serviced 60 60 * by {@link NzdlService NzdlService} this type of request will return 61 * exactly one document refer nce. <br>61 * exactly one document reference. <br> 62 62 * Pre: Have obtained a valid document ID.<br> 63 63 * Post: Created a browse filter request -
trunk/java-client/org/nzdl/gsdl/service/NzdlResultSet.java
r2108 r2155 190 190 * {@link NzdlService NzdlService} object has filled the NzdlResponse 191 191 * object with results from servicing a {@link NzdlRequest NzdlRequest}.<br> 192 * @return A map of metatag values in the specified document. The key193 * of the mapis the metatag field such as Author or Title.192 * @return A map of metatag values in the specified document. The map key 193 * is the metatag field such as Author or Title. 194 194 */ 195 195 public Set getMetaData( String _docID, String _metaTag ) { -
trunk/java-client/org/nzdl/gsdl/service/NzdlService.java
r2098 r2155 1 /* 2 * NzdlService.java 3 * Copyright (C) 2001 New Zealand Digital Library Project 4 * 5 * This program is free software; you can redistribute it and/or modify 6 * it under the terms of the GNU General Public License as published by 7 * the Free Software Foundation; either version 2 of the License, or 8 * (at your option) any later version. 9 * 10 * This program is distributed in the hope that it will be useful, 11 * but WITHOUT ANY WARRANTY; without even the implied warranty of 12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 * GNU General Public License for more details. 14 * 15 * You should have received a copy of the GNU General Public License 16 * along with this program; if not, write to the Free Software 17 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. 18 */ 1 19 20 //the package we're in 2 21 package org.nzdl.gsdl.service; 3 22 4 23 import java.util.*; 5 24 25 /** 26 * An object that services CORBA client requests to a Greenstone Digital 27 * Library. 28 * @author Stuart Yeates ([email protected]) 29 * @author Aziz Mahoui ([email protected]) 30 * @author Gordon Paynter ([email protected]) 31 * @version $Revision$ 32 */ 6 33 public interface NzdlService { 7 34 35 /** 36 * Allow the client to configure a CORBA server. 37 * @param key the parameter to be set. 38 * @param values what that parameter will be set to. 39 */ 8 40 public void configure( String key, Set values ); 41 42 /** 43 * Obtain the set of collection names for a Greenstone library. 44 * @return A set of collection names in string format. 45 */ 9 46 public Set getCollectionSet( ); 47 48 /** 49 * Check if ORB knows of this collection. 50 * @param collectionName the name of a Greenstone collection. 51 * @return boolean <TT>true</TT> if collection is found, else <TT>false</TT>. 52 */ 10 53 public boolean hasCollection( String collectionName ); 54 55 /** 56 * Check if ORB can communicate with of this collection. 57 * @param collectionName the name of a collection to be pinged. 58 * @return boolean <TT>true</TT> if collection returned ping, else 59 * <TT>false</TT>. 60 */ 11 61 public boolean pingCollection( String collectionName ); 62 63 /** 64 * Extract information on this collection into a 65 * {@link NzdlCollectionInfo NzdlCollectionInfo} object 66 * @param collectionName the Greenstone collection to be retrieved. 67 * @return an instance of 68 * {@link NzdlCollectionInfo NzdlCollectionInfo} containing data on a 69 * collection 70 */ 12 71 public NzdlCollectionInfo getCollectionInfo( String collectionName ); 72 73 /** 74 * Returns the set of filters for the service object. 75 * @param collectionName the name of the Greenstone collection. 76 * @return a set of strings that name the filters, for example 77 * BrowseFilter, QueryFilter and NullFilter. 78 */ 13 79 public Set getFilterSet( String collectionName ); 80 81 /** 82 * Not Currently implemented. 83 */ 14 84 public Set getMetaTagSet( String collectionName ); 85 86 /** 87 * Returns the Greenstone Markup Language (GML) text for a particular 88 * document from a collection. 89 * @param collectionName the name of the Greenstone collection. 90 * @param documentID the document identity string 91 * @return the GML document in the form of a string. 92 */ 15 93 public String getDocument( String collectionName, String documentID ); 94 95 /** 96 * Returns the set of value(s) for a metatag from a particular document. 97 * @param collectionName the name of the Greenstone collection. 98 * @param documentID the document identifier. 99 * @param metaTag the metatag name such as: Title, Author, Date and Images. 100 * @return The set of value(s) for the requested metatag and document. In 101 * cases such as Title, Author, Date there will probably be only one value 102 * per document. 103 */ 16 104 public Set getMetaData( String collectionName, String documentID, String metaTag ); 105 106 /** 107 * Returns a map of value(s) for a metatag from a list of documents. 108 * @param collectionName name of the Greenstone collection 109 * @param docIDs a list of document identifier strings. 110 * @param metaTag the metatag name such as: Title, Author, Date and Images. 111 * @return The map of value(s) for the requested metatag and document. In 112 * cases such as Title, Author, Date there will probably be only one value 113 * per document. 114 */ 17 115 public Map getMetaData( String collectionName, List documentIDs, String metaTag ); 116 117 /** 118 * Services a {@link NzdlRequest NzdlRequest} to a collection and places 119 * the results into a {@link NzdlResponse NzdlResponse} object. <br> 120 * Pre: Created instances of NzdlRequest and NzdlResponse. <br> 121 * Post: Placed the result data into NzdlResponse object. 122 * @param collectionName name of the Greenstone collection. 123 * @param request an instance of NzdlRequest with query data to be serviced 124 * @param response an instance of NzdlResponse. where the results of 125 * sevciving the query will be placed 126 */ 18 127 public void service( String collectionName, NzdlRequest request, NzdlResponse response ); 19 128 20 129 } 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 -
trunk/java-client/org/nzdl/gsdl/service/NzdlServiceClient.java
r2148 r2155 1 1 /* 2 * NzdlServiceClient.java 3 * Copyright (C) 2001 New Zealand Digital Library Project 4 * 5 * This program is free software; you can redistribute it and/or modify 6 * it under the terms of the GNU General Public License as published by 7 * the Free Software Foundation; either version 2 of the License, or 8 * (at your option) any later version. 9 * 10 * This program is distributed in the hope that it will be useful, 11 * but WITHOUT ANY WARRANTY; without even the implied warranty of 12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 * GNU General Public License for more details. 14 * 15 * You should have received a copy of the GNU General Public License 16 * along with this program; if not, write to the Free Software 17 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. 18 */ 19 20 //the package we're in 2 21 package org.nzdl.gsdl.service; 3 22 4 23 import java.io.*; 5 24 import java.util.*; 6 /* *jdk 1.3 orb */25 /* jdk 1.3 orb */ 7 26 import org.omg.CORBA.*; 8 /* *gsdl corba stuff */27 /* gsdl corba stuff */ 9 28 import org.nzdl.gsdl.corba.gsdlInterface.*; 10 29 import org.nzdl.gsdl.util.*; 11 30 31 /** 32 * Used to implement the {@link NzdlService NzdlService} object. 33 * NzdlService is an object that services CORBA client requests to a 34 * Greenstone Digital Library. 35 * 36 * @author Stuart Yeates ([email protected]) 37 * @author Aziz Mahoui ([email protected]) 38 * @author Gordon Paynter ([email protected]) 39 * @version $Revision$ 40 */ 12 41 public class NzdlServiceClient 13 42 extends java.lang.Object … … 16 45 private corbaiface m_nzdlServer = null; 17 46 47 /** 48 * Creates an instance of Java's ORB (Object Request Broker) to interface 49 * to a Greenstone Digital Library. 50 * @param <b>args</b> command-line arguments from the application's main method, or 51 * alternatively, the name of the applet. This parameter is passed to 52 * <TT>ORB.init( _args, _props)</TT>. Args may be a <TT>null</TT>. 53 * @param <b>props</b> application specific properties. 54 * This parameter is passed to 55 * <TT>ORB.init( _args, _props)</TT>. props may be a <TT>null</TT>. 56 * @param <b>IOR</b> the Interoperable Object Reference, a string that identifies 57 * the computer on which corbaserver is running and the interface it 58 * supports. 59 * @see The Java documentation on the ORB class. 60 */ 18 61 public NzdlServiceClient( String [] _args, Properties _props, String _IOR) { 19 62 corbaComErrorHolder error = NzdlCorbaFactory.createComErrorHolder(); … … 52 95 System.err.println("Service init ... YES"); 53 96 } 54 97 98 /** 99 * Allow the client to configure a CORBA server. 100 * @param key the parameter to be set. 101 * @param values what that parameter will be set to. 102 */ 55 103 public void configure( String _key, Set _values ) { 56 104 if (_key == null || _key.equals("")){ … … 68 116 } 69 117 } 70 118 119 /** 120 * Obtain the set of collection names for a Greenstone library. 121 * @return A set of collection names in string format. 122 */ 71 123 public Set getCollectionSet( ) { 72 124 corbaComErrorHolder error = NzdlCorbaFactory.createComErrorHolder(); … … 82 134 return collSet ; 83 135 } 84 136 137 /** 138 * Check if ORB knows of this collection. 139 * @param name the name of a collecion to be searched for. 140 * @return boolean <TT>true</TT> if collection is found, else <TT>false</TT>. 141 */ 85 142 public boolean hasCollection( String _name ) { 86 143 if (_name == null || _name.equals("")){ … … 94 151 return c_has.value; 95 152 } 96 153 154 155 /** 156 * Check if ORB can communicate with of this collection. 157 * @param name the name of a collecion to be pinged. 158 * @return boolean <TT>true</TT> if collection returned ping, else 159 * <TT>false</TT>. 160 */ 97 161 public boolean pingCollection( String _name ) { 98 162 if (_name == null || _name.equals("")){ … … 105 169 return result; 106 170 } 107 171 172 /** 173 * Extract information on this collection into a 174 * {@link NzdlCollectionInfo NzdlCollectionInfo} object 175 * @param name the collection to be retrieved. 176 * @return an instance of 177 * {@link NzdlCollectionInfo NzdlCollectionInfo} containing data on a 178 * collection 179 */ 108 180 public NzdlCollectionInfo getCollectionInfo( String _name ) { 109 181 if (_name == null || _name.equals("")){ … … 118 190 } 119 191 192 /** 193 * Returns the set of filters for the service object. 194 * @param name the collection name 195 * @return a set of strings that name the filters, for example 196 * BrowseFilter, QueryFilter and NullFilter. 197 */ 120 198 public Set getFilterSet( String _name ) { 121 199 if (_name == null || _name.equals("")){ … … 137 215 } 138 216 217 /** 218 * Not Currently implemented. 219 */ 139 220 public Set getMetaTagSet( String _name ) { 140 221 if (_name == null || _name.equals("")){ … … 145 226 } 146 227 228 /** 229 * Returns the Greenstone Markup Language (GML) text for a particular 230 * document from a collection. 231 * @param name the name of the collection. 232 * @param docID the document identity string 233 * @return the GML document in the form of a string. 234 */ 147 235 public String getDocument( String _name, String _docID ) { 148 236 if (_name == null || _name.equals("")){ … … 162 250 } 163 251 252 /** 253 * Returns the set of value(s) for a metatag from a particular document. 254 * @param name collection name 255 * @param docID the document identifier. 256 * @param metaTag the metatag name such as: Title, Author, Date and Images. 257 * @return The set of value(s) for the requested metatag and document. In 258 * cases such as Title, Author, Date there will probably be only one value 259 * per document. 260 */ 164 261 public Set getMetaData( String _name, String _docID, String _metaTag ) { 165 262 if (_name == null || _name.equals("")){ … … 176 273 service( _name, request, response ); 177 274 NzdlResultSet resultSet = response.getResultSet(); 178 /* *275 /* 179 276 * Because a result set may contain several hits, we only return 180 277 * the set of metadata values of the specifed meta tag for the … … 184 281 } 185 282 283 /** 284 * Returns a map of value(s) for a metatag from a list of documents. 285 * @param name collection name 286 * @param docIDs a list of document identifier strings. 287 * @param metaTag the metatag name such as: Title, Author, Date and Images. 288 * @return The map of value(s) for the requested metatag and document. In 289 * cases such as Title, Author, Date there will probably be only one value 290 * per document. 291 */ 186 292 public Map getMetaData( String _name, List _docIDs, String _metaTag ) { 187 293 if (_name == null || _name.equals("")){ … … 202 308 //return resultSet.getAllMetaData( ); 203 309 } 204 310 311 /** 312 * Services a {@link NzdlRequest NzdlRequest} to a collection and places 313 * the results into a {@link NzdlResponse NzdlResponse} object. <br> 314 * Pre: Created instances of NzdlRequest and NzdlResponse. <br> 315 * Post: Placed the result data into NzdlResponse object. 316 * @param name the collection name. 317 * @param request an instance of NzdlRequest with query data to be serviced 318 * @param response an instance of NzdlResponse. where the results of 319 * sevciving the query will be placed 320 */ 205 321 public void service( String _name, NzdlRequest _request, NzdlResponse _response ) { 206 322 if (_name == null || _name.equals("")){ … … 221 337 222 338 } 223 224 225 226 227 228 229 230 231 232 233 234 -
trunk/java-client/org/nzdl/gsdl/util/NzdlConstants.java
r2098 r2155 1 /* 2 * NzdlConstants.java 3 * Copyright (C) 2001 New Zealand Digital Library Project 4 * 5 * This program is free software; you can redistribute it and/or modify 6 * it under the terms of the GNU General Public License as published by 7 * the Free Software Foundation; either version 2 of the License, or 8 * (at your option) any later version. 9 * 10 * This program is distributed in the hope that it will be useful, 11 * but WITHOUT ANY WARRANTY; without even the implied warranty of 12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 * GNU General Public License for more details. 14 * 15 * You should have received a copy of the GNU General Public License 16 * along with this program; if not, write to the Free Software 17 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. 18 */ 1 19 20 //the package we're in 2 21 package org.nzdl.gsdl.util; 3 22 -
trunk/java-client/org/nzdl/gsdl/util/NzdlCorbaFactory.java
r2098 r2155 1 1 /* 2 * NzdlCorbaFactory.java 3 * Copyright (C) 2001 New Zealand Digital Library Project 4 * 5 * This program is free software; you can redistribute it and/or modify 6 * it under the terms of the GNU General Public License as published by 7 * the Free Software Foundation; either version 2 of the License, or 8 * (at your option) any later version. 9 * 10 * This program is distributed in the hope that it will be useful, 11 * but WITHOUT ANY WARRANTY; without even the implied warranty of 12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 * GNU General Public License for more details. 14 * 15 * You should have received a copy of the GNU General Public License 16 * along with this program; if not, write to the Free Software 17 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. 18 */ 19 20 //the package we're in 2 21 package org.nzdl.gsdl.util; 3 22
Note:
See TracChangeset
for help on using the changeset viewer.