001    //$HeadURL: svn+ssh://jwilden@svn.wald.intevation.org/deegree/base/branches/2.5_testing/src/org/deegree/io/datastore/idgenerator/ParentIDGenerator.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.io.datastore.idgenerator;
037    
038    import java.util.Properties;
039    
040    import org.deegree.io.datastore.DatastoreTransaction;
041    import org.deegree.io.datastore.FeatureId;
042    import org.deegree.io.datastore.schema.MappedFeatureType;
043    
044    /**
045     * {@link IdGenerator} that takes the {@link FeatureId} of the parent feature.
046     *
047     * @author <a href="mailto:schneider@lat-lon.de">Markus Schneider </a>
048     * @author last edited by: $Author: mschneider $
049     *
050     * @version $Revision: 18195 $, $Date: 2009-06-18 17:55:39 +0200 (Do, 18 Jun 2009) $
051     */
052    public class ParentIDGenerator extends IdGenerator {
053    
054        /**
055         * Creates a new <code>ParentIDGenerator</code> instance.
056         *
057         * @param params
058         *            configuration parameters
059         */
060        public ParentIDGenerator (Properties params) {
061            super (params);
062        }
063    
064        /**
065         * Returns a new primary key.
066         *
067         * @param ta
068         *            datastore transaction (context)
069         * @return a new primary key.
070         * @throws IdGenerationException
071         *             if the generation of the id could not be performed
072         */
073        @Override
074        public String getNewId( DatastoreTransaction ta ) throws IdGenerationException {
075            throw new UnsupportedOperationException(
076                "ParentIDGenerator cannot be used to generate primary keys (that are no feature ids)." );
077        }
078    
079        /**
080         * Returns a new id for a feature of the given type.
081         *
082         * @param ft
083         *            (mapped) feature type (irrelevant for this generator)
084         * @param ta
085         *            datastore transaction (context)
086         * @return a new feature id.
087         * @throws IdGenerationException
088         */
089        @Override
090        public FeatureId getNewId(  MappedFeatureType ft, DatastoreTransaction ta ) throws IdGenerationException {
091            throw new UnsupportedOperationException(
092                "ParentIDGenerator cannot be used to generate feature ids (without information on the parent feature." );
093        }
094    }