Examples with XMLNameTransformer org.eclipse.persistence.oxm.XMLNameTransformer used on opensource projects

Example 1 with XMLNameTransformer

use of org.eclipse.persistence.oxm.XMLNameTransformer in project eclipselink by eclipse-ee4j.

the class XMLProcessor method processXML.

/**
 * Process XmlBindings on a per package basis for a given
 * AnnotationsProcessor instance.
 */
public void processXML(AnnotationsProcessor annotationsProcessor, JavaModelInput jModelInput, TypeMappingInfo[] typeMappingInfos, JavaClass[] originalJavaClasses) {
    this.jModelInput = jModelInput;
    this.aProcessor = annotationsProcessor;
    this.aProcessor.setHasXmlBindings(true);
    Map<String, XmlEnum> xmlEnumMap = new HashMap<String, XmlEnum>();
    aProcessor.init(originalJavaClasses, typeMappingInfos);
    // build a map of packages to JavaClass so we only process the
    // JavaClasses for a given package additional classes - i.e. ones from
    // packages not listed in XML - will be processed later
    Map<String, ArrayList<JavaClass>> pkgToClassMap = buildPackageToJavaClassMap();
    // process each XmlBindings in the map
    XmlBindings xmlBindings;
    for (String packageName : xmlBindingMap.keySet()) {
        ArrayList<JavaClass> classesToProcess = pkgToClassMap.get(packageName);
        if (classesToProcess == null) {
            getLogger().logWarning("jaxb_metadata_warning_no_classes_to_process", new Object[] { packageName });
            continue;
        }
        xmlBindings = xmlBindingMap.get(packageName);
        // handle @XmlSchema override
        NamespaceInfo nsInfo = processXmlSchema(xmlBindings, packageName);
        if (nsInfo != null) {
            aProcessor.addPackageToNamespaceMapping(packageName, nsInfo);
        }
        // handle @XmlElementNillable override
        if (null != xmlBindings.getXmlElementNillable()) {
            aProcessor.addPackageToXmlElementNillable(packageName, xmlBindings.getXmlElementNillable());
        }
        // handle @XmlNullPolicy override
        if (null != xmlBindings.getXmlNullPolicy()) {
            aProcessor.addPackageToXmlNullPolicy(packageName, xmlBindings.getXmlNullPolicy());
        }
        // handle xml-registries
        // add an entry to the map of registries keyed on factory class name for each
        XmlRegistries xmlRegs = xmlBindings.getXmlRegistries();
        if (xmlRegs != null) {
            for (XmlRegistry xmlReg : xmlRegs.getXmlRegistry()) {
                aProcessor.addXmlRegistry(xmlReg.getName(), xmlReg);
            }
        }
        // build an array of JavaModel classes to process
        JavaClass[] javaClasses = classesToProcess.toArray(new JavaClass[classesToProcess.size()]);
        // handle xml-enums
        // build a map of enum class names to XmlEnum objects
        XmlEnums xmlEnums = xmlBindings.getXmlEnums();
        if (xmlEnums != null) {
            for (XmlEnum xmlEnum : xmlEnums.getXmlEnum()) {
                xmlEnumMap.put(getQualifiedJavaTypeName(xmlEnum.getJavaEnum(), packageName), xmlEnum);
            }
        }
        // handle superclass override
        if (xmlBindings.getJavaTypes() != null) {
            List<JavaType> types = xmlBindings.getJavaTypes().getJavaType();
            for (JavaType next : types) {
                JavaClass typeClass = jModelInput.getJavaModel().getClass(getQualifiedJavaTypeName(next.getName(), packageName));
                if (typeClass != null && typeClass.getClass() == JavaClassImpl.class) {
                    if (next.getSuperType() != null && !(next.getSuperType().equals(DEFAULT))) {
                        JavaClass newSuperClass = jModelInput.getJavaModel().getClass(next.getSuperType());
                        ((JavaClassImpl) typeClass).setSuperClassOverride(newSuperClass);
                    }
                }
            }
        }
        // pre-build the TypeInfo objects
        Map<String, TypeInfo> typeInfoMap = aProcessor.preBuildTypeInfo(javaClasses);
        // handle package-level xml-schema-types
        List<XmlSchemaType> xmlSchemaTypes = null;
        XmlSchemaTypes sTypes = xmlBindings.getXmlSchemaTypes();
        if (sTypes != null) {
            xmlSchemaTypes = sTypes.getXmlSchemaType();
        } else {
            xmlSchemaTypes = new ArrayList<XmlSchemaType>();
        }
        // handle package-level xml-schema-type
        if (xmlBindings.getXmlSchemaType() != null) {
            xmlSchemaTypes.add(xmlBindings.getXmlSchemaType());
        }
        // process each xml-schema-type entry
        for (XmlSchemaType sType : xmlSchemaTypes) {
            JavaClass jClass = aProcessor.getHelper().getJavaClass(sType.getType());
            if (jClass != null) {
                aProcessor.processSchemaType(sType.getName(), sType.getNamespace(), jClass.getQualifiedName());
            }
        }
        PackageInfo packageInfo = aProcessor.getPackageToPackageInfoMappings().get(packageName);
        if (packageInfo == null) {
            packageInfo = new PackageInfo();
        }
        if (xmlBindings.isSetXmlAccessorType()) {
            packageInfo.setAccessType(xmlBindings.getXmlAccessorType());
        }
        JavaTypes jTypes = xmlBindings.getJavaTypes();
        if (jTypes != null) {
            for (JavaType javaType : jTypes.getJavaType()) {
                TypeInfo info = typeInfoMap.get(getQualifiedJavaTypeName(javaType.getName(), packageName));
                // handle class-level @XmlJavaTypeAdapter override
                if (javaType.getXmlJavaTypeAdapter() != null) {
                    info.setXmlJavaTypeAdapter(javaType.getXmlJavaTypeAdapter());
                }
                // handle class-level @XmlNullPolicy override
                XmlNullPolicy xmlNullPolicy = javaType.getXmlNullPolicy();
                if (null != xmlNullPolicy) {
                    info.setXmlNullPolicy(xmlNullPolicy);
                }
                // handle class-level @XmlElementNillable override
                XmlElementNillable xmlElementNillable = javaType.getXmlElementNillable();
                if (null != xmlElementNillable) {
                    info.setXmlElementNillable(xmlElementNillable.isNillable());
                }
                // handle class-level @XmlNameTransformer
                String transformerClassName = javaType.getXmlNameTransformer();
                XMLNameTransformer transformer = getXMLNameTransformerClassFromString(transformerClassName);
                if (transformer != null) {
                    info.setXmlNameTransformer(transformer);
                }
                // handle class-level @XmlExtensible override
                if (javaType.getXmlVirtualAccessMethods() != null) {
                    info.setXmlVirtualAccessMethods(javaType.getXmlVirtualAccessMethods());
                }
                // handle class-level @XmlAccessorOrder override
                if (javaType.isSetXmlAccessorOrder()) {
                    info.setXmlAccessOrder(javaType.getXmlAccessorOrder());
                } else if (!info.isSetXmlAccessOrder()) {
                    // handle package-level @XmlAccessorOrder override
                    if (xmlBindings.isSetXmlAccessorOrder()) {
                        info.setXmlAccessOrder(xmlBindings.getXmlAccessorOrder());
                    } else {
                        // finally, check the NamespaceInfo
                        info.setXmlAccessOrder(packageInfo.getAccessOrder());
                    }
                }
                // handle class-level @XmlAccessorType override
                if (javaType.isSetXmlAccessorType()) {
                    info.setXmlAccessType(javaType.getXmlAccessorType());
                }
                // handle @XmlInlineBinaryData override
                if (javaType.isSetXmlInlineBinaryData()) {
                    info.setInlineBinaryData(javaType.isXmlInlineBinaryData());
                }
                // handle @XmlTransient override
                if (javaType.isSetXmlTransient()) {
                    info.setXmlTransient(javaType.isXmlTransient());
                }
                // handle @XmlRootElement
                if (javaType.getXmlRootElement() != null) {
                    info.setXmlRootElement(javaType.getXmlRootElement());
                }
                // handle @XmlSeeAlso override
                if (javaType.getXmlSeeAlso() != null && javaType.getXmlSeeAlso().size() > 0) {
                    info.setXmlSeeAlso(javaType.getXmlSeeAlso());
                }
                // handle @XmlType override
                if (javaType.getXmlType() != null) {
                    info.setXmlType(javaType.getXmlType());
                }
                // handle @XmlCustomizer override
                if (javaType.getXmlCustomizer() != null) {
                    info.setXmlCustomizer(javaType.getXmlCustomizer());
                }
                // handle @XmlClassExtractor override
                if (javaType.getXmlClassExtractor() != null) {
                    info.setClassExtractorName(javaType.getXmlClassExtractor().getClazz());
                }
                // handle @XmlProperties override
                if (javaType.getXmlProperties() != null && javaType.getXmlProperties().getXmlProperty().size() > 0) {
                    // may need to merge with @XmlProperties (xml wins in the case of a conflict)
                    if (info.getUserProperties() != null) {
                        info.setUserProperties(mergeUserPropertyMap(javaType.getXmlProperties().getXmlProperty(), info.getUserProperties()));
                    } else {
                        info.setUserProperties(createUserPropertyMap(javaType.getXmlProperties().getXmlProperty()));
                    }
                }
                // handle @XmlDiscriminatorNode override
                if (javaType.getXmlDiscriminatorNode() != null) {
                    info.setXmlDiscriminatorNode(javaType.getXmlDiscriminatorNode());
                }
                // handle @NamedObjectGraph/@NamedObjectGraphs override
                if (javaType.getXmlNamedObjectGraphs() != null) {
                    List<XmlNamedObjectGraph> currentGraphs = info.getObjectGraphs();
                    for (XmlNamedObjectGraph nextGraph : javaType.getXmlNamedObjectGraphs().getXmlNamedObjectGraph()) {
                        // if not, add the new one
                        for (XmlNamedObjectGraph nextExistingGraph : currentGraphs) {
                            if (nextGraph.getName().equals(nextExistingGraph.getName())) {
                                currentGraphs.remove(nextExistingGraph);
                                break;
                            }
                        }
                    }
                    currentGraphs.addAll(javaType.getXmlNamedObjectGraphs().getXmlNamedObjectGraph());
                }
                // handle @XmlDiscriminatorValue override
                if (javaType.getXmlDiscriminatorValue() != null) {
                    info.setXmlDiscriminatorValue(javaType.getXmlDiscriminatorValue());
                }
            }
        }
        // apply package-level @XmlNameTransformer
        Map<String, TypeInfo> typeInfos = aProcessor.getTypeInfosForPackage(packageName);
        String transformerClassName = xmlBindings.getXmlNameTransformer();
        XMLNameTransformer transformer = getXMLNameTransformerClassFromString(transformerClassName);
        if (transformer != null) {
            packageInfo.setXmlNameTransformer(transformer);
        }
        // apply package-level @XmlJavaTypeAdapters
        for (TypeInfo tInfo : typeInfos.values()) {
            if (xmlBindings.getXmlJavaTypeAdapters() != null) {
                List<XmlJavaTypeAdapter> adapters = xmlBindings.getXmlJavaTypeAdapters().getXmlJavaTypeAdapter();
                for (XmlJavaTypeAdapter xja : adapters) {
                    try {
                        JavaClass adapterClass = jModelInput.getJavaModel().getClass(xja.getValue());
                        JavaClass boundType = jModelInput.getJavaModel().getClass(xja.getType());
                        if (boundType != null) {
                            tInfo.addPackageLevelAdapterClass(adapterClass, boundType);
                            packageInfo.getPackageLevelAdaptersByClass().put(boundType.getQualifiedName(), adapterClass);
                        }
                    } catch (JAXBException e) {
                        throw JAXBException.invalidPackageAdapterClass(xja.getValue(), packageName);
                    }
                }
            }
        }
    }
    for (String packageName : xmlBindingMap.keySet()) {
        ArrayList<JavaClass> classesToProcess = pkgToClassMap.get(packageName);
        if (classesToProcess == null) {
            getLogger().logWarning("jaxb_metadata_warning_no_classes_to_process", new Object[] { packageName });
            continue;
        }
        xmlBindings = xmlBindingMap.get(packageName);
        JavaClass[] javaClasses = classesToProcess.toArray(new JavaClass[classesToProcess.size()]);
        // post-build the TypeInfo objects
        javaClasses = aProcessor.postBuildTypeInfo(javaClasses);
        // get the generated TypeInfo
        Map<String, TypeInfo> typeInfosForPackage = aProcessor.getTypeInfosForPackage(packageName);
        // update xml-enum info if necessary
        for (Entry<String, TypeInfo> entry : typeInfosForPackage.entrySet()) {
            TypeInfo tInfo = entry.getValue();
            if (tInfo.isEnumerationType()) {
                EnumTypeInfo etInfo = (EnumTypeInfo) tInfo;
                XmlEnum xmlEnum = xmlEnumMap.get(etInfo.getClassName());
                if (xmlEnum != null) {
                    JavaClass restrictionClass = aProcessor.getHelper().getJavaClass(xmlEnum.getValue());
                    // default to String if necessary
                    if (restrictionClass == null) {
                        restrictionClass = jModelInput.getJavaModel().getClass(String.class);
                    }
                    etInfo.setRestrictionBase(aProcessor.getSchemaTypeFor(restrictionClass));
                    for (XmlEnumValue xmlEnumValue : xmlEnum.getXmlEnumValue()) {
                        // overwrite any existing entries (from annotations)
                        etInfo.addJavaFieldToXmlEnumValuePair(true, xmlEnumValue.getJavaEnumValue(), xmlEnumValue.getValue());
                    }
                }
            }
        }
        // update TypeInfo objects based on the JavaTypes
        JavaTypes jTypes = xmlBindings.getJavaTypes();
        if (jTypes != null) {
            PackageInfo packageInfo = aProcessor.getPackageToPackageInfoMappings().get(packageName);
            NamespaceInfo nsInfo = null;
            if (null != packageInfo) {
                nsInfo = packageInfo.getNamespaceInfo();
            }
            for (JavaType javaType : jTypes.getJavaType()) {
                processJavaType(javaType, typeInfosForPackage.get(getQualifiedJavaTypeName(javaType.getName(), packageName)), nsInfo);
            }
        }
        // remove the entry for this package from the map
        pkgToClassMap.remove(packageName);
    }
    // now process remaining classes
    Iterator<ArrayList<JavaClass>> classIt = pkgToClassMap.values().iterator();
    while (classIt.hasNext()) {
        ArrayList<JavaClass> jClassList = classIt.next();
        JavaClass[] jClassArray = jClassList.toArray(new JavaClass[jClassList.size()]);
        aProcessor.buildNewTypeInfo(jClassArray);
        aProcessor.checkForCallbackMethods();
    }
    // need to ensure that any bound types (from XmlJavaTypeAdapter) have TypeInfo
    // objects built for them - SchemaGenerator will require a descriptor for each
    Map<String, TypeInfo> typeInfos = (Map<String, TypeInfo>) ((HashMap) aProcessor.getTypeInfos()).clone();
    for (Entry<String, TypeInfo> entry : typeInfos.entrySet()) {
        JavaClass[] jClassArray;
        for (Property prop : entry.getValue().getPropertyList()) {
            if (prop.isSetXmlJavaTypeAdapter()) {
                jClassArray = new JavaClass[] { prop.getActualType() };
                aProcessor.buildNewTypeInfo(jClassArray);
            }
        }
    }
    // now trigger the annotations processor to process the classes
    List<JavaClass> jClasses = aProcessor.getTypeInfoClasses();
    // (in case super and sub classes were in different packages)
    if (xmlBindingMap.size() > 1) {
        for (JavaClass c : jClasses) {
            TypeInfo ti = aProcessor.getTypeInfos().get(c.getQualifiedName());
            aProcessor.processPropertiesSuperClass(c, ti);
        }
    }
    aProcessor.processPropertyTypes(jClasses.toArray(new JavaClass[jClasses.size()]));
    aProcessor.finalizeProperties();
    aProcessor.createElementsForTypeMappingInfo();
    aProcessor.checkForCallbackMethods();
}

Example 2 with XMLNameTransformer

use of org.eclipse.persistence.oxm.XMLNameTransformer in project eclipselink by eclipse-ee4j.

the class AnnotationsProcessor method updateGlobalElements.

public void updateGlobalElements(JavaClass[] classesToProcess) {
    // Look for XmlRootElement declarations
    for (JavaClass javaClass : classesToProcess) {
        TypeInfo info = typeInfos.get(javaClass.getQualifiedName());
        if (info == null) {
            continue;
        }
        if (!info.isTransient() && info.isSetXmlRootElement()) {
            org.eclipse.persistence.jaxb.xmlmodel.XmlRootElement xmlRE = info.getXmlRootElement();
            NamespaceInfo namespaceInfo;
            namespaceInfo = getPackageInfoForPackage(javaClass).getNamespaceInfo();
            String elementName = xmlRE.getName();
            if (elementName.equals(XMLProcessor.DEFAULT) || elementName.equals(EMPTY_STRING)) {
                XMLNameTransformer transformer = info.getXmlNameTransformer();
                try {
                    elementName = transformer.transformRootElementName(javaClass.getName());
                } catch (Exception ex) {
                    throw org.eclipse.persistence.exceptions.JAXBException.exceptionDuringNameTransformation(javaClass.getName(), info.getXmlNameTransformer().getClass().getName(), ex);
                }
            }
            String rootNamespace = xmlRE.getNamespace();
            QName rootElemName = null;
            if (rootNamespace.equals(XMLProcessor.DEFAULT)) {
                if (namespaceInfo == null) {
                    rootElemName = new QName(elementName);
                } else {
                    String rootNS = namespaceInfo.getNamespace();
                    rootElemName = new QName(rootNS, elementName);
                    if (rootNS.equals(Constants.EMPTY_STRING)) {
                        isDefaultNamespaceAllowed = false;
                    }
                }
            } else {
                rootElemName = new QName(rootNamespace, elementName);
                if (rootNamespace.equals(Constants.EMPTY_STRING)) {
                    isDefaultNamespaceAllowed = false;
                }
            }
            ElementDeclaration declaration = new ElementDeclaration(rootElemName, javaClass, javaClass.getQualifiedName(), false);
            declaration.setIsXmlRootElement(true);
            addGlobalElement(rootElemName, declaration);
            this.xmlRootElements.put(javaClass.getQualifiedName(), declaration);
        }
    }
    for (QName next : this.getGlobalElements().keySet()) {
        ElementDeclaration nextDeclaration = this.getGlobalElements().get(next);
        QName substitutionHead = nextDeclaration.getSubstitutionHead();
        while (substitutionHead != null) {
            ElementDeclaration rootDeclaration = this.getGlobalElements().get(substitutionHead);
            rootDeclaration.addSubstitutableElement(nextDeclaration);
            if (rootDeclaration.getSubstitutionHead() != null && rootDeclaration.getSubstitutionHead().equals(substitutionHead)) {
                // Break the loop if substitutionHead equals rootDeclaration's substitutionHead
                // (XmlElementDecl's substitutionHeadName == name)
                substitutionHead = null;
            } else {
                substitutionHead = rootDeclaration.getSubstitutionHead();
            }
        }
    }
}

Example 3 with XMLNameTransformer

use of org.eclipse.persistence.oxm.XMLNameTransformer in project eclipselink by eclipse-ee4j.

the class AnnotationsProcessor method buildTypeInfo.

/**
 * INTERNAL:
 *
 * Complete building TypeInfo objects for a given set of JavaClass
 * instances. This method assumes that init, preBuildTypeInfo, and
 * postBuildTypeInfo have been called.
 */
private Map<String, TypeInfo> buildTypeInfo(JavaClass[] allClasses) {
    for (JavaClass javaClass : allClasses) {
        if (javaClass == null) {
            continue;
        }
        TypeInfo info = typeInfos.get(javaClass.getQualifiedName());
        if (info == null || info.isPostBuilt()) {
            continue;
        }
        info.setPostBuilt(true);
        // handle factory methods
        processFactoryMethods(javaClass, info);
        PackageInfo packageInfo = getPackageInfoForPackage(javaClass);
        XMLNameTransformer transformer = info.getXmlNameTransformer();
        if (transformer == TypeInfo.DEFAULT_NAME_TRANSFORMER) {
            XMLNameTransformer nsInfoXmlNameTransformer = packageInfo.getXmlNameTransformer();
            if (nsInfoXmlNameTransformer != null) {
                info.setXmlNameTransformer(nsInfoXmlNameTransformer);
            } else if (helper.isAnnotationPresent(javaClass, XmlNameTransformer.class)) {
                XmlNameTransformer xmlNameTransformer = (XmlNameTransformer) helper.getAnnotation(javaClass, XmlNameTransformer.class);
                Class<? extends XMLNameTransformer> nameTransformerClass = xmlNameTransformer.value();
                try {
                    info.setXmlNameTransformer(nameTransformerClass.getConstructor().newInstance());
                } catch (ReflectiveOperationException ex) {
                    throw JAXBException.exceptionWithNameTransformerClass(nameTransformerClass.getName(), ex);
                }
            } else if (helper.isAnnotationPresent(javaClass.getPackage(), XmlNameTransformer.class)) {
                XmlNameTransformer xmlNameTransformer = (XmlNameTransformer) helper.getAnnotation(javaClass.getPackage(), XmlNameTransformer.class);
                Class<? extends XMLNameTransformer> nameTransformerClass = xmlNameTransformer.value();
                try {
                    info.setXmlNameTransformer(nameTransformerClass.getConstructor().newInstance());
                } catch (ReflectiveOperationException ex) {
                    throw JAXBException.exceptionWithNameTransformerClass(nameTransformerClass.getName(), ex);
                }
            }
        }
        // handle @XmlAccessorType
        postProcessXmlAccessorType(info, packageInfo);
        // handle @XmlType
        postProcessXmlType(javaClass, info, packageInfo);
        // handle @XmlEnum
        if (info.isEnumerationType()) {
            addEnumTypeInfo(javaClass, ((EnumTypeInfo) info));
            continue;
        }
        // process schema type name
        processTypeQName(javaClass, info, packageInfo.getNamespaceInfo());
        // handle superclass if necessary
        JavaClass superClass = javaClass.getSuperclass();
        processPropertiesSuperClass(javaClass, info);
        processReferencedClass(superClass);
        // add properties
        info.setProperties(getPropertiesForClass(javaClass, info));
        // process properties
        processTypeInfoProperties(javaClass, info);
        // handle @XmlAccessorOrder
        postProcessXmlAccessorOrder(info, packageInfo);
        validatePropOrderForInfo(info);
    }
    return typeInfos;
}