net.sf.flatpack.DelimiterParser Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of flatpack Show documentation
Simple Java delimited and fixed width file parser. Handles CSV, Excel CSV, Tab, Pipe delimiters, just to name a few. Maps column positions in the file to user friendly names via XML. See FlatPack Feature List under News for complete feature list.
There is a newer version: 4.0.18
Show newest version
/*
 * ObjectLab, http://www.objectlab.co.uk/open is supporting FlatPack.
 *
 * Based in London, we are world leaders in the design and development
 * of bespoke applications for the securities financing markets.
 *
 * Click here to learn more
 *           ___  _     _           _   _          _
 *          / _ \| |__ (_) ___  ___| |_| |    __ _| |__
 *         | | | | '_ \| |/ _ \/ __| __| |   / _` | '_ \
 *         | |_| | |_) | |  __/ (__| |_| |__| (_| | |_) |
 *          \___/|_.__// |\___|\___|\__|_____\__,_|_.__/
 *                   |__/
 *
 *                     www.ObjectLab.co.uk
 *
 * $Id: ColorProvider.java 74 2006-10-24 22:19:05Z benoitx $
 *
 * Copyright 2006 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */
package net.sf.flatpack;

import java.io.File;
import java.io.FileNotFoundException;
import java.io.FileReader;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.Reader;

import net.sf.flatpack.xml.MapParser;


/**
 * @author xhensevb
 *
 */
public class DelimiterParser extends AbstractDelimiterParser {
    private InputStream pzmapXMLStream = null;
    private File pzmapXML = null;
    private Reader pzmapReader;

    // this InputStream and file can be removed after support for
    // file and inputstream is removed from the parserfactory. The
    // methods have been deprecated..pz
    private InputStream dataSourceStream = null;
    private File dataSource = null;

    public DelimiterParser(final File pzmapXML, final File dataSource, final char delimiter, final char qualifier, final boolean ignoreFirstRecord) {
        super(null, delimiter, qualifier, ignoreFirstRecord);
        this.pzmapXML = pzmapXML;
        this.dataSource = dataSource;
    }

    public DelimiterParser(final InputStream pzmapXMLStream, final InputStream dataSourceStream, final char delimiter, final char qualifier,
            final boolean ignoreFirstRecord) {
        super(null, delimiter, qualifier, ignoreFirstRecord);
        this.pzmapXMLStream = pzmapXMLStream;
        this.dataSourceStream = dataSourceStream;
    }

    public DelimiterParser(final File dataSource, final char delimiter, final char qualifier, final boolean ignoreFirstRecord) {
        super(null, delimiter, qualifier, ignoreFirstRecord);
        this.dataSource = dataSource;
    }

    public DelimiterParser(final InputStream dataSourceStream, final char delimiter, final char qualifier, final boolean ignoreFirstRecord) {
        super(null, delimiter, qualifier, ignoreFirstRecord);
        this.dataSourceStream = dataSourceStream;
    }

    public DelimiterParser(final Reader dataSourceReader, final char delimiter, final char qualifier, final boolean ignoreFirstRecord) {
        super(dataSourceReader, delimiter, qualifier, ignoreFirstRecord);
    }

    public DelimiterParser(final Reader dataSourceReader, final Reader pzmapReader, final char delimiter, final char qualifier,
            final boolean ignoreFirstRecord) {
        super(dataSourceReader, delimiter, qualifier, ignoreFirstRecord);
        this.pzmapReader = pzmapReader;
    }

    @Override
    protected void init() {
        try {
            // check to see if the user is using a File or InputStream. This is
            // here for backwards compatibility
            initStreamOrSource();

            boolean closeMapReader = false;
            if (pzmapXML != null) {
                this.pzmapReader = new FileReader(pzmapXML);
                closeMapReader = true;
            } else if (pzmapXMLStream != null) {
                this.pzmapReader = new InputStreamReader(pzmapXMLStream);
                closeMapReader = true;
            }

            if (this.pzmapReader != null) {
                try {
                    setPzMetaData(MapParser.parseMap(this.pzmapReader, this));
                } finally {
                    if (closeMapReader) {
                        // only close the reader if it is one we created
                        // otherwise we will let the user handle it
                        this.pzmapReader.close();
                    }
                }
            }

            setInitialised(true);
        } catch (final IOException e) {
            throw new InitialisationException(e);
        } catch (final Exception e) {
            throw new InitialisationException(e);
        }
    }

    private void initStreamOrSource() throws FileNotFoundException {
        if (dataSourceStream != null) {
            final Reader r = new InputStreamReader(dataSourceStream);
            setDataSourceReader(r);
            addToCloseReaderList(r);
        } else if (dataSource != null) {
            final Reader r = new FileReader(dataSource);
            setDataSourceReader(r);
            addToCloseReaderList(r);
        }
    }

    @Override
    protected boolean shouldCreateMDFromFile() {
        return pzmapReader == null;
    }
}