org.nerd4j.csv.conf.mapping.CSVReaderConf 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.conf.mapping;

import org.nerd4j.csv.reader.CSVReader;


/**
 * Represents the configuration of the {@link CSVReader}.
 * 
 * @author Nerd4j Team
 */
public class CSVReaderConf extends CSVHandlerConf implements Cloneable
{

    /** Tells if to read the CSV source first row as header. */
    private Boolean readHeader;
    
    /** Tells if to use column names during configuration. */
    private Boolean useColumnNames;
    
    /**
     * In the CSV standard each record must have the same number of cells.
     * But it is possible to face non standard CSV files where records
     * have different lengths.
     * 
     *  This flag tells the reader to accept such non standard files.
     *  In this case the reader may return incomplete data models.
     * 
     */
    private Boolean acceptIncompleteRecords;
    
    /** The name to reference the parser configuration to use. */
    private String parserRef;
    
    /** The parser configuration embedded into the reader. */
    private CSVParserConf parser;
    
    /**
     * Default constructor.
     * 
     */
    public CSVReaderConf()
    {

        super();
    
        this.parser = null;
        this.parserRef = null;
        
        this.readHeader = null;
        this.useColumnNames = null;
        this.acceptIncompleteRecords = null;
        
    }
   
    
    /* ******************* */
    /*  GETTERS & SETTERS  */
    /* ******************* */
    

    public Boolean getReadHeader()
    {
        return readHeader;
    }
    
    public void setReadHeader( Boolean readHeader )
    {
        this.readHeader = readHeader;
    }
    
    public Boolean getUseColumnNames()
    {
        return useColumnNames;
    }
    
    public void setUseColumnNames( Boolean useColumnNames )
    {
        this.useColumnNames = useColumnNames;
    }

    public Boolean getAcceptIncompleteRecords()
    {
    	return acceptIncompleteRecords;
    }
    
    public void setAcceptIncompleteRecords( Boolean acceptIncompleteRecords )
    {
    	this.acceptIncompleteRecords = acceptIncompleteRecords;
    }

    public String getParserRef()
    {
        return parserRef;
    }
    
    public void setParserRef( String parserRef )
    {
        this.parserRef = parserRef;
    }

    public CSVParserConf getParser()
    {
        return parser;
    }

    public void setParser( CSVParserConf parser )
    {
        this.parser = parser;
    }
    
    
    /* ******************* */
    /*  INTERFACE METHODS  */
    /* ******************* */
    
    
    /**
     * {@inheritDoc}
     */
    @Override
    public CSVReaderConf clone() throws CloneNotSupportedException
    {
        
        final CSVReaderConf clone = (CSVReaderConf) super.clone();
        
        clone.parser = this.parser != null ? this.parser.clone() : null;
        
        return clone;
        
    }

}