001 //$HeadURL: svn+ssh://rbezema@svn.wald.intevation.org/deegree/base/branches/2.2_testing/src/org/deegree/ogcwebservices/wfs/operation/transaction/Delete.java $
002 /*---------------- FILE HEADER ------------------------------------------
003
004 This file is part of deegree.
005 Copyright (C) 2001-2008 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 Aennchenstraße 19
030 53177 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.wfs.operation.transaction;
044
045 import java.util.ArrayList;
046 import java.util.Iterator;
047 import java.util.List;
048 import java.util.Map;
049
050 import org.deegree.datatypes.QualifiedName;
051 import org.deegree.model.feature.Feature;
052 import org.deegree.model.filterencoding.Filter;
053 import org.deegree.ogcwebservices.InconsistentRequestException;
054
055 /**
056 * Represents a <code>Delete</code> operation as a part of a {@link Transaction} request.
057 * <p>
058 * WFS Specification OGC 04-094 (#12.2.6 Pg.71):
059 * <p>
060 * The <code>Delete</code> element is used to indicate that one of more feature instances should
061 * be deleted. The scope of the delete operation is constrained by using the <code>Filter</code>
062 * element as described in the <b>Filter Encoding Specification[3]</b>.<br>
063 * In the event, that the {@link Filter} element does not identify any {@link Feature}
064 * instances to <code>Delete</code>, the <code>Delete</code> action will simply have no effect.
065 * <br>
066 * <b>This is not an exception condition</b>.
067 *
068 * @author <a href="mailto:deshmukh@lat-lon.de">Anup Deshmukh </a>
069 * @author <a href="mailto:schneider@lat-lon.de">Markus Schneider </a>
070 * @author last edited by: $Author: apoth $
071 *
072 * @version $Revision: 9345 $, $Date: 2007-12-27 17:22:25 +0100 (Do, 27 Dez 2007) $
073 */
074 public class Delete extends TransactionOperation {
075
076 private QualifiedName typeName;
077
078 private Filter filter;
079
080 /**
081 * Creates a new <code>Delete<code> instance.
082 *
083 * @param handle
084 * optional identifier for the operation (for error messsages)
085 * @param typeName
086 * name of the targeted feature type
087 * @param filter
088 * selects the feature instances to be deleted
089 */
090 public Delete( String handle, QualifiedName typeName, Filter filter ) {
091 super (handle);
092 this.typeName = typeName;
093 this.filter = filter;
094 }
095
096 /**
097 * Returns the name of the targeted feature type.
098 *
099 * @return the name of the targeted feature type.
100 */
101 public QualifiedName getTypeName() {
102 return this.typeName;
103 }
104
105 /**
106 * Return <code>Filter</code>.
107 *
108 * @return Filter filter
109 */
110 public Filter getFilter() {
111 return this.filter;
112 }
113
114 /**
115 * sets the filter condition for an delete operation. This method may be use
116 * by classes/moduls that need to manipulate an update operation e.g. to
117 * ensure security constraints.
118 * @param filter
119 */
120 public void setFilter(Filter filter) {
121 this.filter = filter;
122 }
123
124 /**
125 * Returns the names of the feature types that are affected by the operation.
126 * <p>
127 * For the <code>Delete</code> operation, this is a list with a single entry - the
128 * value of the "typeName" attribute.
129 *
130 * @return the names of the affected feature types.
131 */
132 @Override
133 public List<QualifiedName> getAffectedFeatureTypes () {
134 List<QualifiedName> featureTypes = new ArrayList<QualifiedName> (1);
135 featureTypes.add(this.typeName);
136 return featureTypes;
137 }
138
139 /**
140 * Creates <code>Delete</code> instances from a KVP request.
141 *
142 * @param typeFilter
143 * @return Delete instances
144 * @throws InconsistentRequestException
145 */
146 protected static List<Delete> create( Map typeFilter ) {
147
148 List<Delete> deletes = new ArrayList<Delete>();
149 if ( typeFilter != null ) {
150 Iterator iter = typeFilter.keySet().iterator();
151 while (iter.hasNext()) {
152 QualifiedName typeName = (QualifiedName) iter.next();
153 Filter filter = (Filter) typeFilter.get( typeName );
154 deletes.add(new Delete( null, typeName, filter ));
155 }
156 }
157 return deletes;
158 }
159 }