net.sf.jsefa.csv.lowlevel.CsvLowLevelSerializerImpl Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jsefa-android Show documentation

JSefa (Java Simple exchange format api) is a simple library for stream-based serialization of java objects to XML, CSV, FLR or any other format and back again using an iterator-style interface independent of the serialization format. The mapping between java object types and types of the serialization format (e. g. xml complex element types) can be defined either by annotating the java classes or programmatically using a simple API. The current implementation supports XML, CSV and FLR - for XML it is based on JSR 173.

The newest version!

/*
 * Copyright 2007 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.jsefa.csv.lowlevel;

import net.sf.jsefa.csv.lowlevel.config.CsvLowLevelConfiguration;
import net.sf.jsefa.csv.lowlevel.config.EscapeMode;
import net.sf.jsefa.csv.lowlevel.config.QuoteMode;
import net.sf.jsefa.rbf.lowlevel.RbfLowLevelSerializerImpl;

/**
 * Implementation of {@link CsvLowLevelSerializer} based on {@link RbfLowLevelSerializerImpl}.
 * 
 * @author Norman Lahme-Huetig
 */
public class CsvLowLevelSerializerImpl extends RbfLowLevelSerializerImpl implements
        CsvLowLevelSerializer {

    private int fieldCount;

    private int specialRecordDelimiter;

    /**
     * Constructs a new CsvLowLevelSerializerImpl.
     * 
     * @param config the configuration
     */
    public CsvLowLevelSerializerImpl(CsvLowLevelConfiguration config) {
        super(config);
        if (config.getSpecialRecordDelimiter() != null) {
            this.specialRecordDelimiter = config.getSpecialRecordDelimiter();
        } else {
            this.specialRecordDelimiter = -1;
        }
    }

    /**
     * {@inheritDoc}
     */
    @Override
    protected void afterOpen() {
        this.fieldCount = 0;
    }

    /**
     * {@inheritDoc}
     */
    public void writeField(String value, QuoteMode quoteMode) {
        if (this.fieldCount > 0) {
            writeChar(getConfiguration().getFieldDelimiter());
        }
        encodeAndWrite(value, quoteMode);
        fieldCount++;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    protected void beforeFinishRecord() {
        if (getConfiguration().getUseDelimiterAfterLastField()) {
            writeChar(getConfiguration().getFieldDelimiter());
        }
        this.fieldCount = 0;
    }

    private void encodeAndWrite(String value, QuoteMode quoteMode) {
        if (value.length() == 0) {
            return;
        }
        switch (quoteMode) {
        case ALWAYS:
            encodeAndWriteUsingQuotes(value);
            break;
        case ON_DEMAND:
            encodeAndWriteUsingQuotesOnDemand(value);
            break;
        case NEVER:
            encodeAndWriteUsingEscapeCharacter(value);
            break;
        default:
            throw new UnsupportedOperationException("The quote mode is not supported: " + quoteMode);
        }
    }

    private void encodeAndWriteUsingQuotes(String value) {
        char quoteChar = getConfiguration().getQuoteCharacter();
        char escapeCharacter = getConfiguration().getEscapeCharacter();
        if (getConfiguration().getQuoteCharacterEscapeMode().equals(EscapeMode.DOUBLING)) {
            escapeCharacter = quoteChar;
        }
        writeChar(quoteChar);
        int index = 0;
        while (index < value.length()) {
            char currentChar = value.charAt(index++);
            if (currentChar == quoteChar) {
                writeChar(escapeCharacter);
            }
            writeChar(currentChar);
        }
        writeChar(getConfiguration().getQuoteCharacter());
    }

    private void encodeAndWriteUsingQuotesOnDemand(String value) {
        if (needsQuotes(value)) {
            encodeAndWriteUsingQuotes(value);
        } else {
            writeString(value);
        }
    }

    private void encodeAndWriteUsingEscapeCharacter(String value) {
        int index = 0;
        while (index < value.length()) {
            char currentChar = value.charAt(index++);
            if (currentChar == getConfiguration().getEscapeCharacter()
                    || currentChar == getConfiguration().getFieldDelimiter()
                    || currentChar == this.specialRecordDelimiter) {
                writeChar(getConfiguration().getEscapeCharacter());
                writeChar(currentChar);
            } else if (currentChar == '\n') {
                writeChar(getConfiguration().getEscapeCharacter());
                writeChar('n');
            } else {
                writeChar(currentChar);
            }
        }
    }

    private boolean needsQuotes(String value) {
        if (value.charAt(0) == getConfiguration().getQuoteCharacter()) {
            return true;
        }
        for (int i = 0; i < value.length(); i++) {
            char currentChar = value.charAt(i);
            if (currentChar == getConfiguration().getEscapeCharacter()
                    || currentChar == getConfiguration().getFieldDelimiter()) {
                return true;
            }
        }
        if (value.contains(getConfiguration().getLineBreak())) {
            return true;
        }
        return false;
    }

}