| 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.csw.drivers;

import java.net.MalformedURLException;

import java.net.URI;

import java.net.URL;

import java.util.Collection;

import org.apache.commons.httpclient.NameValuePair;

import com.iver.utiles.swing.jcomboServer.ServerData;

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

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

import es.gva.cit.catalogClient.drivers.AbstractCatalogServiceDriver;

import es.gva.cit.catalogClient.drivers.CatalogCapabilities;

import es.gva.cit.catalogClient.drivers.GetRecordsReply;

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.schemas.Schemas;

import es.gva.cit.catalogClient.schemas.records.Record;

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

/**

 * This class implements the CSW protocol.

 * 

 * 

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

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

 */

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 version = "2.0.0";

        private CswSupportedProtocolOperations operations = null;

        /**

         * @return 

         * @param url 

         */

        public CatalogCapabilities getCapabilities(URI uri) {        

                URL url = null;

                try {

                        url = uri.toURL();

                } catch (MalformedURLException e) {

                        setServerAnswerReady("errorServerNotFound");

                        return null;

                }        

                Collection nodes = new java.util.ArrayList();

                CSWMessages messages = new CSWMessages(this);

                nodes = new HTTPGetProtocol().doQuery(url, messages.getHTTPGETCapabilities(true), 0);

                CSWCapabilitiesParserv2_0_0 parser = new CSWCapabilitiesParserv2_0_0(url,this);

                CatalogCapabilities capabilities = parser.parse((XMLNode)nodes.toArray()[0]);

                return capabilities;

        } 

        /**

         * @return 

         * @param url 

         * @param query 

         * @param firstRecord 

         */

        public GetRecordsReply getRecords(URI uri, Query query, int firstRecord) {        

                URL url = null;

                try {

                        url = uri.toURL();

                } catch (MalformedURLException e) {

                        setServerAnswerReady("errorServerNotFound");

                        return null;

                }        

                setQuery(query);

                CSWMessages messages = new CSWMessages(this);

                CSWMessages.setUrl(url);

                Collection answerNodes = new java.util.ArrayList();

                Collection nodes = new java.util.ArrayList();

                if (getOperations().getGetRecords()==null)

                        return null;

                if (getServerProfile().equals(Schemas.ISO19115)){

//                        if (getService().equals("CSW")){

//                                firstRecord = firstRecord - 1;

//                        }

                }

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

                        /*

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

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

                    nodes = new HTTPGetProtocol().doQuery(url,

                        messages.getHTTPGETRecords(getQuery() , firstRecord), firstRecord);

                    setCommunicationProtocol("GET");                    

                break;

            }

                         */

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

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

                                System.out.println(messages.getHTTPPOSTRecords(getQuery(), firstRecord));                    

                                nodes = new HTTPPostProtocol().doQuery(url,

                                                messages.getHTTPPOSTRecords(getQuery(), firstRecord), firstRecord);

                                break;

                        }

                        /*

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

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

                         nodes = new SOAPProtocol().doQuery(url,

                        messages.getSOAPRecords(getQuery(), firstRecord), firstRecord);

                         setCommunicationProtocol("SOAP");

                 //We must cut the SOAP Head

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

                         break;

                } */ 

                }

                if (nodes == null) 

                        return null;

                int numberOfRecords = getNumberOfRecords((XMLNode)nodes.toArray()[0]);

                if (numberOfRecords == -1) {

                        return null;

                }

                answerNodes = createAnswerTree(numberOfRecords, firstRecord, (XMLNode)nodes.toArray()[0],

                                url);

                //return answerNodes;

                return null;

        } 

        /**

         * It returns an array of nodes with:

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

         * Next positions -> One result for each position

         * 

         * 

         * @return 

         * @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

         */

        private Collection createAnswerTree(int numberOfRecords, int firstRecord, XMLNode node, URL url) {        

                Collection answerNodes = new java.util.ArrayList();

                XMLNode[] auxNodes = cutMetadata(node);

                if (getServerProfile().equals(Schemas.EBRIM)) {

                        if (!url.getHost().equals("laits.gmu.edu")){

                                auxNodes = getEbRIMNodes(auxNodes, url);

                        }

                }

                //Solves some problems with the maxNumberOfRecords attribute

                numberOfRecords = auxNodes.length;

                answerNodes.add(XMLTreeNumberOfRecordsAnswer.getNode(numberOfRecords,

                                firstRecord, firstRecord + numberOfRecords));

                for (int i = 1;

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

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

                        answerNodes.add(auxNodes[i - 1]);

                return answerNodes;

        } 

        /**

         * This function retrieve the nodes for one ebRIM answer

         * 

         * 

         * @return Medatada Nodes.

         * @param nodes Server URL

         * @param url 

         */

        private 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] = (XMLNode)new HTTPGetProtocol().doQuery(url,

                                        getEbRIMRequestParameters(id), 0).toArray()[0];

                }

                return auxNodes;

        } 

        /**

         * It Returns the parameters needed by getExtrinsicContent

         * 

         * 

         * @return 

         * @param id Record id

         */

        private 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.

         * 

         * 

         * @return The number of records

         * @param node The answer tree

         */

        private 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

         * 

         * 

         * @return An array of trees that contain metadata.

         * @param node full tree

         */

        private 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,

                        "csw:SearchResults->csw:SummaryRecord");

                }

                if (auxNodes.length == 0) {

                        auxNodes = XMLTree.searchMultipleNode(node,

                        "csw:SearchResults->csw:Record");

                }

                if (auxNodes.length == 0) {

                        auxNodes = XMLTree.searchMultipleNode(node,

                        "csw:SearchResults->DS_DataSet");

                }

                if (auxNodes.length == 0) {

                        auxNodes = XMLTree.searchMultipleNode(node,

                        "SearchResults->wrs:WRSExtrinsicObject");

                }

                if (auxNodes.length == 0) {

                        auxNodes = XMLTree.searchMultipleNode(node,

                        "SearchResults->WRSExtrinsicObject");

                }        

                if (auxNodes.length == 0) {

                        auxNodes = XMLTree.searchMultipleNode(node,

                        "csw:SearchResults->dc:metadata");

                }

                if (auxNodes.length == 0) {

                        auxNodes = XMLTree.searchMultipleNode(node,

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

                }

                if (auxNodes.length == 0) {

                        auxNodes = XMLTree.searchMultipleNode(node,

                        "csw:SearchResults->laitscsw:DataGranule");

                }          

                if (auxNodes.length == 0) {

                        auxNodes = XMLTree.searchMultipleNode(node,

                        "csw:SearchResults->rim:Service");

                }  

                return auxNodes;

        } 

        /**

         * @param typeNames The typeNames to set.

         */

        public void setTypeNames(String[] typeNames) {        

                this.typeNames = typeNames;

        } 

/*

 * (non-Javadoc)

 * @see es.gva.cit.catalogClient.drivers.ICatalogServiceDriver#isProtocolSupported(java.net.URI)

 */

        public boolean isProtocolSupported(URI uri) {        

                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 operations.

         */

        public CswSupportedProtocolOperations getOperations() {        

                return operations;

        } 

        /**

         * @param operations The operations to set.

         */

        public void setOperations(CswSupportedProtocolOperations operations) {        

                this.operations = operations;

        } 

        /**

         * 

         * @return

         */

        public String getQueryProfile() {        

                // TODO Auto-generated method stub

                return getServerProfile();

        }

        /*

         * (non-Javadoc)

         * @see es.gva.cit.catalogClient.drivers.ICatalogServiceDriver#getServiceName()

         */

        public String getServiceName() {

                return ServerData.SERVER_SUBTYPE_CATALOG_CSW;

        }

        /*

         * (non-Javadoc)

         * @see es.gva.cit.catalogClient.drivers.ICatalogServiceDriver#getDefaultPort()

         */

        public int getDefaultPort() {

                return 80;

        }

        /*

         * (non-Javadoc)

         * @see es.gva.cit.catalogClient.drivers.ICatalogServiceDriver#getDefaultSchema()

         */

        public String getDefaultSchema() {

                return "http";

        } 

}