001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common Development
008: * and Distribution License("CDDL") (collectively, the "License"). You
009: * may not use this file except in compliance with the License. You can obtain
010: * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
011: * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
012: * language governing permissions and limitations under the License.
013: *
014: * When distributing the software, include this License Header Notice in each
015: * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
016: * Sun designates this particular file as subject to the "Classpath" exception
017: * as provided by Sun in the GPL Version 2 section of the License file that
018: * accompanied this code. If applicable, add the following below the License
019: * Header, with the fields enclosed by brackets [] replaced by your own
020: * identifying information: "Portions Copyrighted [year]
021: * [name of copyright owner]"
022: *
023: * Contributor(s):
024: *
025: * If you wish your version of this file to be governed by only the CDDL or
026: * only the GPL Version 2, indicate your decision by adding "[Contributor]
027: * elects to include this software in this distribution under the [CDDL or GPL
028: * Version 2] license." If you don't indicate a single choice of license, a
029: * recipient has the option to distribute your version of this file under
030: * either the CDDL, the GPL Version 2 or to extend the choice of license to
031: * its licensees as provided above. However, if you add GPL Version 2 code
032: * and therefore, elected the GPL Version 2 license, then the option applies
033: * only if the new code is made subject to such option by the copyright
034: * holder.
035: */
036:
037: package com.sun.tools.ws.wsdl.framework;
038:
039: import org.xml.sax.Locator;
040:
041: import java.util.HashMap;
042: import java.util.Map;
043:
044: import com.sun.tools.ws.wscompile.ErrorReceiver;
045:
046: /**
047: * An entity, typically corresponding to an XML element.
048: *
049: * @author WS Development Team
050: */
051: public abstract class Entity implements Elemental {
052:
053: private final Locator locator;
054: protected ErrorReceiver errorReceiver;
055:
056: public Entity(Locator locator) {
057: this .locator = locator;
058: }
059:
060: public void setErrorReceiver(ErrorReceiver errorReceiver) {
061: this .errorReceiver = errorReceiver;
062: }
063:
064: public Locator getLocator() {
065: return locator;
066: }
067:
068: public Object getProperty(String key) {
069: if (_properties == null)
070: return null;
071: return _properties.get(key);
072: }
073:
074: public void setProperty(String key, Object value) {
075: if (value == null) {
076: removeProperty(key);
077: return;
078: }
079:
080: if (_properties == null) {
081: _properties = new HashMap();
082: }
083: _properties.put(key, value);
084: }
085:
086: public void removeProperty(String key) {
087: if (_properties != null) {
088: _properties.remove(key);
089: }
090: }
091:
092: public void withAllSubEntitiesDo(EntityAction action) {
093: // no-op by default
094: }
095:
096: public void withAllQNamesDo(QNameAction action) {
097: action.perform(getElementName());
098: }
099:
100: public void withAllEntityReferencesDo(EntityReferenceAction action) {
101: // no-op by default
102: }
103:
104: public abstract void validateThis();
105:
106: protected void failValidation(String key) {
107: throw new ValidationException(key, getElementName()
108: .getLocalPart());
109: }
110:
111: protected void failValidation(String key, String arg) {
112: throw new ValidationException(key, new Object[] { arg,
113: getElementName().getLocalPart() });
114: }
115:
116: private Map _properties;
117: }
|