com.datastax.oss.dsbulk.connectors.api

Class DefaultErrorRecord

java.lang.Object

com.datastax.oss.dsbulk.connectors.api.DefaultErrorRecord

All Implemented Interfaces:

ErrorRecord, Record

public class DefaultErrorRecord
extends Object
implements ErrorRecord

A record that could not be fully parsed from its source.

Constructor Summary

Constructors

Constructor and Description
DefaultErrorRecord(Object source, URI resource, long position, Throwable error) Creates a new error record.

Method Summary

Modifier and Type	Method and Description
void	clear() Clear all fields in this record.
Set<Field>	fields() Returns a set containing all the fields in this record.
Throwable	getError() Returns the error that prevented this record from being processed.
Object	getFieldValue(Field field) Returns the value associated with the given field.
long	getPosition() Returns the record's position inside its resource, typically the line number if the resource is a file, or the row number, if the resource is a database table.
URI	getResource() Returns the record's resource location, typically the file or database table where it was extracted from.
Object	getSource() Returns the record source, typically a line in a file or a row in a database table.
Collection<Object>	values() Returns a collection containing all the values in this record.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultErrorRecord

public DefaultErrorRecord(@Nullable
                          Object source,
                          @NonNull
                          URI resource,
                          long position,
                          @NonNull
                          Throwable error)

Creates a new error record.

Parameters:

source - the record's source; may be null if the source cannot be determined or should not be retained.

resource - the record's resource.

position - the record's position.

error - the error.

Method Detail

getSource

@Nullable
public Object getSource()

Description copied from interface: Record

Returns the record source, typically a line in a file or a row in a database table.

Specified by:

getSource in interface Record

Returns:

The record source; may be null if the source cannot be determined or should not be retained.

getResource

@NonNull
public URI getResource()

Description copied from interface: Record

Returns the record's resource location, typically the file or database table where it was extracted from.

Details about the returned URI, and in particular its scheme, are implementation-specific.

Specified by:

getResource in interface Record

Returns:

The record's resource.

getPosition

public long getPosition()

Description copied from interface: Record

Returns the record's position inside its resource, typically the line number if the resource is a file, or the row number, if the resource is a database table.

Note that in the case of a file, the record's position is not necessarily equal to the line number where it appears. First, if there is one or more header lines, the actual line number would be its position + the number of header lines. Moreover, it the resource contains multi-line records, then it is not possible to draw a direct relationship between the record's position and its line.

Positions should be 1-based, i.e., the first record in the resource has position 1, and so on. If the position cannot be determined, this method should return -1.

Specified by:

getPosition in interface Record

Returns:

the record's position, or -1 if the position cannot be determined.

fields

@NonNull
public Set<Field> fields()

Description copied from interface: Record

Returns a set containing all the fields in this record.

Specified by:

fields in interface Record

Returns:

a set containing all the fields in this record.

values

@NonNull
public Collection<Object> values()

Description copied from interface: Record

Returns a collection containing all the values in this record.

The iteration order of this collection should match that of Record.fields().

Specified by:

values in interface Record

Returns:

a collection containing all the values in this record.

getFieldValue

public Object getFieldValue(@NonNull
                            Field field)

Description copied from interface: Record

Returns the value associated with the given field.

Note that a return value of null may indicate that the record contains no such field, or that the field value was null.

Specified by:

getFieldValue in interface Record

Parameters:

field - the field.

Returns:

the value associated with the given field.

clear

public void clear()

Description copied from interface: Record

Clear all fields in this record.

This method should be used to free memory, when this record's fields have been successfully processed and are no longer required.

Specified by:

clear in interface Record

getError

@NonNull
public Throwable getError()

Description copied from interface: ErrorRecord

Returns the error that prevented this record from being processed.

Specified by:

getError in interface ErrorRecord

Returns:

the error that prevented this record from being processed.