net.sf.jsefa.xml.mapping.ElementMappingsBuilder 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.mapping;

import java.util.ArrayList;
import java.util.List;

import net.sf.jsefa.common.mapping.FieldDescriptor;
import net.sf.jsefa.common.validator.Validator;
import net.sf.jsefa.xml.lowlevel.TextMode;
import net.sf.jsefa.xml.namespace.QName;

/**
 * Builder for creating a list of {@link ElementMapping}s whereby the parameter
 * elementNameIsAmbiguous is determined automatically.
 * 
 * It is not intended to be thread safe.
 * 
 * @author Norman Lahme-Huetig
 * @author Matthias Derer
 * 
 */
public final class ElementMappingsBuilder {
    private final List dataHolders;

    /**
     * Constructs a new ElementMappingsBuilder.
     */
    public ElementMappingsBuilder() {
        this.dataHolders = new ArrayList();
    }

    /**
     * Adds an element mapping to be build.
     * 
     * @param dataTypeName the data type name
     * @param elementDescriptor the element descriptor
     * @param fieldDescriptor the field descriptor
     * @param validator the validator; may be null
     * @param textMode the text mode
     */
    public void addMapping(QName dataTypeName, ElementDescriptor elementDescriptor,
            FieldDescriptor fieldDescriptor, Validator validator, TextMode textMode) {
        addMapping(dataTypeName, elementDescriptor, fieldDescriptor.getObjectType(), fieldDescriptor,
                validator, textMode);
    }

    /**
     * Adds an element mapping to be build.
     * 
     * @param dataTypeName the data type name
     * @param elementDescriptor the element descriptor
     * @param objectType the objectType
     * @param fieldDescriptor the field descriptor; may be null
     * @param validator the validator; may be null
     * @param textMode the text mode; may be null
     */
    public void addMapping(QName dataTypeName, ElementDescriptor elementDescriptor, Class objectType,
            FieldDescriptor fieldDescriptor, Validator validator, TextMode textMode) {
        this.dataHolders.add(new DataHolder(dataTypeName, elementDescriptor, objectType, fieldDescriptor,
                validator, textMode));
    }

    /**
     * Returns the building result, i. e. a list of ElementMappings.
     * 
     * @return a list of ElementMappings
     */
    public List getResult() {
        List elementMappings = new ArrayList();
        for (DataHolder dataHolder : this.dataHolders) {
            elementMappings.add(new ElementMapping(dataHolder.dataTypeName, dataHolder.elementDescriptor,
                    dataHolder.objectType, dataHolder.fieldDescriptor, dataHolder.validator,
                    isAmbiguous(dataHolder), dataHolder.textMode));
        }
        return elementMappings;
    }

    private boolean isAmbiguous(DataHolder dataHolder) {
        if (dataHolder.elementDescriptor.getName() == null) {
            return false;
        }
        for (DataHolder otherDataHolder : this.dataHolders) {
            if (otherDataHolder == dataHolder || otherDataHolder.elementDescriptor.getName() == null) {
                continue;
            }
            if (otherDataHolder.elementDescriptor.getName().equals(dataHolder.elementDescriptor.getName())) {
                if (otherDataHolder.objectType.isAssignableFrom(dataHolder.objectType)) {
                    return true;
                } else if (!dataHolder.objectType.isAssignableFrom(otherDataHolder.objectType)) {
                    return true;
                }
            }
        }
        return false;
    }

    private static final class DataHolder {
        private QName dataTypeName;

        private ElementDescriptor elementDescriptor;

        private FieldDescriptor fieldDescriptor;

        private Validator validator;

        private Class objectType;

        private TextMode textMode;

        private DataHolder(QName dataTypeName, ElementDescriptor elementDescriptor, Class objectType,
                FieldDescriptor fieldDescriptor, Validator validator, TextMode textMode) {
            this.dataTypeName = dataTypeName;
            this.elementDescriptor = elementDescriptor;
            this.objectType = objectType;
            this.fieldDescriptor = fieldDescriptor;
            this.validator = validator;
            this.textMode = textMode;
        }
    }
}