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