/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can obtain
* a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
* or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
* Sun designates this particular file as subject to the "Classpath" exception
* as provided by Sun in the GPL Version 2 section of the License file that
* accompanied this code. If applicable, add the following below the License
* Header, with the fields enclosed by brackets [] replaced by your own
* identifying information: "Portions Copyrighted [year]
* [name of copyright owner]"
*
* Contributor(s):
*
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package com.sun.tools.xjc.reader.dtd.bindinfo;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import javax.xml.namespace.QName;
import com.sun.tools.xjc.model.CClassInfo;
import com.sun.xml.bind.api.impl.NameConverter;
import org.w3c.dom.Element;
import org.xml.sax.Locator;
/**
* <element> declaration in the binding file.
*/
public final class BIElement
{
/**
* Wraps a given <element> element in the binding file.
*
* <p>
* Should be created only from {@link BindInfo}.
*/
BIElement( BindInfo bi, Element _e ) {
this.parent = bi;
this.e = _e;
{
Element c = DOMUtil.getElement(e,"content");
if(c!=null) {
if(DOMUtil.getAttribute(c,"property")!=null) {
// if @property is there, this is a general declaration
this.rest = BIContent.create(c,this);
} else {
// this must be a model-based declaration
for( Element p : DOMUtil.getChildElements(c) ) {
if(p.getLocalName().equals("rest"))
this.rest = BIContent.create(p,this);
else
this.contents.add(BIContent.create(p,this));
}
}
}
}
// parse <attribute>s
for( Element atr : DOMUtil.getChildElements(e,"attribute") ) {
BIAttribute a = new BIAttribute( this, atr );
attributes.put(a.name(),a);
}
if(isClass()) {
// if this is a class-declaration, create JClass object now
String className = DOMUtil.getAttribute(e,"class");
if(className==null)
// none was specified. infer the name.
className = NameConverter.standard.toClassName(name());
this.className = className;
} else {
// this is not an element-class declaration
className = null;
}
// process conversion declarations
for( Element conv : DOMUtil.getChildElements(e,"conversion") ) {
BIConversion c = new BIUserConversion(bi,conv);
conversions.put(c.name(),c);
}
for( Element en : DOMUtil.getChildElements(e,"enumeration") ) {
BIConversion c = BIEnumeration.create(en,this);
conversions.put(c.name(),c);
}
// parse <constructor>s
for( Element c : DOMUtil.getChildElements(e,"constructor") ) {
constructors.add( new BIConstructor(c) );
}
String name = name();
QName tagName = new QName("",name);
this.clazz = new CClassInfo(parent.model,parent.getTargetPackage(),className,getLocation(),null,tagName,null,null/*TODO*/);
}
/**
* Gets the source location where this element is declared.
*/
public Locator getLocation() {
return DOMLocator.getLocationInfo(e);
}
/** The parent {@link BindInfo} object to which this object belongs. */
final BindInfo parent;
/** <element> element which this object is wrapping. */
private final Element e;
/**
* The bean representation for this element.
*/
public final CClassInfo clazz;
/**
* Content-property declarations.
* <p>
* This vector will be empty if no content-property declaration is made.
*/
private final List<BIContent> contents = new ArrayList<BIContent>();
/** Conversion declarations. */
private final Map<String,BIConversion> conversions = new HashMap<String,BIConversion>();
/**
* The "rest" content-property declaration.
* <p>
* This field is null when there was no "rest" declaration.
*/
private BIContent rest;
/** Attribute-property declarations. */
private final Map<String,BIAttribute> attributes = new HashMap<String,BIAttribute>();
/** Constructor declarations. */
private final List<BIConstructor> constructors = new ArrayList<BIConstructor>();
/**
* the class which is generated by this declaration.
* This field will be null if this declaration is an element-property
* declaration.
*/
private final String className;
/** Gets the element name. */
public String name() { return DOMUtil.getAttribute(e,"name"); }
/**
* Checks if the element type is "class".
* If false, that means this element will be a value.
*/
public boolean isClass() {
return "class".equals(e.getAttribute("type"));
}
/**
* Checks if this element is designated as a root element.
*/
public boolean isRoot() {
return "true".equals(e.getAttribute("root"));
}
/**
* Gets the JClass object that represents this declaration.
*
* <p>
* This method returns null if this declaration
* is an element-property declaration.
*/
public String getClassName() {
return className;
}
/**
* Creates constructor declarations for this element.
*
* <p>
* This method should only be called by DTDReader <b>after</b>
* the normalization has completed.
*
* @param src
* The ClassItem object that corresponds to this declaration
*/
public void declareConstructors( CClassInfo src ) {
for( BIConstructor c : constructors )
c.createDeclaration(src);
}
/**
* Gets the conversion method for this element.
*
* <p>
* This method can be called only when this element
* declaration is designated as element-value.
*
* @return
* If the convert attribute is not specified, this
* method returns null.
*/
public BIConversion getConversion() {
String cnv = DOMUtil.getAttribute(e,"convert");
if(cnv==null) return null;
return conversion(cnv);
}
/**
* Resolves the conversion name to the conversion declaration.
*
* <p>
* Element-local declarations are checked first.
*
* @return
* A non-null valid BIConversion object.
*/
public BIConversion conversion( String name ) {
BIConversion r = conversions.get(name);
if(r!=null) return r;
// check the global conversion declarations
return parent.conversion(name);
}
/**
* Iterates all content-property declarations (except 'rest').
*/
public List<BIContent> getContents() {
return contents;
}
/**
* Gets the attribute-property declaration, if any.
*
* @return
* null if attribute declaration was not given by that name.
*/
public BIAttribute attribute( String name ) {
return attributes.get(name);
}
/**
* Gets the 'rest' content-property declaration, if any.
* @return
* if there is no 'rest' declaration, return null.
*/
public BIContent getRest() { return this.rest; }
/** Gets the location where this declaration is declared. */
public Locator getSourceLocation() {
return DOMLocator.getLocationInfo(e);
}
}