001    //$HeadURL: https://svn.wald.intevation.org/svn/deegree/base/branches/2.3_testing/src/org/deegree/ogcwebservices/wfs/capabilities/FormatType.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    package org.deegree.ogcwebservices.wfs.capabilities;
037    
038    import java.net.URI;
039    
040    /**
041     * Defines the format (for feature types) to be is served by the WFS.
042     * <p>
043     * This includes: <table>
044     * <tr>
045     * <td>inFilter</td>
046     * <td>optional: location of an XSL-script to be applied to requests</td>
047     * </tr>
048     * <tr>
049     * <td>outFilter</td>
050     * <td>optional: location of an XSL-script to be applied to responses</td>
051     * </tr>
052     * <tr>
053     * <td>schemaLocation</td>
054     * <td>optional: location of schema document (for
055     * {@link org.deegree.ogcwebservices.wfs.operation.DescribeFeatureType DescribeFeatureType} requests)</td>
056     * </tr>
057     * <tr>
058     * <td>value</td>
059     * <td>name of the format (e.g. <code>text/xml; subtype=gml/3.1.1</code>)</td>
060     * </tr>
061     * </table>
062     *
063     * @author <a href="mailto:schneider@lat-lon.de">Markus Schneider </a>
064     * @author last edited by: $Author: mschneider $
065     *
066     * @version $Revision: 18195 $ $Date: 2009-06-18 17:55:39 +0200 (Do, 18. Jun 2009) $
067     */
068    public class FormatType {
069    
070        private URI inFilter, outFilter, schemaLocation;
071    
072        private String value;
073    
074        /**
075         * Creates a new instance of <code>FormatType<code> from the given parameters.
076         *
077         * @param inFilter
078         *            location of an XSL-script to be applied to requests, may be null
079         * @param outFilter
080         *            location of an XSL-script to be applied to responses, may be null
081         * @param schemaLocation
082         *            location of schema document (for {@link org.deegree.ogcwebservices.wfs.operation.DescribeFeatureType DescribeFeatureType} requests, may be null
083         * @param value
084         *            name of the format (e.g. <code>text/xml; subtype=gml/3.1.1</code>)
085         */
086        public FormatType( URI inFilter, URI outFilter, URI schemaLocation, String value ) {
087            this.inFilter = inFilter;
088            this.outFilter = outFilter;
089            this.schemaLocation = schemaLocation;
090            this.value = value;
091        }
092    
093        /**
094         * Returns the location of the XSL-script to be applied to requests.
095         *
096         * @return the location of the XSL-script to be applied to requests, may be null
097         */
098        public URI getInFilter() {
099            return inFilter;
100        }
101    
102        /**
103         * Returns the location of the XSL-script to be applied to responses.
104         *
105         * @return the location of the XSL-script to be applied to responses, may be null
106         */
107        public URI getOutFilter() {
108            return outFilter;
109        }
110    
111        /**
112         * Returns the location of the schema document (for
113         * {@link org.deegree.ogcwebservices.wfs.operation.DescribeFeatureType DescribeFeatureType} requests).
114         *
115         * @return the location of the schema document (for
116         *         {@link org.deegree.ogcwebservices.wfs.operation.DescribeFeatureType DescribeFeatureType} requests), may
117         *         be null
118         */
119        public URI getSchemaLocation() {
120            return schemaLocation;
121        }
122    
123        /**
124         * Returns the name of the format.
125         *
126         * @return the name of the format
127         */
128        public String getValue() {
129            return value;
130        }
131    
132        /**
133         * Returns whether the format definition is virtual, i.e. it is processed using an (input) XSLT-script.
134         *
135         * @return true, if the format is virtual, false otherwise
136         */
137        public boolean isVirtual() {
138            return this.inFilter != null;
139        }
140    
141        @Override
142        public String toString() {
143            return "Format: " + value + ( inFilter == null ? "" : ( ", infilter: " + inFilter ) )
144                   + ( outFilter == null ? "" : ( ", outfilter: " + outFilter ) )
145                   + ( schemaLocation == null ? "" : ( ", schemaLocation: " + schemaLocation ) );
146        }
147    
148    }