org.nerd4j.csv.conf.mapping.CSVParserConf 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 java.util.HashSet;
import java.util.Set;

import org.nerd4j.csv.parser.CSVParser;


/**
 * Represents the configuration of the {@link CSVParser}.
 * 
 * @author Nerd4j Team
 */
public class CSVParserConf extends CSVCharSetConf implements Cloneable
{
    
    /**
     * Set of characters to be completely ignored while parsing.
     * (by default this set is empty).
     */
    private Set charsToIgnore;
    
    /**
     * Set of characters to be ignored if found
     * on heading or trailing of a field.
     * (by default this set is: {[ ], [\t],[\n]}).
     */
    private Set charsToIgnoreAroundFields;
    
    /**
     * Tells if to treat CSV quotes less strictly.
     * More precisely tells the parser not to fail
     * in case a not escaped quote is found
     * into a field.
     */
    private Boolean lazyQuotes;
    
    
    /**
     * Default constructor.
     * 
     */
    public CSVParserConf()
    {

        super();
        
        this.charsToIgnore             = null;
        this.charsToIgnoreAroundFields = null;
        this.lazyQuotes                = null;
        
    }

    
    /* ******************* */
    /*  GETTERS & SETTERS  */
    /* ******************* */
    
    
    public Set getCharsToIgnore()
    {
        return charsToIgnore;
    }
    
    public void setCharsToIgnore( Set charsToIgnore )
    {
        this.charsToIgnore = charsToIgnore;
    }
    
    public Set getCharsToIgnoreAroundFields()
    {
        return charsToIgnoreAroundFields;
    }

    public void setCharsToIgnoreAroundFields( Set charsToIgnoreAroundFields )
    {
        this.charsToIgnoreAroundFields = charsToIgnoreAroundFields;
    }
    
    public Boolean isLazyQuotes()
    {
    	return lazyQuotes;
    }
    
    public void setLazyQuotes( Boolean lazyQuotes )
    {
    	this.lazyQuotes = lazyQuotes;
    }
    
    /* ******************* */
    /*  INTERFACE METHODS  */
    /* ******************* */
    


	/**
     * {@inheritDoc}
     */
    @Override
    public CSVParserConf clone() throws CloneNotSupportedException
    {
        
        final CSVParserConf clone = (CSVParserConf) super.clone();
        
        if( this.charsToIgnore != null )
            clone.charsToIgnore = new HashSet( this.charsToIgnore );
        
        if( this.charsToIgnoreAroundFields != null )
            clone.charsToIgnoreAroundFields = new HashSet( this.charsToIgnoreAroundFields );
        
        return clone;
        
    }
    
}