aoqi@0: /*
aoqi@0:  * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved.
aoqi@0:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0:  *
aoqi@0:  * This code is free software; you can redistribute it and/or modify it
aoqi@0:  * under the terms of the GNU General Public License version 2 only, as
aoqi@0:  * published by the Free Software Foundation.  Oracle designates this
aoqi@0:  * particular file as subject to the "Classpath" exception as provided
aoqi@0:  * by Oracle in the LICENSE file that accompanied this code.
aoqi@0:  *
aoqi@0:  * This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
aoqi@0:  * version 2 for more details (a copy is included in the LICENSE file that
aoqi@0:  * accompanied this code).
aoqi@0:  *
aoqi@0:  * You should have received a copy of the GNU General Public License version
aoqi@0:  * 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0:  *
aoqi@0:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0:  * or visit www.oracle.com if you need additional information or have any
aoqi@0:  * questions.
aoqi@0:  */
aoqi@0: 
aoqi@0: package com.sun.tools.internal.ws.wsdl.framework;
aoqi@0: 
aoqi@0: import org.xml.sax.Locator;
aoqi@0: 
aoqi@0: import java.util.HashMap;
aoqi@0: import java.util.Map;
aoqi@0: 
aoqi@0: import com.sun.tools.internal.ws.wscompile.ErrorReceiver;
aoqi@0: 
aoqi@0: /**
aoqi@0:  * An entity, typically corresponding to an XML element.
aoqi@0:  *
aoqi@0:  * @author WS Development Team
aoqi@0:  */
aoqi@0: public abstract class Entity implements Elemental {
aoqi@0: 
aoqi@0:     private final Locator locator;
aoqi@0:     protected ErrorReceiver errorReceiver;
aoqi@0:     public Entity(Locator locator) {
aoqi@0:         this.locator = locator;
aoqi@0:     }
aoqi@0: 
aoqi@0:     public void setErrorReceiver(ErrorReceiver errorReceiver) {
aoqi@0:         this.errorReceiver = errorReceiver;
aoqi@0:     }
aoqi@0: 
aoqi@0:     public Locator getLocator() {
aoqi@0:         return locator;
aoqi@0:     }
aoqi@0: 
aoqi@0:     public Object getProperty(String key) {
aoqi@0:         if (_properties == null)
aoqi@0:             return null;
aoqi@0:         return _properties.get(key);
aoqi@0:     }
aoqi@0: 
aoqi@0:     public void setProperty(String key, Object value) {
aoqi@0:         if (value == null) {
aoqi@0:             removeProperty(key);
aoqi@0:             return;
aoqi@0:         }
aoqi@0: 
aoqi@0:         if (_properties == null) {
aoqi@0:             _properties = new HashMap();
aoqi@0:         }
aoqi@0:         _properties.put(key, value);
aoqi@0:     }
aoqi@0: 
aoqi@0:     public void removeProperty(String key) {
aoqi@0:         if (_properties != null) {
aoqi@0:             _properties.remove(key);
aoqi@0:         }
aoqi@0:     }
aoqi@0: 
aoqi@0:     public void withAllSubEntitiesDo(EntityAction action) {
aoqi@0:         // no-op by default
aoqi@0:     }
aoqi@0: 
aoqi@0:     public void withAllQNamesDo(QNameAction action) {
aoqi@0:         action.perform(getElementName());
aoqi@0:     }
aoqi@0: 
aoqi@0:     public void withAllEntityReferencesDo(EntityReferenceAction action) {
aoqi@0:         // no-op by default
aoqi@0:     }
aoqi@0: 
aoqi@0:     public abstract void validateThis();
aoqi@0: 
aoqi@0:     protected void failValidation(String key) {
aoqi@0:         throw new ValidationException(key, getElementName().getLocalPart());
aoqi@0:     }
aoqi@0: 
aoqi@0:     protected void failValidation(String key, String arg) {
aoqi@0:         throw new ValidationException(
aoqi@0:             key,
aoqi@0:             new Object[] { arg, getElementName().getLocalPart()});
aoqi@0:     }
aoqi@0: 
aoqi@0:     private Map _properties;
aoqi@0: }