org.nerd4j.csv.registry.CSVAbstractRegistry Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of nerd4j-csv Show documentation
CSV manipulation library.
There is a newer version: 1.2.0
/*
 * #%L
 * Nerd4j CSV
 * %%
 * Copyright (C) 2013 Nerd4j
 * %%
 * This program 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.
 * 
 * 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 General Lesser Public License for more details.
 * 
 * You should have received a copy of the GNU General Lesser Public 
 * License along with this program.  If not, see
 * .
 * #L%
 */
package org.nerd4j.csv.registry;

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

import org.nerd4j.csv.exception.CSVConfigurationException;


/**
 * Abstract implementation of a registry containing
 * the providers able to understand the configured
 * values and provide the related objects.
 * 
 * 
 *  Currently the available implementations are:
 *  

 *    {@link CSVFieldValidatorRegistry}
 *    {@link CSVFieldConverterRegistry}
 *    {@link CSVToModelBinderFactoryRegistry}
 *    {@link ModelToCSVBinderFactoryRegistry}
 *  
 * 
 * 
 * @param  type of the entry to build.
 * 
 * @author Nerd4j Team
 */
public abstract class CSVAbstractRegistry
{

    /** The internal map used to register the entries. */
    private final Map entryRegistry;
    
    /** The internal map used to register the entry providers. */
    private final Map> providerRegistry;
    
    
    /**
     * Default constructor.
     * 
     */
    public CSVAbstractRegistry()
    {
        
        super();
        
        this.entryRegistry = new HashMap();
        this.providerRegistry = new HashMap>();
        
    }
    
    
    /* ******************* */
    /*  INTERFACE METHODS  */
    /* ******************* */

    
    /**
     * Returns the entry associated to the given key
     * if any, otherwise returns null.
     * 
     * @param name name to use to reference the entry.
     */
    public Entry getEntry( String name )
    {
        
        final Entry entry = entryRegistry.get( name );
        if( entry == null )
            throw new CSVConfigurationException( "There is no entry registred with name " + name );
        
        return entry;
        
    }

    /**
     * Sets the given entry in relation to the given name.
     * If the name already exists the related entry will be
     * overwritten.
     * 
     * @param name  name to use to reference the entry.
     * @param entry the actual entry.
     */
    public void setEntry( String name, Entry entry )
    {
        
        entryRegistry.put( name, entry );
        
    }

    /**
     * Merges the internal registry with the given map.
     * If some keys already exist the related entries
     * will be overwritten.
     * 
     * @param entries the entries to set.
     */
    public void setEntries( Map entries )
    {
        
        entryRegistry.putAll( entries );
        
    }
    
    /**
     * Returns the provider associated to the given key
     * if any, otherwise returns null.
     * 
     * @param name    name to use to reference the provider.
     */
    public CSVRegistryEntryProvider getProvider( String name )
    {
        
        final CSVRegistryEntryProvider provider = providerRegistry.get( name );
        if( provider == null )
            throw new CSVConfigurationException( "There is no provider registred with name " + name );
        
        return provider;
        
    }
    
    /**
     * Sets the given provider in relation to the given name.
     * If the name already exists the related provider will be
     * overwritten.
     * 
     * @param name    name to use to reference the provider.
     * @param provider the actual provider.
     */
    public void setProvider( String name, CSVRegistryEntryProvider provider )
    {
        
    	providerRegistry.put( name, provider );
        
    }
    
    /**
     * Merges the internal registry with the given map.
     * If some keys already exist the related providers
     * will be overwritten.
     * 
     * @param providers the providers to set.
     */
    public void setProviders( Map> providers )
    {
        
    	providerRegistry.putAll( providers );
        
    }
    
    /**
     * Searches in the registry the provider with the given name and
     * gives the parameters to the provider to provide a new entry.
     * 
     * @param name   name of the provider.
     * @param params requested parameters.
     * @return the related entry.
     * @throws CSVConfigurationException if no provider are registered
     *                                   with the given name.
     */
    public Entry provideEntry( String name, Map params )
    throws CSVConfigurationException
    {
        
        return getProvider( name ).get( params );
        
    }
    
}