001 //$HeadURL: svn+ssh://jwilden@svn.wald.intevation.org/deegree/base/branches/2.5_testing/src/org/deegree/framework/xml/schema/ElementReference.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.framework.xml.schema;
037
038 import org.deegree.datatypes.QualifiedName;
039
040 /**
041 * Represents an element reference. The reference may be resolved or not. If it is resolved, the
042 * referenced <code>ElementDeclaration</code> is accessible, otherwise only the name of the
043 * element is available.
044 *
045 * @author <a href="mailto:schneider@lat-lon.de">Markus Schneider </a>
046 *
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 * @since 2.0
052 */
053 public class ElementReference {
054
055 private QualifiedName elementName;
056
057 private ElementDeclaration declaration;
058
059 private boolean isResolved;
060
061 /**
062 * Creates an unresolved <code>ElementReference</code>.
063 *
064 * @param elementName
065 */
066 public ElementReference( QualifiedName elementName ) {
067 this.elementName = elementName;
068 }
069
070 /**
071 * @return the full name of the element
072 */
073 public QualifiedName getName() {
074 return this.elementName;
075 }
076
077 /**
078 * @return true if the element is resolved
079 */
080 public boolean isResolved() {
081 return this.isResolved;
082 }
083
084 /**
085 * @return the declaration of the Element
086 */
087 public ElementDeclaration getElementDeclaration() {
088 return this.declaration;
089 }
090
091 /**
092 * Flag this elementreference as resolved, with the given declaration set.
093 * @param declaration to set the element to.
094 * @throws RuntimeException if the element is resolved already.
095 */
096 public void resolve( ElementDeclaration declaration ) {
097 if ( isResolved() ) {
098 throw new RuntimeException( "ElementDeclaration to element '"
099 + elementName + "' has already been resolved." );
100 }
101 this.declaration = declaration;
102 this.isResolved = true;
103 }
104
105 /**
106 * set this element as resolved.
107 * @throws RuntimeException if the element is resolved already
108 */
109 public void resolve() {
110 if ( isResolved() ) {
111 throw new RuntimeException( "ElementDeclaration to element '"
112 + elementName + "' has already been resolved." );
113 }
114 this.isResolved = true;
115 }
116 }