com.microsoft.bingads.v13.internal.bulk

Class BulkObject

java.lang.Object

com.microsoft.bingads.v13.internal.bulk.BulkObject

Direct Known Subclasses:

BulkEntity, BulkEntityIdentifier, BulkError, BulkKeywordBidSuggestion, FormatVersion

public abstract class BulkObject
extends Object

A representation of a block of data (set of csv lines) provided in the Bulk File Schema.

Constructor Summary

Constructors

Constructor and Description
BulkObject()

Method Summary

Modifier and Type	Method and Description
boolean	canEncloseInMultilineEntity()
MultiRecordBulkEntity	encloseInMultilineEntity()
void	readFromRowValues(RowValues values) Read object data from a single row.
void	readRelatedData(BulkRecordReader reader) Reads object data from consecutive rows.
void	write(BulkObjectWriter rowWriter, boolean excludeReadonlyData) Writes object data to consecutive rows.
void	writeToRowValues(RowValues values, boolean excludeReadonlyData) Writes object data to a single row.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BulkObject

public BulkObject()

Method Detail

readRelatedData

public void readRelatedData(BulkRecordReader reader)

Reads object data from consecutive rows.

• SingleLineBulkEntity: reads entity errors.
• MultilineBulkEntity: reads child entities.

Parameters:

reader -

readFromRowValues

public void readFromRowValues(RowValues values)

Read object data from a single row.

• SingleLineBulkEntity: reads entity fields.
• BulkError: reads error fields.
• BulkEntityIdentifier: reads identifier fields (Id, status etc.).

Parameters:

values -

writeToRowValues

public void writeToRowValues(RowValues values,
                             boolean excludeReadonlyData)

Writes object data to a single row.

• SingleLineBulkEntity: writes entity fields.
• BulkEntityIdentifier: writes identifier fields (Id, status etc.)

Parameters:

values -

write

public void write(BulkObjectWriter rowWriter,
                  boolean excludeReadonlyData)
           throws IOException

Writes object data to consecutive rows.

• SingleLineBulkEntity: writes entity.
• MultilineBulkEntity: writes child entities.
• BulkEntityIdentifier: writes identifier information (Id, status etc.)

Parameters:

rowWriter -

Throws:

IOException

canEncloseInMultilineEntity

public boolean canEncloseInMultilineEntity()

encloseInMultilineEntity

public MultiRecordBulkEntity encloseInMultilineEntity()