net.sf.jsefa.xml.annotation.XmlEntryPointFactory Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jsefa-android Show documentation

JSefa (Java Simple exchange format api) is a simple library for stream-based serialization of java objects to XML, CSV, FLR or any other format and back again using an iterator-style interface independent of the serialization format. The mapping between java object types and types of the serialization format (e. g. xml complex element types) can be defined either by annotating the java classes or programmatically using a simple API. The current implementation supports XML, CSV and FLR - for XML it is based on JSR 173.

The newest version!

/*
 * Copyright 2007 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package net.sf.jsefa.xml.annotation;

import java.util.Collection;
import java.util.HashMap;
import java.util.Map;

import net.sf.jsefa.common.annotation.ValidatorFactory;
import net.sf.jsefa.common.validator.Validator;
import net.sf.jsefa.xml.mapping.XmlEntryPoint;
import net.sf.jsefa.xml.mapping.XmlTypeMappingRegistry;
import net.sf.jsefa.xml.namespace.NamespaceManager;
import net.sf.jsefa.xml.namespace.QName;
import net.sf.jsefa.xml.namespace.QNameParser;

/**
 * Factory for creating {@link XmlEntryPoint}s from annotated classes.
 * 
 * @author Norman Lahme-Huetig
 * 
 */
public final class XmlEntryPointFactory {

    private final XmlTypeMappingFactory typeMappingFactory;

    private final ValidatorFactory validatorFactory;

    /**
     * Constructs a new XmlEntryPointFactory.
     * 
     * @param typeMappingFactory the type mapping factory.
     * @param validatorFactory the validator factory.
     */
    public XmlEntryPointFactory(XmlTypeMappingFactory typeMappingFactory, ValidatorFactory validatorFactory) {
        this.typeMappingFactory = typeMappingFactory;
        this.validatorFactory = validatorFactory;
    }

    /**
     * Creates entry points for the given object types and their descendants using their annotations.
     * 
     * The following rules apply:
     * 

     * 1. For each two object types A and B in objectTypes with B being a descendant of A and A < B
     * (A comes before B in objectTypes), the resulting list contains an entry point with an
     * element name taken from B and not from A.
     * 
     * 2. For each descendant B of an object type A in objectTypes the resulting list contains an
     * entry point with an element name taken from A and not from B as long as rule 1 does not apply.
     * 
     * @param objectTypes the object types
     * @return a Collection of entry points.
     */
    public Collection createEntryPoints(Class... objectTypes) {
        Map, XmlEntryPoint> entryPoints = new HashMap, XmlEntryPoint>();
        XmlTypeMappingRegistry registry = typeMappingFactory.getTypeMappingRegistry();
        for (Class rootObjectType : objectTypes) {
            QName rootDataTypeName = typeMappingFactory.createIfAbsent(rootObjectType);
            QName elementName = getAnnotatedElementName(rootObjectType, rootObjectType.getSimpleName());
            for (QName dataTypeName : registry.getDataTypeNameTreeElements(rootDataTypeName)) {
                Class objectType = registry.get(dataTypeName).getObjectType();
                Validator validator = this.validatorFactory.createContextualValidator(objectType, null, null, 
                        XmlDataType.class);
                entryPoints.put(objectType, new XmlEntryPoint(dataTypeName, elementName, validator));
            }
        }
        return entryPoints.values();
    }

    private QName getAnnotatedElementName(Class objectType, String defaultName) {
        NamespaceManager namespaceManager = NamespaceManagerFactory.create(objectType);
        String name = null;
        if (objectType.isAnnotationPresent(XmlDataType.class)) {
            name = objectType.getAnnotation(XmlDataType.class).defaultElementName();
        }
        if (name != null && name.length() != 0) {
            return QNameParser.parse(name, true, namespaceManager);
        } else {
            return QNameParser.parse(defaultName, true, namespaceManager);
        }
    }

}