com.microsoft.bingads.v13.internal.bulk.SimpleBulkObjectWriter Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of microsoft.bingads Show documentation

The Bing Ads Java SDK is a library improving developer experience when working with the Bing Ads services by providing high-level access to features such as Bulk API, OAuth Authorization and SOAP API.

There is a newer version: 13.0.22.1

Show newest version

package com.microsoft.bingads.v13.internal.bulk;

import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.OutputStream;
import java.io.OutputStreamWriter;
import java.io.Writer;

import com.googlecode.jcsv.CSVStrategy;
import com.googlecode.jcsv.writer.CSVWriter;
import com.googlecode.jcsv.writer.internal.CSVWriterBuilder;
import com.microsoft.bingads.v13.bulk.DownloadFileType;
import com.microsoft.bingads.v13.bulk.entities.StaticBulkObjectFactory;

/**
 *
 *
 */
public class SimpleBulkObjectWriter implements BulkObjectWriter {

    private BulkObjectFactory bulkObjectFactory;
    private CSVWriter csvWriter;
    private Writer writer;

    public SimpleBulkObjectWriter(File filePath, DownloadFileType fileFormat) throws IOException {
        bulkObjectFactory = new StaticBulkObjectFactory();

        writer = new OutputStreamWriter(new FileOutputStream(filePath), "UTF-8");        
        
        csvWriter = this.buildCSVWriter(writer, fileFormat == DownloadFileType.CSV ? ',' : '\t');
    }

    public SimpleBulkObjectWriter(OutputStream outputStream, DownloadFileType fileFormat) throws IOException {
        bulkObjectFactory = new StaticBulkObjectFactory();

        writer = new OutputStreamWriter(outputStream, "UTF-8");

        csvWriter = this.buildCSVWriter(writer, fileFormat == DownloadFileType.CSV ? ',' : '\t');
    }

    /**
     * @see
     * com.microsoft.bingads.internal.bulk.BulkObjectWriter#writeFileMetadata()
     */
    @Override
    public void writeFileMetadata() throws IOException {
        this.writeHeaders();
        this.writeFormatVersion();
    }

    @Override
    public  void writeFormatVersion() throws IOException {
        RowValues versionRow = new RowValues();
        
        versionRow.put(StringTable.Type, StringTable.SemanticVersion);
        versionRow.put(StringTable.Name, StringTable.FORMAT_VERSION); //TODO: move to BulkServiceManager
                
        csvWriter.write(versionRow.getColumns());
        this.csvWriter.flush();
    }

    @Override
    public void writeHeaders() throws IOException {
        writer.write(0xFEFF);

        this.csvWriter.write(CsvHeaders.Headers);
        
        this.csvWriter.flush();
    }

    /**
     *
     * @param writer
     * @param delimiter
     * @return a CSV writer which uses the delimiter provided
     */
    private CSVWriter buildCSVWriter(Writer writer, char delimiter) {
        return new CSVWriterBuilder(writer)
                .entryConverter(new ReplaceNullsWithEmptyStringCSVEntryConverter())
                .strategy(this.createStrategyWithDelimiter(delimiter)).build();
    }

    /**
     *
     * @param delimiter
     * @return a strategy for writing the CSV using the delimiter provided
     */
    private CSVStrategy createStrategyWithDelimiter(char delimiter) {
        return new CSVStrategy(delimiter, '"', '#', false, true);
    }

    @Override
    public void writeObjectRow(BulkObject bulkObject, boolean excludeReadonlyData) throws IOException {
        RowValues values = new RowValues();
        bulkObject.writeToRowValues(values, excludeReadonlyData);

        String type = bulkObjectFactory.getBulkRowType(bulkObject);
        values.put(StringTable.Type, type);

        this.csvWriter.write(values.getColumns());
        this.csvWriter.flush();
    }

    /**
     * @see
     * com.microsoft.bingads.internal.bulk.BulkObjectWriter#writeObjectRow(com.microsoft.bingads.internal.bulk.BulkObject)
     */
    @Override
    public void writeObjectRow(BulkObject bulkObject) throws IOException {
        writeObjectRow(bulkObject, false);
    }

    @Override
    public void close() throws IOException {
        this.csvWriter.close();
    }
}