001    //$HeadURL: svn+ssh://rbezema@svn.wald.intevation.org/deegree/base/tags/2.1/src/org/deegree/ogcwebservices/csw/discovery/GetRecordByIdDocument.java $
002    /*----------------    FILE HEADER  ------------------------------------------
003    
004     This file is part of deegree.
005     Copyright (C) 2001-2007 by:
006     EXSE, Department of Geography, University of Bonn
007     http://www.giub.uni-bonn.de/deegree/
008     lat/lon GmbH
009     http://www.lat-lon.de
010    
011     This library is free software; you can redistribute it and/or
012     modify it under the terms of the GNU Lesser General Public
013     License as published by the Free Software Foundation; either
014     version 2.1 of the License, or (at your option) any later version.
015    
016     This library is distributed in the hope that it will be useful,
017     but WITHOUT ANY WARRANTY; without even the implied warranty of
018     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
019     Lesser General Public License for more details.
020    
021     You should have received a copy of the GNU Lesser General Public
022     License along with this library; if not, write to the Free Software
023     Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
024    
025     Contact:
026    
027     Andreas Poth
028     lat/lon GmbH
029     Aennchenstr. 19
030     53115 Bonn
031     Germany
032     E-Mail: poth@lat-lon.de
033    
034     Prof. Dr. Klaus Greve
035     Department of Geography
036     University of Bonn
037     Meckenheimer Allee 166
038     53115 Bonn
039     Germany
040     E-Mail: greve@giub.uni-bonn.de
041    
042     ---------------------------------------------------------------------------*/
043    package org.deegree.ogcwebservices.csw.discovery;
044    
045    import java.io.IOException;
046    import java.net.URL;
047    import java.util.Map;
048    
049    import org.deegree.framework.util.StringTools;
050    import org.deegree.framework.xml.XMLTools;
051    import org.deegree.ogcbase.ExceptionCode;
052    import org.deegree.ogcwebservices.InvalidParameterValueException;
053    import org.deegree.ogcwebservices.OGCWebServiceException;
054    import org.deegree.ogcwebservices.csw.AbstractCSWRequestDocument;
055    import org.w3c.dom.Node;
056    import org.xml.sax.SAXException;
057    
058    /**
059     * 
060     * 
061     * @version $Revision: 7572 $
062     * @author <a href="mailto:poth@lat-lon.de">Andreas Poth</a>
063     * @author last edited by: $Author: rbezema $
064     * 
065     * @version 1.0. $Revision: 7572 $, $Date: 2007-06-14 13:56:52 +0200 (Do, 14 Jun 2007) $
066     * 
067     * @since 2.0
068     */
069    public class GetRecordByIdDocument extends AbstractCSWRequestDocument {
070    
071        private static final long serialVersionUID = 2796229558893029054L;
072      
073        private static final String XML_TEMPLATE = "GetRecordByIdTemplate.xml";
074    
075        /**
076         * 
077         * @param id
078         * @return
079         */
080        GetRecordById parseGetRecordById( String id ) throws OGCWebServiceException {
081    
082            String version = null;
083            Map<String,String> vendorSpecificParameters = null;
084            String[] ids = null;
085            String elementSetName = null;
086    
087            try {
088                // '<csw:GetRecords>'-element (required)
089                Node contextNode = XMLTools.getRequiredNode( this.getRootElement(),
090                    "self::csw:GetRecordById", nsContext );
091    
092                // 'service'-attribute (required, must be CSW)
093                String service = XMLTools.getRequiredNodeAsString( contextNode, "@service", nsContext );
094                if ( !service.equals( "CSW" ) ) {
095                    ExceptionCode code = ExceptionCode.INVALIDPARAMETERVALUE;
096                    throw new InvalidParameterValueException( "GetRecordById",
097                        "'service' must be 'CSW'", code );
098                }
099    
100                // 'version'-attribute (required)
101                version = XMLTools.getNodeAsString( contextNode, "@version", nsContext, GetRecords.DEFAULT_VERSION );
102    
103                // '<csw:ResponseHandler>'-elements (optional)
104                ids = XMLTools.getNodesAsStrings( contextNode, "csw:Id", nsContext );
105    
106                // '<csw:ElementSetName>'-element (optional)
107                Node elementSetNameElement = XMLTools.getNode( contextNode, "csw:ElementSetName",
108                    nsContext );
109    
110                if ( elementSetNameElement != null ) {
111                    // must contain one of the values 'brief', 'summary' or
112                    // 'full'
113                    elementSetName = XMLTools.getRequiredNodeAsString( elementSetNameElement, "text()",
114                        nsContext, new String[] { "brief", "summary", "full" } );
115    
116                } else {
117                    elementSetName = "summary";
118                }
119                // in the future the vendorSpecificParameters 
120                vendorSpecificParameters = parseDRMParams( this.getRootElement() );
121            } catch (Exception e) {
122                ExceptionCode code = ExceptionCode.INVALID_FORMAT;
123                throw new OGCWebServiceException( "CatalogGetCapabilities", StringTools
124                    .stackTraceToString( e ), code );
125            }
126    
127            return new GetRecordById( id, version, vendorSpecificParameters, ids, elementSetName );
128        }
129    
130        /*
131         * (non-Javadoc)
132         * 
133         * @see org.deegree.framework.xml.XMLFragment#createEmptyDocument()
134         */
135        void createEmptyDocument() throws IOException, SAXException {
136            URL url = GetRecordByIdDocument.class.getResource( XML_TEMPLATE );
137            if ( url == null ) {
138                throw new IOException( "The resource '"
139                    + XML_TEMPLATE + " could not be found." );
140            }
141            load( url );
142        }
143    
144    }