| gvSIG desktop 1

/* gvSIG. Sistema de Informaci?n Geogr?fica de la Generalitat Valenciana

*

* Copyright (C) 2004 IVER T.I. and Generalitat Valenciana.

*

* 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., 59 Temple Place - Suite 330, Boston, MA  02111-1307,USA.

*

* For more information, contact:

*

*  Generalitat Valenciana

*   Conselleria d'Infraestructures i Transport

*   Av. Blasco Ib??ez, 50

*   46010 VALENCIA

*   SPAIN

*

*      +34 963862235

*   gvsig@gva.es

*      www.gvsig.gva.es

*

*    or

*

*   IVER T.I. S.A

*   Salamanca 50

*   46005 Valencia

*   Spain

*

*   +34 963163400

*   dac@iver.es

*/

package es.gva.cit.catalogClient.drivers;

import es.gva.cit.catalogClient.metadataXML.XMLNode;

import es.gva.cit.catalogClient.metadataXML.XMLTree;

import es.gva.cit.catalogClient.metadataXML.XMLTreeNumberOfRecordsAnswer;

import es.gva.cit.catalogClient.protocols.HTTPGetProtocol;

import es.gva.cit.catalogClient.protocols.HTTPPostProtocol;

import es.gva.cit.catalogClient.protocols.SOAPProtocol;

import es.gva.cit.catalogClient.querys.Query;

import es.gva.cit.catalogClient.querys.SRWQuery;

import org.apache.commons.httpclient.NameValuePair;

import java.net.URL;

import java.util.StringTokenizer;

/**

 * This class implements the CSW protocol.

 * 

 * @see http://www.loc.gov/z3950/agency/zing/srw/

 * @author Jorge Piera Llodra (piera_jor@gva.es)

 */

public class SRWCatalogServiceDriver extends AbstractCatalogServiceDriver {

    private String version = "1.1";

    private String recordXPath;

    private String resultSetTTL;

    /* (non-Javadoc)

     * @see ICatalogServerDriver#GetCapabilities(java.lang.String, java.lang.String)

    */

    public XMLNode[] getCapabilities(URL url) {

        XMLNode[] nodos = new HTTPGetProtocol().doQuery(url,

                getMessageCapabilities(), 0);

        if (nodos != null) {

            setCommunicationProtocol("GET");

            return nodos;

        }

        nodos = new HTTPPostProtocol().doQuery(url, getMessageCapabilities(), 0);

        if (nodos != null) {

            setCommunicationProtocol("POST");

            return nodos;

        }

        nodos = new SOAPProtocol().doQuery(url, getSOAPMessageCapabilities(), 0);

        if (nodos != null) {

            setCommunicationProtocol("SOAP");

        }

        return nodos;

    }

    /* (non-Javadoc)

     * @see ICatalogServerDriver#GetRecords(java.lang.String, java.lang.String, java.lang.String, int, int, java.lang.String, java.lang.String)

     */

    public XMLNode[] getRecords(URL url, Query query, int firstRecord) {

        setQuery(query);

        XMLNode[] answerNodes = null;

        XMLNode[] nodes = null;

        if (getCommunicationProtocol().equals("GET")) {

            nodes = new HTTPGetProtocol().doQuery(url,

                    getMessageRecords(getQuery(), firstRecord), firstRecord);

        }

        if (getCommunicationProtocol().equals("POST")) {

            nodes = new HTTPPostProtocol().doQuery(url,

                    getMessageRecords(getQuery(), firstRecord), firstRecord);

        }

        if (getCommunicationProtocol().equals("SOAP")) {

            nodes = new SOAPProtocol().doQuery(url,

                    getMessageRecords(getQuery(), firstRecord), firstRecord);

        }

        String prefix = new StringTokenizer(nodes[0].getName(), ":").nextToken();

        if (prefix.equals(nodes[0].getName())) {

            prefix = "";

        } else {

            prefix = prefix + ":";

        }

        int numberOfRecords = getNumberOfRecords(nodes[0],

                        prefix + "numberOfRecords",

                                null);

        if (numberOfRecords == -1) {

            return null;

        }   

        answerNodes = createAnswerTree(numberOfRecords, firstRecord, nodes[0],

                url,prefix);

        return answerNodes;

    }

    /**

     * It returns an array of nodes with:

     *         1st position -> tree with information of the answer

     *          Next positions -> One result for each position

     * @param numberOfRecords

     * Number of records returned by the query

     * @param firstRecord

     * Number of the first record

     * @param node

     * Tree returned by the server

     * @param url

     * Server URL

     * @param prefix

     * Tags Prefix

     * @return

     */

    public XMLNode[] createAnswerTree(int numberOfRecords, int firstRecord,

        XMLNode node, URL url,String prefix) {

        XMLNode[] answerNodes = null;

        if (numberOfRecords > 10) {

            answerNodes = new XMLNode[11];

        } else {

            answerNodes = new XMLNode[numberOfRecords + 1];

        }

        answerNodes[0] = XMLTreeNumberOfRecordsAnswer.getNode(numberOfRecords,

                firstRecord, firstRecord + numberOfRecords);

        XMLNode[] auxNodes = XMLTree.searchMultipleNode(node,

                prefix + "records->" + prefix + "record");

        for (int i = 1;

                (i <= numberOfRecords) && (i <= 10) &&

                (i <= (numberOfRecords - firstRecord + 1)); i++)

            answerNodes[i] = auxNodes[i - 1];

        return answerNodes;

    }

    /**

     * It creates the name-value pairs for the getCapabilities request 

     * @return

     * Name-Value pair array

     */

    public NameValuePair[] getMessageCapabilities() {

        NameValuePair nvp1 = new NameValuePair("OPERATION", "explain");

        NameValuePair nvp2 = new NameValuePair("VERSION", this.version);

        return new NameValuePair[] { nvp1, nvp2 };

    }

    /**

     * It creates the name-value pairs for the getRecords request 

     * @return

     * Name-Value pair array

     */

    public NameValuePair[] getMessageRecords(Query query, int firstRecord) {

        SRWQuery qsrwd = new SRWQuery(query);

        NameValuePair nvp1 = new NameValuePair("operation", "searchRetrieve");

        NameValuePair nvp2 = new NameValuePair("version", this.version);

        NameValuePair nvp3 = new NameValuePair("query", qsrwd.getQuery(null));

        NameValuePair nvp4 = new NameValuePair("maximumRecords", "10");

        NameValuePair nvp5 = new NameValuePair("recordPacking",

                getOutputFormat());

        NameValuePair nvp6 = new NameValuePair("startRecord",

                new String(new Integer(firstRecord).toString()));

        return new NameValuePair[] { nvp1, nvp2, nvp3, nvp4, nvp5, nvp6 };

    }

    /**

     * It creates the SOAP message for the getCapabilities request

     * 

     * @return

     * String with the SOAP message

     */

    public String getSOAPMessageCapabilities() {

        String soapMessage =

            "<SRW:explainRequest xmlns:SRW=\"http://www.loc.gov/zing/srw/\">" +

            "<SRW:version>" + version + "</SRW:version>" +

            "</SRW:explainRequest>";

        return SOAPProtocol.setSOAPMessage(soapMessage,null);

    }

    /**

     * It creates the SOAP message for the getRecords request

     * 

     * @return

     * String with the SOAP message

     */

    public String getSOAPMessageRecords(Query query) {

        SRWQuery qsrwd = new SRWQuery(query);

        String soapMessage =

            "<srw:searchRetrieveRequest xmlns:srw=\"http://www.loc.gov/zing/srw/\">" +

            "<srw:query><![CDATA[" + qsrwd.getQuery(null) + "]]></srw:query>" +

            "<srw:sortKeys xsi:nil=\"true\"/>" + "<srw:startRecord>" +

            getStartPosition() + "</srw:startRecord>" + "<srw:maximumRecords>" +

            getMaxRecords() + "</srw:maximumRecords>" + "<srw:recordPacking>" +

            getOutputFormat() + "</srw:recordPacking>" + "<srw:recordSchema>" +

            getOutputSchema()[0] + "</srw:recordSchema>" +

            "<srw:resultSetTTL>" + getResultSetTTL() + "</srw:resultSetTTL>" +

            "</srw:searchRetrieveRequest>";

        return SOAPProtocol.setSOAPMessage(soapMessage,null);

    }

    /**

     * @return Returns the recordXPath.

     */

    public String getRecordXPath() {

        return recordXPath;

    }

    /**

     * @param recordXPath The recordXPath to set.

     */

    public void setRecordXPath(String recordXPath) {

        this.recordXPath = recordXPath;

    }

    /**

     * @return Returns the resultSetTTL.

     */

    public String getResultSetTTL() {

        return resultSetTTL;

    }

    /**

     * @param resultSetTTL The resultSetTTL to set.

     */

    public void setResultSetTTL(String resultSetTTL) {

        this.resultSetTTL = resultSetTTL;

    }

    /**

     * @return Returns the version.

     */

    public String getVersion() {

        return version;

    }

    /**

     * @param version The version to set.

     */

    public void setVersion(String version) {

        this.version = version;

    }

    /* (non-Javadoc)

     * @see catalogClient.ICatalogServerDriver#setParameters(java.util.Properties)

     */

    public boolean setParameters(XMLNode[] nodes) {

        if (nodes[0].getName() != null) {

            String prefix = new StringTokenizer(nodes[0].getName(), ":").nextToken();

            prefix = prefix + ":";

            this.setOutputSchema(XMLTree.searchNodeValue(nodes[0],

                    prefix + "record->" + prefix + "recordSchema"));

            this.setOutputFormat(XMLTree.searchNodeValue(nodes[0],

                    prefix + "record->" + prefix + "recordPacking"));

            this.setStartPosition("1");

            this.setMaxRecords("10");

            this.setRecordXPath("");

            this.setResultSetTTL("0");

            this.setServerAnswerReady("Titulo: " +

                XMLTree.searchNodeValue(nodes[0],

                    prefix + "record->" + prefix +

                    "recordData->explain->databaseInfo->title") +

                "\nDescripcion: " +

                XMLTree.searchNodeValue(nodes[0],

                    prefix + "record->" + prefix +

                    "recordData->explain->databaseInfo->description"));

        }

        return true;

    }

    /* (non-Javadoc)

     * @see es.gva.cit.catalogClient.drivers.ICatalogServiveDriver#isTheProtocol(java.net.URL)

     */

    public boolean isProtocolSupported(URL url) {

        return SOAPProtocol.isProtocolSupported(url);

    }

}