001    //$HeadURL: svn+ssh://mschneider@svn.wald.intevation.org/deegree/base/trunk/src/org/deegree/ogcwebservices/wfs/operation/transaction/Update.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.operation.transaction;
037    
038    import java.util.ArrayList;
039    import java.util.List;
040    
041    import org.deegree.datatypes.QualifiedName;
042    import org.deegree.model.feature.Feature;
043    import org.deegree.model.filterencoding.Filter;
044    
045    /**
046     * Represents a <code>Replace</code> operation as a part of a {@link Transaction} request.
047     * <p>
048     * This operation is designed after the Replace operation of the upcoming WFS 2.0.0 specification. One or more feature
049     * instances (specified by a filter expression) are replaced by a given feature instance. The replacement is assumed to
050     * be performed property by property, so the targeted features are identical to the specified feature afterwards, but
051     * keep their original feature ids.
052     * </p>
053     * 
054     * @author <a href="mailto:schneider@lat-lon.de">Markus Schneider </a>
055     * @author last edited by: $Author: mschneider $
056     * 
057     * @version $Revision: 18195 $, $Date: 2009-06-18 17:55:39 +0200 (Do, 18 Jun 2009) $
058     */
059    public class Replace extends TransactionOperation {
060    
061        private QualifiedName typeName;
062    
063        private Feature replacementFeature;
064    
065        private Filter filter;
066    
067        /**
068         * Creates a new <code>Replace</code> instance.
069         * 
070         * @param handle
071         *            optional identifier for the operation (for error messsages)
072         * @param typeName
073         *            the name of the targeted feature type
074         * @param replacementFeature
075         *            feature that specifies all properties
076         * @param filter
077         *            selects the feature instances to be replaced
078         */
079        public Replace( String handle, QualifiedName typeName, Feature replacementFeature, Filter filter ) {
080            super( handle );
081            this.typeName = typeName;
082            this.replacementFeature = replacementFeature;
083            this.filter = filter;
084        }
085    
086        /**
087         * Returns the name of the targeted feature type.
088         * 
089         * @return the name of the targeted feature type.
090         */
091        public QualifiedName getTypeName() {
092            return this.typeName;
093        }
094    
095        /**
096         * Returns the filter that selects the feature instances to be replaced.
097         * 
098         * @return the filter that selects the feature instances to be replaced
099         */
100        public Filter getFilter() {
101            return this.filter;
102        }
103    
104        /**
105         * Sets the filter that determines the features that are affected by the operation.
106         * 
107         * @param filter
108         *            determines the features that are affected by the operation
109         */
110        public void setFilter( Filter filter ) {
111            this.filter = filter;
112        }
113    
114        /**
115         * Returns the feature that will be used to replace the properties of the matched feature instances.
116         * 
117         * @return the feature that will be used to replace the properties of the matched feature instances
118         */
119        public Feature getFeature() {
120            return this.replacementFeature;
121        }
122    
123        @Override
124        public List<QualifiedName> getAffectedFeatureTypes() {
125            List<QualifiedName> featureTypes = new ArrayList<QualifiedName>( 1 );
126            featureTypes.add( this.typeName );
127            return featureTypes;
128        }
129    }