com.opencsv.bean.AbstractFieldMap Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of opencsv Show documentation
A simple library for reading and writing CSV in Java
There is a newer version: 5.9
/*
 * Copyright 2018 Andrew Rucker Jones.
 *
 * 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 com.opencsv.bean;

import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import java.util.ListIterator;
import java.util.Locale;
import java.util.SortedMap;
import java.util.TreeMap;
import org.apache.commons.lang3.ObjectUtils;

/**
 * A base class to collect all generalized components of a {@link FieldMap}.
 * May be used by all as a base class for their own implementations of
 * {@link FieldMap}.
 * 
 * @param  The initializer type used to build the many-to-one mapping
 * @param  Type of the field identifier (key)
 * @param  Type of the ComplexFieldMapEntry used
 * @param  Type of the bean being converted
 * 
 * @author Andrew Rucker Jones
 * @since 4.2
 */
abstract public class AbstractFieldMap, T>
        implements FieldMap {
    
    /** The locale for error messages. */
    protected Locale errorLocale;
    
    /**
     * A map for all simple, that is one-to-one, mappings represented in this
     * {@link FieldMap}.
     */
    protected final SortedMap> simpleMap = new TreeMap<>();
    
    /**
     * A list of entries representing all complex, that is many-to-one, mappings
     * represented in this {@link FieldMap}.
     */
    protected final List complexMapList = new ArrayList<>();
    
    /**
     * Initializes this {@link FieldMap}.
     * 
     * @param errorLocale The locale to be used for error messages
     */
    public AbstractFieldMap(final Locale errorLocale) {
        this.errorLocale = ObjectUtils.defaultIfNull(errorLocale, Locale.getDefault());
    }
    
    @Override
    public BeanField get(final K key) {
        BeanField f = simpleMap.get(key);
        final ListIterator iterator = complexMapList.listIterator();
        while(f == null && iterator.hasNext()) {
            final ComplexFieldMapEntry r = iterator.next();
            if(r.contains(key)) {
                f = r.getBeanField();
            }
        }
        return f;
    }
    
    @Override
    public BeanField put(final K key, final BeanField value) {
        return simpleMap.put(key, value);
    }
    
    @Override
    public Collection> values() {
        final List> l = new ArrayList<>(simpleMap.size() + complexMapList.size());
        l.addAll(simpleMap.values());
        for(ComplexFieldMapEntry r : complexMapList) {
            l.add(r.getBeanField());
        }
        return l;
    }
    
    @Override
    public void setErrorLocale(final Locale errorLocale) {
        this.errorLocale = ObjectUtils.defaultIfNull(errorLocale, Locale.getDefault());
        for(ComplexFieldMapEntry e : complexMapList) {
            e.setErrorLocale(this.errorLocale);
        }
    }
}