com.sun.tools.xjc.generator.bean.PackageOutlineImpl Maven / Gradle / Ivy
/*
* The contents of this file are subject to the terms
* of the Common Development and Distribution License
* (the "License"). You may not use this file except
* in compliance with the License.
*
* You can obtain a copy of the license at
* https://jwsdp.dev.java.net/CDDLv1.0.html
* See the License for the specific language governing
* permissions and limitations under the License.
*
* When distributing Covered Code, include this CDDL
* HEADER in each file and include the License file at
* https://jwsdp.dev.java.net/CDDLv1.0.html If applicable,
* add the following below this CDDL HEADER, with the
* fields enclosed by brackets "[]" replaced with your
* own identifying information: Portions Copyright [yyyy]
* [name of copyright owner]
*/
package com.sun.tools.xjc.generator.bean;
import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Map;
import java.util.Set;
import javax.xml.bind.annotation.XmlNsForm;
import javax.xml.bind.annotation.XmlSchema;
import javax.xml.namespace.QName;
import com.sun.codemodel.JDefinedClass;
import com.sun.codemodel.JPackage;
import com.sun.tools.xjc.generator.annotation.spec.XmlSchemaWriter;
import com.sun.tools.xjc.model.CAttributePropertyInfo;
import com.sun.tools.xjc.model.CClassInfo;
import com.sun.tools.xjc.model.CElementPropertyInfo;
import com.sun.tools.xjc.model.CPropertyInfo;
import com.sun.tools.xjc.model.CPropertyVisitor;
import com.sun.tools.xjc.model.CReferencePropertyInfo;
import com.sun.tools.xjc.model.CValuePropertyInfo;
import com.sun.tools.xjc.model.Model;
import com.sun.tools.xjc.outline.PackageOutline;
/**
* {@link PackageOutline} enhanced with schema2java specific
* information.
*
* @author
* Kohsuke Kawaguchi ([email protected])
*/
final class PackageOutlineImpl implements PackageOutline {
private final Model _model;
private final JPackage _package;
private final ObjectFactoryGenerator objectFactoryGenerator;
/*package*/ final Set classes = new HashSet();
private final Set classesView = Collections.unmodifiableSet(classes);
private String mostUsedNamespaceURI;
private XmlNsForm elementFormDefault;
/**
* The namespace URI most commonly used in classes in this package.
* This should be used as the namespace URI for {@link XmlSchema#namespace()}.
*
*
* Null if no default
*
* @see #calcDefaultValues().
*/
public String getMostUsedNamespaceURI() {
return mostUsedNamespaceURI;
}
/**
* The element form default for this package.
*
* The value is computed by examining what would yield the smallest generated code.
*/
public XmlNsForm getElementFormDefault() {
assert elementFormDefault!=null;
return elementFormDefault;
}
public JPackage _package() {
return _package;
}
public ObjectFactoryGenerator objectFactoryGenerator() {
return objectFactoryGenerator;
}
public Set getClasses() {
return classesView;
}
public JDefinedClass objectFactory() {
return objectFactoryGenerator.getObjectFactory();
}
protected PackageOutlineImpl( BeanGenerator outline, Model model, JPackage _pkg ) {
this._model = model;
this._package = _pkg;
switch(model.strategy) {
case BEAN_ONLY:
objectFactoryGenerator = new PublicObjectFactoryGenerator(outline,model,_pkg);
break;
case INTF_AND_IMPL:
objectFactoryGenerator = new DualObjectFactoryGenerator(outline,model,_pkg);
break;
default:
throw new IllegalStateException();
}
}
/**
* Compute the most common namespace URI in this package
* (to put into {@link XmlSchema#namespace()} and what value
* we should put into {@link XmlSchema#elementFormDefault()}.
*
* This method is called after {@link #classes} field is filled up.
*/
public void calcDefaultValues() {
// short-circuit if xjc was told not to generate package level annotations in
// package-info.java
if(!_model.isPackageLevelAnnotations()) {
mostUsedNamespaceURI = "";
elementFormDefault = XmlNsForm.UNQUALIFIED;
return;
}
// used to visit properties
CPropertyVisitor propVisitor = new CPropertyVisitor() {
public Void onElement(CElementPropertyInfo p) {
countURI(propUriCountMap, p.getXmlName());
return null;
}
public Void onReference(CReferencePropertyInfo p) {
countURI(propUriCountMap, p.getXmlName());
return null;
}
public Void onAttribute(CAttributePropertyInfo p) {
return null;
}
public Void onValue(CValuePropertyInfo p) {
return null;
}
};
for (ClassOutlineImpl co : classes) {
CClassInfo ci = co.target;
countURI(uriCountMap, ci.getTypeName());
countURI(uriCountMap, ci.getElementName());
for( CPropertyInfo p : ci.getProperties() )
p.accept(propVisitor);
}
mostUsedNamespaceURI = getMostUsedURI(uriCountMap);
elementFormDefault = getFormDefault();
// generate package-info.java
// we won't get this far if the user specified -npa
if(!mostUsedNamespaceURI.equals("") || elementFormDefault==XmlNsForm.QUALIFIED) {
XmlSchemaWriter w = _package.annotate2(XmlSchemaWriter.class);
if(!mostUsedNamespaceURI.equals(""))
w.namespace(mostUsedNamespaceURI);
if(elementFormDefault==XmlNsForm.QUALIFIED)
w.elementFormDefault(elementFormDefault);
}
}
// Map to keep track of how often each type or element uri is used in this package
// mostly used to calculate mostUsedNamespaceURI
private HashMap uriCountMap = new HashMap();
// Map to keep track of how often each property uri is used in this package
// used to calculate elementFormDefault
private HashMap propUriCountMap = new HashMap();
/**
* pull the uri out of the specified QName and keep track of it in the
* specified hash map
*
* @param qname
*/
private void countURI(HashMap map, QName qname) {
if (qname == null) return;
String uri = qname.getNamespaceURI();
if (map.containsKey(uri)) {
map.put(uri, map.get(uri).intValue() + 1);
} else {
map.put(uri, 1);
}
}
/**
* Iterate through the hash map looking for the namespace used
* most frequently. Ties are arbitrarily broken by the order
* in which the map keys are iterated over.
*/
private String getMostUsedURI(HashMap map) {
String mostPopular = null;
int count = 0;
for (Map.Entry e : map.entrySet()) {
String uri = e.getKey();
int uriCount = e.getValue();
if (mostPopular == null) {
mostPopular = uri;
count = uriCount;
} else {
if (uriCount > count) {
mostPopular = uri;
count = uriCount;
}
}
}
if (mostPopular == null) return "";
return mostPopular;
}
/**
* Calculate the element form defaulting.
*
* Compare the most frequently used property URI to the most frequently used
* element/type URI. If they match, then return QUALIFIED
* @return
*/
private XmlNsForm getFormDefault() {
if (getMostUsedURI(propUriCountMap).equals("")) return XmlNsForm.UNQUALIFIED;
else return XmlNsForm.QUALIFIED;
}
}