| 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.parsers.csw.ProtocolsOperations;

import es.gva.cit.catalogClient.parsers.csw.cswCapabilitiesParser;

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.CSWQuery;

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

import es.gva.cit.catalogClient.utils.Strings;

import org.apache.commons.httpclient.NameValuePair;

import java.net.URL;

/**

 * This class implements the CSW protocol.

 * 

 * @see http://portal.opengeospatial.org/files/?artifact_id=5929&version=1

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

 */

public class CSWCatalogServiceDriver extends AbstractCatalogServiceDriver {

    private String responseHandler = null;

    private String hopCount = null;

    private String distributedSearch = null;

    private String constraint = null;

    private String[] CONSTRAINTLANGUAGE = null;

    private String[] elementSetName = null;

    private String[] typeNames = null;

    private String[] resultType = null;

    private String[] NAMESPACE = null;

    private String ServerProfile = "ebRIM"; //or ISO

    private String version = "2.0.0";

    private ProtocolsOperations operations = null;

    /*

     * (non-Javadoc)

     *

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

     *      java.lang.String)

     */

    public XMLNode[] getCapabilities(URL url) {

        XMLNode[] nodes = null;

        System.out.println("**************GET*************");

        nodes = new HTTPGetProtocol().doQuery(url, getMessageCapabilities(), 0);

        if (nodes == null) {

            System.out.println("**************POST*************");

            nodes = new HTTPPostProtocol().doQuery(url,

                    getPOSTMessageCapabilities(), 0);

            if (nodes == null) {

                System.out.println("**************SOAP*************");

                nodes = new SOAPProtocol().doQuery(url,

                        getSOAPMessageCapabilities(), 0);

                if (nodes == null) {

                    return null;

                } else {

                    setCommunicationProtocol("SOAP");

                }

            } else {

                setCommunicationProtocol("POST");

            }

        } else {

            setCommunicationProtocol("GET");

        }

        return nodes;

    }

    /**

     * this method implements the describeRecords operation

     * @param url

     * @return

     */

    public XMLNode[] describeRecords(URL url) {

        //return new HTTPPostProtocol().doQuery(url, getMessageDescribeRecords(),0);

        return null;

    }

    /*

     * (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 (getOperations().getGetRecords()==null)

                //return null;

        /*

        for (int i=0 ; i<getOperations().getGetRecords().length; i++){

                if (getOperations().getGetRecords()[i].equals("SOAP")){

                         System.out.println("**************SOAP*************");

                         nodes = new SOAPProtocol().doQuery(url,

                        getSOAPMessageRecords(getQuery(), firstRecord), firstRecord);

                         setCommunicationProtocol("SOAP");

                 //We must cut the SOAP Head

                 nodes[0] = SOAPMessageParser.cutHead(nodes[0]);

                         break;

                }

            if (getOperations().getGetRecords()[i].equals("POST")){*/

                    System.out.println("**************POST*************");

                nodes = new HTTPPostProtocol().doQuery(url,

                        getPOSTMessageRecords(getQuery(), firstRecord), firstRecord);

                setCommunicationProtocol("POST");                

                //break;

            /*}

            if (getOperations().getGetRecords()[i].equals("GET")){

                    System.out.println("**************GET*************");

                    nodes = new HTTPGetProtocol().doQuery(url,

                        getMessageRecords(getQuery()), firstRecord);

                    setCommunicationProtocol("GET");                    

                break;

            }

        }*/  

        if (nodes == null) 

                return null;

        int numberOfRecords = getNumberOfRecords(nodes[0]);

        if (numberOfRecords == -1) {

            return null;

        }

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

                url);

        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

     * @return

     */

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

        XMLNode node, URL url) {

        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 = cutMetadata(node);

        System.out.print(firstRecord);

        if (getServerProfile().equals("ebRIM")) {

            auxNodes = getEbRIMNodes(auxNodes, url);

        }

        for (int i = 1;

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

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

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

        return answerNodes;

    }

    /**

     * This function retrieve the nodes for one ebRIM answer

     * @param nodes

     * Nodes of the ebRIM answer

     * @param nodes

     * Server URL

     * @return

     * Medatada Nodes.

     */

    public XMLNode[] getEbRIMNodes(XMLNode[] nodes, URL url) {

        XMLNode[] auxNodes = new XMLNode[nodes.length];

        for (int i = 0; i < nodes.length; i++) {

            String id = XMLTree.searchAtribute(nodes[i], "id");

            auxNodes[i] = new HTTPGetProtocol().doQuery(url,

                    getEbRIMRequestParameters(id), 0)[0];

        }

        return auxNodes;

    }

    /**

     * It Returns the parameters needed by getExtrinsicContent

     * @param id

     * Record id

     * @return

     */

    NameValuePair[] getEbRIMRequestParameters(String id) {

        NameValuePair nvp1 = new NameValuePair("request", "getExtrinsicContent");

        NameValuePair nvp2 = new NameValuePair("id", id);

        return new NameValuePair[] { nvp1, nvp2 };

    }

    /**

     * This function returns the number of records that have been retrieved.

     * It Reads a Node value.

     * @param node

     * The answer tree

     * @return

     * The number of records

     */

    public int getNumberOfRecords(XMLNode node){

            int numberOfRecords = getNumberOfRecords(node,"csw:SearchResults","numberOfRecordsMatched");

            if (numberOfRecords == -1)

                    numberOfRecords = getNumberOfRecords(node,"SearchResults","numberOfRecordsMatched");

            return numberOfRecords;

    }

    /**

     * This function finds and separates metadata from a full tree

     * @param node

     * full tree

     * @return

     * An array of trees that contain metadata.

     */

    public XMLNode[] cutMetadata(XMLNode node) {

        XMLNode[] auxNodes = XMLTree.searchMultipleNode(node,

                "csw:SearchResults->brief:MD_Metadata");

        if (auxNodes.length == 0) {

            auxNodes = XMLTree.searchMultipleNode(node,

                    "SearchResults->ebrim:Organization");

        }

        if (auxNodes.length == 0) {

            auxNodes = XMLTree.searchMultipleNode(node,

                    "SearchResults->wrs:WRSExtrinsicObject");

        }

        return auxNodes;

    }

   /**

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

    * @return

    * Name-Value pair array

    */

    public NameValuePair[] getMessageCapabilities() {

        NameValuePair nvp1 = new NameValuePair("request", "getCapabilities");

        NameValuePair nvp2 = new NameValuePair("service", "CSW");

        NameValuePair nvp3 = new NameValuePair("acceptversion", this.version);

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

    }

    /**

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

     * @return

     * Name-Value pair array

     */

    public NameValuePair[] getMessageDescribeRecords() {

        NameValuePair nvp1 = new NameValuePair("request", "describeRecord");

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

        NameValuePair nvp3 = new NameValuePair("outputformat",

                this.getOutputFormat());

        NameValuePair nvp4 = new NameValuePair("schemalanguage", "XMLSCHEMA");

        NameValuePair nvp5 = new NameValuePair("typename",

                this.getTypeNames()[0]);

        NameValuePair nvp6 = new NameValuePair("namespace",

                "csw:http://www.opengis.org/csw");

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

    }

    /**

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

     * 

     * @param query

     * It contains the fields to include in the query

     * @return

     * Name-Value pair array

     */

    public NameValuePair[] getMessageRecords(Query query) {

        CSWQuery cswq = new CSWQuery(query);

        NameValuePair nvp1 = new NameValuePair("request", "getRecords");

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

        NameValuePair nvp3 = new NameValuePair("service", "CSW");

        NameValuePair nvp4 = new NameValuePair("outputformat",

                this.getOutputFormat());

        System.out.println(this.getOutputFormat());

        NameValuePair nvp5 = new NameValuePair("outputschema",

                this.getOutputSchema()[0]);

        //NameValuePair nvp6= new NameValuePair("resulttype",this.getResultType()[0]);

        NameValuePair nvp7 = new NameValuePair("namespace",

                "csw:http://www.opengis.org/csw");

        NameValuePair nvp8 = new NameValuePair("typename",

                Strings.getComaSeparated(this.getTypeNames()));

        NameValuePair nvp9 = new NameValuePair("elementsetname", "full");

        NameValuePair nvp10 = new NameValuePair("constraintlanguage", "FILTER");

        NameValuePair nvp11 = new NameValuePair("constraint",

                cswq.getQuery(this.getServerProfile()));

        System.out.println(cswq.getQuery(this.getServerProfile()));

        return new NameValuePair[] {

            nvp1, nvp2, nvp3, nvp4, nvp5, nvp7, nvp8, nvp9, nvp10, nvp11

        };

    }

    /**

     * It creates the XML for the getCapabilities request

     * 

     * @return

     * Name-value pair with a XML request

     */

    public NameValuePair[] getPOSTMessageCapabilities() {

        String message = "<csw:GetCapabilities service=\"CSW\" version=\"2.0.0\" " +

            "xmlns:csw=\"http://www.opengis.net/cat/csw\" " +

            "xmlns:ogc=\"http://www.opengis.net/ogc\">" +

            "<AcceptVersions xmlns=\"http://www.opengis.net/ows\">" +

            "<Version>" + version + "</Version>" + "</AcceptVersions>" +

            "<AcceptFormats xmlns=\"http://www.opengis.net/ows\">" +

            "<OutputFormat>text/xml</OutputFormat>" + "</AcceptFormats>" +

            "</csw:GetCapabilities>";

        System.out.println(message);

        NameValuePair nvp1 = new NameValuePair("body", message);

        return new NameValuePair[] { nvp1 };

    }

    /**

     * It creates the XML for the describeRecords request

     * 

     * @return

     * Name-value pair with a XML request

     */

    public NameValuePair[] getPOSTDescribeRecords() {

        String message = "<csw:DescribeRecord " +

            "xmlns:csw=\"http://www.opengis.net/cat/csw\" " +

            "xmlns:ogc=\"http://www.opengis.net/ogc\" " + "service=\"CSW\" " +

            "version=" + version + " " + "outputFormat=\"test/xml\" " +

            "schemaLanguage=\"XMLSCHEMA\">" +

            "<csw:TypeName>csw:record</csw:TypeName>" +

            "</csw:DescribeRecord>";

        System.out.println(message);

        NameValuePair nvp1 = new NameValuePair("body", message);

        return new NameValuePair[] { nvp1 };

    }

    /**

     * It creates the XML for the getRecords request

     * 

     * @return

     * Name-value pair with a XML request

     */

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

        CSWQuery cswq = new CSWQuery(query);

        String message = "<?xml version='1.0' encoding='UTF-8'?>" +

            "<GetRecords " + "service='CSW' " +

            "version='2.0.0' " + "xmlns='http://www.opengis.net/cat/csw' " +

            "xmlns:ogc='http://www.opengis.net/ogc' " +

            "xmlns:gml='http://www.opengis.net/gml' " + "startPosition='" +

            firstRecord + "' " + "maxRecords='10' " +

            "outputFormat='text/xml' " + "resultType='results'>" +

            "<Query typeNames='Dataset Classification Association Geometry'>" +

            "<ElementSetName typeNames='Dataset'>summary</ElementSetName>" +

            "<Constraint version='1.0.20'>" +

            cswq.getQuery(this.getServerProfile()) + "</Constraint>" +

            "</Query>" + "</GetRecords>";

        /*

        String message = "<csw:GetRecords " +

        "xmlns:csw=\"http://www.opengis.net/cat/csw\" " +

        "xmlns:ogc=\"http://www.opengis.net/ogc\" " + "service=\"CSW\" " +

        "version=\"2.0.0\" " + "resultType=\"results\">" +

        "<csw:Query typeNames=\"Dataset\">" +

        "<csw:ElementSetName>brief</csw:ElementSetName>" +

        "<csw:Constraint version=\"2.0.0\">" +

        cswq.getQuery(this.getServerProfile()) + "</csw:Constraint>" +

        "</csw:Query>" + "</csw:GetRecords>";

        */

        System.out.println(message);

        NameValuePair nvp1 = new NameValuePair("body", message);

        return new NameValuePair[] { nvp1 };

    }

    /**

     * It creates the SOAP message for the getCapabilities request

     * 

     * @return

     * String with the SOAP message

     */

    public String getSOAPMessageCapabilities() {

        return SOAPProtocol.setSOAPMessage(getPOSTMessageCapabilities()[0].getValue(),null);

    }

    /**

     * It creates the SOAP message for the describeRecords request

     * 

     * @return

     * String with the SOAP message

     */

    public String getSOAPMessageDescribeRecords() {

        return SOAPProtocol.setSOAPMessage(getPOSTDescribeRecords()[0].getValue(),null);

    }

    /**

     * It creates the SOAP message for the getRecords request

     * 

     * @return

     * String with the SOAP message

     */

    public String getSOAPMessageRecords(Query query, int firstRecord) {

        return SOAPProtocol.setSOAPMessage(getPOSTMessageRecords(query,

                firstRecord)[0].getValue(),null);

    }

    /*

     * (non-Javadoc)

     *

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

     */

    public boolean setParameters(XMLNode[] nodes) {

        return new cswCapabilitiesParser(this).parse(nodes[0]);

    }

    /**

     * @param typeNames

     * The typeNames to set.

     */

    public void setTypeNames(String[] typeNames) {

        this.typeNames = typeNames;

        //Depending of this value, the CSW server is an ebRIM or an

        //ISO19115/19119 server. We must to set it.

        for (int i = 0; i < typeNames.length; i++)

            if (typeNames[i].equals("csw:Record") ||

                    typeNames[i].equals("Record")) {

                setServerProfile("ISO");

                break;

            } else {

                setServerProfile("ebRIM");

            }

    }

    /* (non-Javadoc)

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

     */

    public boolean isProtocolSupported(URL url) {

        return true;

    }

    /**

     * @return Returns the distributedSearch.

     */

    public String getDistributedSearch() {

        return distributedSearch;

    }

    /**

     * @param distributedSearch

     *            The distributedSearch to set.

     */

    public void setDistributedSearch(String distributedSearch) {

        this.distributedSearch = distributedSearch;

    }

    /**

     * @return Returns the hopCount.

     */

    public String getHopCount() {

        return hopCount;

    }

    /**

     * @param hopCount

     *            The hopCount to set.

     */

    public void setHopCount(String hopCount) {

        this.hopCount = hopCount;

    }

    /**

     * @return Returns the nAMESPACE.

     */

    public String[] getNAMESPACE() {

        return NAMESPACE;

    }

    /**

     * @param namespace

     *            The nAMESPACE to set.

     */

    public void setNAMESPACE(String[] namespace) {

        NAMESPACE = namespace;

    }

    /**

     * @return Returns the responseHandler.

     */

    public String getResponseHandler() {

        return responseHandler;

    }

    /**

     * @param responseHandler

     *            The responseHandler to set.

     */

    public void setResponseHandler(String responseHandler) {

        this.responseHandler = responseHandler;

    }

    /**

     * @return Returns the resultType.

     */

    public String[] getResultType() {

        return resultType;

    }

    /**

     * @param resultType

     *            The resultType to set.

     */

    public void setResultType(String[] resultType) {

        this.resultType = resultType;

    }

    /**

     * @return Returns the typeNames.

     */

    public String[] getTypeNames() {

        return typeNames;

    }

    /**

     * @return Returns the version.

     */

    public String getVersion() {

        return version;

    }

    /**

     * @param version

     *            The version to set.

     */

    public void setVersion(String version) {

        this.version = version;

    }

    /**

     * @return Returns the constraint.

     */

    public String getConstraint() {

        return constraint;

    }

    /**

     * @param constraint

     *            The constraint to set.

     */

    public void setConstraint(String constraint) {

        this.constraint = constraint;

    }

    /**

     * @return Returns the cONSTRAINTLANGUAGE.

     */

    public String[] getCONSTRAINTLANGUAGE() {

        return CONSTRAINTLANGUAGE;

    }

    /**

     * @param constraintlanguage

     *            The cONSTRAINTLANGUAGE to set.

     */

    public void setCONSTRAINTLANGUAGE(String[] constraintlanguage) {

        CONSTRAINTLANGUAGE = constraintlanguage;

    }

    /**

     * @return Returns the elementSetName.

     */

    public String[] getElementSetName() {

        return elementSetName;

    }

    /**

     * @param elementSetName

     *            The elementSetName to set.

     */

    public void setElementSetName(String[] elementSetName) {

        this.elementSetName = elementSetName;

    }

    /**

     * @return Returns the serverProfile.

     */

    public String getServerProfile() {

        return ServerProfile;

    }

    /**

     * @param serverProfile The serverProfile to set.

     */

    public void setServerProfile(String serverProfile) {

        ServerProfile = serverProfile;

    }

        /**

         * @return Returns the operations.

         */

        public ProtocolsOperations getOperations() {

                return operations;

        }

        /**

         * @param operations The operations to set.

         */

        public void setOperations(ProtocolsOperations operations) {

                this.operations = operations;

        }

}