org.nerd4j.csv.field.CSVFieldMetadata 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.field;

import org.nerd4j.csv.exception.CSVConfigurationException;


/**
 * Represents the meta-data that describes how to handle
 * a single field in the CSV process.
 * 
 * @param  type of the source field format.
 * @param  type of the target field format.
 * 
 * @author Nerd4J Team
 */
public final class CSVFieldMetadata
{

    /** The name of the CSV column corresponding to the field. */
    private final String columnName;

    /** Object that describes the field-model mapping. */
    private final String mappingDescriptor;
    
    /** The field used to represent the column. */
    private final CSVField field;

    
    /**
     * Constructor with parameters.
     * 
     * @param columnName        the name of the CSV column corresponding to the field (optional).
     * @param mappingDescriptor the field-model mapping (mandatory).
     * @param field             the field used to represent the column (mandatory).
     * 
     */
    public CSVFieldMetadata( final String columnName, final String mappingDescriptor, final CSVField field )
    {
        
        super();
        
        if( columnName == null || columnName.isEmpty() )
            throw new CSVConfigurationException( "The provided column name must be not null or empty. Check the configuration" );

        
        if( mappingDescriptor == null )
            throw new CSVConfigurationException( "The mapping descriptor is mandatory. Check the configuration" );
        
        if( field == null )
            throw new CSVConfigurationException( "The field is mandatory. Check the configuration" );
        
        this.field = field;
        this.columnName = columnName;
        this.mappingDescriptor = mappingDescriptor;
        
    }

    
    /* ******************* */
    /*  GETTERS & SETTERS  */
    /* ******************* */

    
    public String getColumnName()
    {
        return columnName;
    }
    
    public String getMappingDescriptor()
    {
        return mappingDescriptor;
    }
    
    public CSVField getField()
    {
        return field;
    }
    
}