Revision 3566 trunk/applications/appCatalogYNomenclatorClient/src/es/gva/cit/catalogClient/drivers/ICatalogServiceDriver.java
| ICatalogServiceDriver.java | ||
|---|---|---|
| 1 |
|
|
| 1 | 2 |
/* gvSIG. Sistema de Informaci?n Geogr?fica de la Generalitat Valenciana |
| 2 | 3 |
* |
| 3 | 4 |
* Copyright (C) 2004 IVER T.I. and Generalitat Valenciana. |
| ... | ... | |
| 39 | 40 |
* dac@iver.es |
| 40 | 41 |
*/ |
| 41 | 42 |
package es.gva.cit.catalogClient.drivers; |
| 42 |
|
|
| 43 |
import es.gva.cit.catalogClient.metadataXML.XMLNode; |
|
| 44 | 43 |
import es.gva.cit.catalogClient.querys.Query; |
| 45 |
|
|
| 46 |
|
|
| 47 | 44 |
import java.net.URL; |
| 45 |
import java.util.Collection; |
|
| 48 | 46 |
/** |
| 49 | 47 |
* This interface has to be implemented by all the classes that implement |
| 50 | 48 |
* a catalog protocol. It describes all the common operations. |
| 51 | 49 |
* |
| 50 |
* |
|
| 52 | 51 |
* @author Jorge Piera Llodra (piera_jor@gva.es) |
| 53 | 52 |
*/ |
| 54 | 53 |
public interface ICatalogServiceDriver {
|
| 55 |
/**
|
|
| 56 |
* It have to prove if the specified protocol is supported.
|
|
| 57 |
* @param url
|
|
| 58 |
* Server URL
|
|
| 59 |
* @return
|
|
| 60 |
* true if is supported, false if it isn't supported
|
|
| 61 |
*/
|
|
| 54 |
/** |
|
| 55 |
* It have to prove if the specified protocol is supported. |
|
| 56 |
*
|
|
| 57 |
*
|
|
| 58 |
* @return true if is supported, false if it isn't supported
|
|
| 59 |
* @param url Server URL
|
|
| 60 |
*/ |
|
| 62 | 61 |
public boolean isProtocolSupported(URL url); |
| 63 |
|
|
| 64 |
/** |
|
| 65 |
* It try to discover the server capabilities. |
|
| 66 |
* @param url |
|
| 67 |
* Server URL |
|
| 68 |
* @return |
|
| 69 |
* Node with the server answer. |
|
| 70 |
*/ |
|
| 71 |
public XMLNode[] getCapabilities(URL url); |
|
| 72 |
|
|
| 73 |
/** |
|
| 74 |
* It send a request with a query to retrieve the server records |
|
| 75 |
* @param url |
|
| 76 |
* Server URL |
|
| 77 |
* @param query |
|
| 78 |
* It contains the values to do the query (title="XXX",abstract="YYY",...) |
|
| 79 |
* @param firstRecord |
|
| 80 |
* Number of the first record to retrieve |
|
| 81 |
* @return |
|
| 82 |
* Node array with the retrieved records |
|
| 83 |
*/ |
|
| 84 |
public XMLNode[] getRecords(URL url, Query query, int firstRecord); |
|
| 85 |
|
|
| 86 |
/** |
|
| 87 |
* This method is used to update the client parameters |
|
| 88 |
* @param nodes |
|
| 89 |
* Node with the parameters to update |
|
| 90 |
* @param url |
|
| 91 |
* Server URL |
|
| 92 |
* @return |
|
| 93 |
* true if the it's possible to update the server |
|
| 94 |
*/ |
|
| 95 |
public boolean setParameters(XMLNode[] nodes,URL url); |
|
| 96 |
|
|
| 97 |
/** |
|
| 98 |
* It return a message to write in the server connection frame |
|
| 99 |
* @return |
|
| 100 |
* It is/isn't the supported protocol |
|
| 101 |
*/ |
|
| 62 |
/** |
|
| 63 |
* It try to discover the server capabilities. |
|
| 64 |
* |
|
| 65 |
* |
|
| 66 |
* @return Node with the server answer. |
|
| 67 |
* @param url Server URL |
|
| 68 |
*/ |
|
| 69 |
public Collection getCapabilities(URL url); |
|
| 70 |
/** |
|
| 71 |
* It send a request with a query to retrieve the server records |
|
| 72 |
* |
|
| 73 |
* |
|
| 74 |
* @return Node array with the retrieved records |
|
| 75 |
* @param url Server URL |
|
| 76 |
* @param query It contains the values to do the query (title="XXX",abstract="YYY",...) |
|
| 77 |
* @param firstRecord Number of the first record to retrieve |
|
| 78 |
*/ |
|
| 79 |
public Collection getRecords(URL url, Query query, int firstRecord); |
|
| 80 |
/** |
|
| 81 |
* This method is used to update the client parameters |
|
| 82 |
* |
|
| 83 |
* |
|
| 84 |
* @return true if the it's possible to update the server |
|
| 85 |
* @param nodes Node with the parameters to update |
|
| 86 |
* @param url Server URL |
|
| 87 |
*/ |
|
| 88 |
public boolean setParameters(Collection nodes, URL url); |
|
| 89 |
/** |
|
| 90 |
* It return a message to write in the server connection frame |
|
| 91 |
* |
|
| 92 |
* |
|
| 93 |
* @return It is/isn't the supported protocol |
|
| 94 |
*/ |
|
| 102 | 95 |
public String getServerAnswerReady(); |
| 103 |
|
|
| 104 |
/**
|
|
| 105 |
* It returns the profile to create the query. Examples of profiles are:
|
|
| 106 |
* ISO19115
|
|
| 107 |
* DUBLINCORE
|
|
| 108 |
* EBRIM
|
|
| 109 |
* @return
|
|
| 110 |
* String
|
|
| 111 |
*/
|
|
| 96 |
/** |
|
| 97 |
* It returns the profile to create the query. Examples of profiles are:
|
|
| 98 |
* ISO19115
|
|
| 99 |
* DUBLINCORE
|
|
| 100 |
* EBRIM
|
|
| 101 |
*
|
|
| 102 |
*
|
|
| 103 |
* @return String
|
|
| 104 |
*/ |
|
| 112 | 105 |
public String getQueryProfile(); |
| 113 | 106 |
} |
| 107 |
|
|
| 108 |
|
|
Also available in: Unified diff