AutoMapConfiguration.java

/*
 * This file is part of the GeoLatte project.
 *
 *     GeoLatte is free software: you can redistribute it and/or modify
 *     it under the terms of the GNU Lesser General Public License as published by
 *     the Free Software Foundation, either version 3 of the License, or
 *     (at your option) any later version.
 *
 *     GeoLatte is distributed in the hope that it will be useful,
 *     but WITHOUT ANY WARRANTY; without even the implied warranty of
 *     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *     GNU Lesser General Public License for more details.
 *
 *     You should have received a copy of the GNU Lesser General Public License
 *     along with GeoLatte.  If not, see <http://www.gnu.org/licenses/>.
 *
 * Copyright (C) 2010 - 2012 and Ownership of code is shared by:
 * Qmino bvba - Romeinsestraat 18 - 3001 Heverlee  (http://www.qmino.com)
 * Geovise bvba - Generaal Eisenhowerlei 9 - 2140 Antwerpen (http://www.geovise.com)
 */

package org.geolatte.common.automapper;

import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.List;

/**
 * The configuration for an <code>AutoMapper</code>
 *
 * @author Karel Maesen, Geovise BVBA
 *         creation-date: 8/23/12
 */
public class AutoMapConfiguration {

    /**
     * The default package name for the generated classes.
     */
    final public static String DEFAULT_PACKAGE_NAME = "org.geolatte.common.features.generated";

    final private String packageName;
    final private NamingStrategy naming;
    final private TypeMapper typeMapper;
    final private List<TableConfiguration> tableConfigurations = new ArrayList<TableConfiguration>();

    /**
     * Constructs an instance
     *
     * @param packageName the package name for all generated classes
     * @param naming      the <code>NamingStrategy</code> to use
     * @param typeMapper  the <code>TypeMapper</code> to use
     */
    public AutoMapConfiguration(String packageName, NamingStrategy naming, TypeMapper typeMapper) {
        this.packageName = packageName;
        this.naming = naming;
        this.typeMapper = typeMapper;
    }

    /**
     * Constructs an instance with the default package name and a <code>SimpleNamingStrategy</code>
     *
     * @param typeMapper the <code>TypeMapper</code> instance to use.
     */
    public AutoMapConfiguration(TypeMapper typeMapper) {
        this(DEFAULT_PACKAGE_NAME, new SimpleNamingStrategy(), typeMapper);
    }


    /**
     * Returns the package name of the package that contains the generated classes.
     *
     * @return the package name of the package that contains the generated classes.
     */
    public String getPackageName() {
        return packageName;
    }

    /**
     * Returns the <code>NamingStrategy</code> to use for generating class and property names from table and column names.
     *
     * @return the <code>NamingStrategy</code> to use for generating class and property names from table and column names.
     */
    public NamingStrategy getNaming() {
        return naming;
    }

    /**
     * Returns the <code>TypeMapper</code> to use during Class generation.
     *
     * @return the <code>TypeMapper</code> to use during Class generation.
     */
    public TypeMapper getTypeMapper() {
        return typeMapper;
    }

    /**
     * Adds a <code>TableRef</code> to the configuration.
     * <p/>
     * <p>A default (empty) <code>TableConfiguration</code> will be be created and stored in the configuration.</p>
     *
     * @param tableRef a <code>TableRef</code> that identifies a table in the database.
     */
    public void addTable(TableRef tableRef) {
        tableConfigurations.add(TableConfiguration.Builder.emptyConfig(tableRef));
    }

    /**
     * Adds a <code>TableConfiguration</code> to the configuration.
     *
     * @param configuration a <code>TableConfiguration</code> that instructs how to map the table to a generated class.
     */
    public void addTableConfiguration(TableConfiguration configuration) {
        tableConfigurations.add(configuration);
    }

    /**
     * Returns all <code>TableConfiguration</code>s configured in this <code>AutoMapConfiguration</code>
     *
     * @return all <code>TableConfigs</code>s in this <code>AutoMapConfiguration</code>
     */
    public Collection<TableConfiguration> getTableConfigurations() {
        return Collections.unmodifiableList(tableConfigurations);
    }

    TableConfiguration getTableConfiguration(TableRef tableRef) {
        for (TableConfiguration cfg : tableConfigurations) {
            if (cfg.getTableRef().equals(tableRef)) {
                return cfg;
            }
        }
        return null;
    }

    List<TableRef> getTableRefs() {
        List<TableRef> result = new ArrayList<TableRef>(tableConfigurations.size());
        for (TableConfiguration cfg : tableConfigurations) {
            result.add(cfg.getTableRef());
        }
        return result;
    }

}