001 //$HeadURL: https://svn.wald.intevation.org/svn/deegree/base/branches/2.4_testing/src/org/deegree/io/datastore/schema/MappedFeatureTypeReference.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.schema;
037
038 import org.deegree.datatypes.QualifiedName;
039
040 /**
041 * Represents a reference to a {@link MappedFeatureType}.
042 * <p>
043 * The reference may be resolved or not. If it is resolved, the referenced
044 * {@link MappedFeatureType} is accessible, otherwise only the name of the type is available.
045 *
046 * @author <a href="mailto:schneider@lat-lon.de">Markus Schneider </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 MappedFeatureTypeReference {
052
053 private QualifiedName featureTypeName;
054
055 private MappedFeatureType featureType;
056
057 private boolean isResolved;
058
059 /**
060 * Creates an unresolved <code>MappedFeatureTypeReference</code>.
061 *
062 * @param featureTypeName
063 */
064 public MappedFeatureTypeReference( QualifiedName featureTypeName ) {
065 this.featureTypeName = featureTypeName;
066 }
067
068 /**
069 * Returns the name of the referenced {@link MappedFeatureType}.
070 *
071 * @return the name of the referenced feature type
072 */
073 public QualifiedName getName() {
074 return this.featureTypeName;
075 }
076
077 /**
078 * Returns true, if the reference has been resolved.
079 * <p>
080 * If this method returns true, {@link #getFeatureType()} will return the correct
081 * {@link MappedFeatureType} instance.
082 *
083 * @return true, if the reference has been resolved, false otherwise
084 */
085 public boolean isResolved() {
086 return this.isResolved;
087 }
088
089 /**
090 * Returns the referenced {@link MappedFeatureType}.
091 * <p>
092 * This method will only return the correct {@link MappedFeatureType} instance, if
093 * the reference has been resolved by a call to {@link #resolve(MappedFeatureType)}.
094 *
095 * @return the referenced feature type, or null if it has not been resolved
096 */
097 public MappedFeatureType getFeatureType() {
098 return this.featureType;
099 }
100
101 /**
102 * Sets the referenced {@link MappedFeatureType} instance.
103 *
104 * @param featureType
105 * @throws RuntimeException
106 * if the reference has been resolved already
107 */
108 public void resolve( MappedFeatureType featureType ) {
109 if ( isResolved() ) {
110 throw new RuntimeException( "MappedFeatureTypeReference to feature type '"
111 + featureTypeName + "' has already been resolved." );
112 }
113 this.featureType = featureType;
114 this.isResolved = true;
115 }
116 }