com.datastax.oss.dsbulk.connectors.api

Class DefaultRecord

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<K,V>

java.util.LinkedHashMap<Field,Object>

com.datastax.oss.dsbulk.connectors.api.DefaultRecord

All Implemented Interfaces:

Record, Serializable, Cloneable, Map<Field,Object>

public class DefaultRecord
extends LinkedHashMap<Field,Object>
implements Record

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Constructor Summary

Constructors

Constructor and Description
DefaultRecord(Object source, URI resource, long position) Creates an empty record.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
Set<Field>	fields() Returns a set containing all the fields in this record.
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.
int	hashCode()
static DefaultRecord	indexed(Object source, URI resource, long position, Object... values) Creates an indexed record with the given values.
static DefaultRecord	mapped(Object source, URI resource, long position, Field[] keys, Object... values) Creates a mapped record with the given keys and values.
static DefaultRecord	mapped(Object source, URI resource, long position, Map<? extends Field,?> values) Creates a mapped record with the given map of keys and values.
void	setFieldValue(Field field, Object value) Sets the value associated with the given field.
String	toString()
Collection<Object>	values() Returns a collection containing all the values in this record.

Methods inherited from class java.util.LinkedHashMap

clear, containsValue, entrySet, forEach, get, getOrDefault, keySet, removeEldestEntry, replaceAll

Methods inherited from class java.util.HashMap

clone, compute, computeIfAbsent, computeIfPresent, containsKey, isEmpty, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, size

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.datastax.oss.dsbulk.connectors.api.Record

clear

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, containsKey, isEmpty, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, size

Constructor Detail

DefaultRecord

public DefaultRecord(@Nullable
                     Object source,
                     @NonNull
                     URI resource,
                     long position)

Creates an empty record.

Parameters:

source - the record source (its original form); may be null if the source cannot be determined or should not be retained.

resource - the record resource (where it comes from: file, database, etc).

position - the record position inside the resource (line number, etc.).

Method Detail

indexed

public static DefaultRecord indexed(@Nullable
                                    Object source,
                                    @NonNull
                                    URI resource,
                                    long position,
                                    Object... values)

Creates an indexed record with the given values.

Parameters:

source - the record source (its original form); may be null if the source cannot be determined or should not be retained.

resource - the record resource (where it comes from: file, database, etc).

position - the record position inside the resource (line number, etc.).

values - the record values.

Returns:

an indexed record.

mapped

public static DefaultRecord mapped(@Nullable
                                   Object source,
                                   @NonNull
                                   URI resource,
                                   long position,
                                   Field[] keys,
                                   Object... values)

Creates a mapped record with the given keys and values.

Parameters:

source - the record source (its original form); may be null if the source cannot be determined or should not be retained.

resource - the record resource (where it comes from: file, database, etc).

position - the record position inside the resource (line number, etc.).

keys - the record keys.

values - the record values.

Returns:

a mapped record.

mapped

public static DefaultRecord mapped(@Nullable
                                   Object source,
                                   @NonNull
                                   URI resource,
                                   long position,
                                   Map<? extends Field,?> values)

Creates a mapped record with the given map of keys and values.

Parameters:

source - the record source (its original form); may be null if the source cannot be determined or should not be retained.

resource - the record resource (where it comes from: file, database, etc).

position - the record position inside the resource (line number, etc.).

values - the record keys and values.

Returns:

a mapped record.

getSource

@NonNull
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

Specified by:

values in interface Map<Field,Object>

Overrides:

values in class LinkedHashMap<Field,Object>

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.

setFieldValue

public void setFieldValue(@NonNull
                          Field field,
                          Object value)

Sets the value associated with the given field.

Parameters:

field - the field to set.

value - The value to set.

toString

public String toString()

Overrides:

toString in class AbstractMap<Field,Object>

equals

public boolean equals(Object o)

Specified by:

equals in interface Map<Field,Object>

Overrides:

equals in class AbstractMap<Field,Object>

hashCode

public int hashCode()

Specified by:

hashCode in interface Map<Field,Object>

Overrides:

hashCode in class AbstractMap<Field,Object>