001    //$HeadURL: svn+ssh://jwilden@svn.wald.intevation.org/deegree/base/branches/2.5_testing/src/org/deegree/ogcwebservices/csw/discovery/GetDomain.java $
002    /*----------------------------------------------------------------------------
003     This file is part of deegree, http://deegree.org/
004     Copyright (C) 2001-2009 by:
005       Department of Geography, University of Bonn
006     and
007       lat/lon GmbH
008    
009     This library is free software; you can redistribute it and/or modify it under
010     the terms of the GNU Lesser General Public License as published by the Free
011     Software Foundation; either version 2.1 of the License, or (at your option)
012     any later version.
013     This library is distributed in the hope that it will be useful, but WITHOUT
014     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
015     FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
016     details.
017     You should have received a copy of the GNU Lesser General Public License
018     along with this library; if not, write to the Free Software Foundation, Inc.,
019     59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
020    
021     Contact information:
022    
023     lat/lon GmbH
024     Aennchenstr. 19, 53177 Bonn
025     Germany
026     http://lat-lon.de/
027    
028     Department of Geography, University of Bonn
029     Prof. Dr. Klaus Greve
030     Postfach 1147, 53001 Bonn
031     Germany
032     http://www.geographie.uni-bonn.de/deegree/
033    
034     e-mail: info@deegree.org
035    ----------------------------------------------------------------------------*/
036    
037    package org.deegree.ogcwebservices.csw.discovery;
038    
039    import java.util.HashMap;
040    import java.util.Map;
041    
042    import org.deegree.ogcwebservices.csw.AbstractCSWRequest;
043    
044    /**
045     * The optional GetDomain operation is used to obtain runtime information about the range of values
046     * of a metadata record element or request parameter. The runtime range of values for a property or
047     * request parameter is typically much smaller than the value space for that property or parameter
048     * based on its static type definition. For example, a property or request parameter defined as a
049     * 16bit positive integer in a database may have a value space of 65535 distinct integers but the
050     * actual number of distinct values existing in the database may be much smaller.
051     * <p>
052     * This type of runtime information about the range of values of a property or request parameter is
053     * useful for generating user interfaces with meaningful pick lists or for generating query
054     * predicates that have a higher chance of actually identifying a result set.
055     * <p>
056     * It should be noted that the GetDomain operation is a "best-effort" operation. That is to say that
057     * a catalogue tries to generate useful information about the specified request parameter or
058     * property if it can. It is entirely possible that a catalogue may not be able to determine
059     * anything about the values of a property or request parameter in which case an empty response
060     * should be generated.
061     *
062     * @author <a href="mailto:poth@lat-lon.de">Andreas Poth </a>
063     * @author <a href="mailto:tfr@users.sourceforge.net">Torsten Friebe </a>
064     * @author <a href="mailto:mschneider@lat-lon.de">Markus Schneider </a>
065     *
066     * @author last edited by: $Author: mschneider $
067     *
068     * @version 2.0, $Revision: 18195 $, $Date: 2009-06-18 17:55:39 +0200 (Do, 18 Jun 2009) $
069     */
070    public class GetDomain extends AbstractCSWRequest {
071    
072        private static final long serialVersionUID = 1824407245510334461L;
073    
074        /**
075         *
076         * @param map
077         * @return the new instance
078         */
079        public static GetDomain create( Map<String, String> map ) {
080            return new GetDomain( map.get( "ID" ), map.get( "VERSION" ), null );
081        }
082    
083        /**
084         * @param version
085         * @param id
086         * @param vendorSpecificParameter
087         */
088        GetDomain( String id, String version, HashMap<String, String> vendorSpecificParameter ) {
089            super( version, id, vendorSpecificParameter );
090        }
091    
092        /**
093         * Unordered list of names of requested properties, from the information model that the
094         * catalogue is using
095         * <p>
096         * Zero or one; (Conditional)Include when ParameterName not included
097         *
098         * @return null
099         */
100        public String[] getPropertyNames() {
101            return null;
102        }
103    
104        /**
105         * Unordered list of names of requested parameters, of the form OperationName. ParameterName
106         * <p>
107         * Zero or one; (Conditional)Include when PropertyName not included
108         *
109         * @return null
110         */
111        public String[] ParameterNames() {
112            return null;
113        }
114    
115    }