    001    //$HeadURL: https://svn.wald.intevation.org/svn/deegree/base/branches/2.4_testing/src/org/deegree/model/filterencoding/FeatureId.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.model.filterencoding;
    037
    038    import org.deegree.ogcbase.CommonNamespaces;
    039    import org.w3c.dom.Element;
    040
    041    /**
    042     * Encapsulates the information of a <FeatureId>element as defined in the FeatureId DTD. The
    043     * <FeatureId>element is used to encode the unique identifier for any feature instance. Within a
    044     * filter expression, the <FeatureId>is used as a reference to a particular feature instance.
    045     *
    046     * @author <a href="mailto:poth@lat-lon.de">Andreas Poth</a>
    047     * @author last edited by: $Author: mschneider $
    048     *
    049     * @version $Revision: 18195 $, $Date: 2009-06-18 17:55:39 +0200 (Do, 18. Jun 2009) $
    050     */
    051    public class FeatureId {
    052
    053        /**
    054         * The FeatureId's value.
    055         */
    056        private String value;
    057
    058        /**
    059         * Constructs a new FeatureId.
    060         *
    061         * @param value
    062         */
    063        public FeatureId( String value ) {
    064            this.value = value;
    065        }
    066
    067        /**
    068         * Given a DOM-fragment, a corresponding Expression-object is built. This method recursively
    069         * calls other buildFromDOM () - methods to validate the structure of the DOM-fragment.
    070         *
    071         * @param element
    072         *
    073         * @return feature id
    074         * @throws FilterConstructionException
    075         *             if the structure of the DOM-fragment is invalid
    076         */
    077        public static FeatureId buildFromDOM( Element element )
    078                                throws FilterConstructionException {
    079
    080            // check if root element's name equals 'FeatureId'
    081            if ( !element.getLocalName().toLowerCase().equals( "featureid" ) )
    082                throw new FilterConstructionException( "Name of element does not equal 'FeatureId'!" );
    083
    084            // determine the value of the FeatureId
    085            String fid = element.getAttribute( "fid" );
    086            if ( fid == null || "".equals( fid ) )
    087                throw new FilterConstructionException( "<FeatureId> requires 'fid'-attribute!" );
    088
    089            return new FeatureId( fid );
    090        }
    091
    092        /**
    093         * Given a DOM-fragment, a corresponding Expression-object is built. This method recursively
    094         * calls other buildFromDOM () - methods to validate the structure of the DOM-fragment.
    095         *
    096         * @param element
    097         *
    098         * @return feature id
    099         * @throws FilterConstructionException
    100         *             if the structure of the DOM-fragment is invalid
    101         */
    102        public static FeatureId buildGMLIdFromDOM( Element element )
    103                                throws FilterConstructionException {
    104
    105            // check if root element's name equals 'GmlObjectId'
    106            if ( !element.getLocalName().equals( "GmlObjectId" ) )
    107                throw new FilterConstructionException( "Name of element does not equal 'GmlObjectId'!" );
    108
    109            // determine the requested id
    110            String gmlId = element.getAttributeNS( CommonNamespaces.GMLNS.toString(), "id" );
    111            if ( gmlId == null || "".equals( gmlId ) )
    112                throw new FilterConstructionException( "<GmlObjectId> requires 'gml:id'-attribute!" );
    113
    114            return new FeatureId( gmlId );
    115        }
    116
    117        /**
    118         * Returns the feature id. A feature id is built from it's feature type name and it's id
    119         * separated by a ".". e.g. Road.A565
    120         *
    121         * @return feature id value
    122         */
    123        public String getValue() {
    124            return value;
    125        }
    126
    127        /**
    128         * @see org.deegree.model.filterencoding.FeatureId#getValue()
    129         * @param value
    130         */
    131        public void setValue( String value ) {
    132            this.value = value;
    133        }
    134
    135        /**
    136         * Produces a XML representation of this object.
    137         *
    138         * @return xml representation
    139         */
    140        public StringBuffer toXML() {
    141            StringBuffer sb = new StringBuffer();
    142            sb.append( "<ogc:FeatureId fid=\"" ).append( value ).append( "\"/>" );
    143            return sb;
    144        }
    145    }