/**
 * DataCleaner (community edition)
 * Copyright (C) 2014 Neopost - Customer Information Management
 *
 * This copyrighted material is made available to anyone wishing to use, modify,
 * copy, or redistribute it subject to the terms and conditions of the GNU
 * Lesser General Public License, as published by the Free Software Foundation.
 *
 * This program 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 this distribution; if not, write to:
 * Free Software Foundation, Inc.
 * 51 Franklin Street, Fifth Floor
 * Boston, MA  02110-1301  USA
 */
package org.datacleaner.configuration;

import org.apache.metamodel.util.Resource;

/**
 * Defines an interface that allows for interception, decoration and other
 * handling of configuration building.
 */
public interface ConfigurationReaderInterceptor {

    /**
     * Intercepts a filename, allowing for eg. replacing variables or changing
     * relative paths to absolute paths.
     *
     * @param filename
     * @return
     *
     * @deprecated use {@link #createResource(String)} instead.
     */
    @Deprecated
    String createFilename(String filename);

    /**
     * Intercepts a resource creation, allowing for eg. limiting types or do
     * special processing.
     *
     * @param resourceUrl
     * @param tempDataCleanerConfiguration The temporary/partially built configuration. Do _not_ store
     * @return
     */
    Resource createResource(String resourceUrl, DataCleanerConfiguration tempDataCleanerConfiguration);

    /**
     * Gets a temporary storage directory
     *
     * @return
     */
    String getTemporaryStorageDirectory();

    /**
     * Loads a class
     *
     * @param className
     * @return
     * @throws ClassNotFoundException
     */
    Class<?> loadClass(String className) throws ClassNotFoundException;

    /**
     * Gets an optional override of properties in the configuration.
     *
     * @param variablePath
     *            the path of a variable, eg. "datastoreCatalog.orderdb.url" or
     *            "referenceDataCatalog.my_dictionary.filename".
     * @return a variable override, or null if the variable is not overridden.
     */
    String getPropertyOverride(String variablePath);

    /**
     * Creates a base {@link DataCleanerEnvironment} object for initial building
     * of the resulting configuration. This method allows to bootstrap the base
     * configuration used, eg. by providing a specific injection manager.
     *
     * @return a base {@link DataCleanerEnvironment} for further building of the
     *         configuration.
     */
    DataCleanerEnvironment createBaseEnvironment();

    /**
     * Gets the home folder to use as per
     * {@link DataCleanerConfiguration#getHomeFolder()}.
     *
     * @return
     */
    DataCleanerHomeFolder getHomeFolder();
}