Package org.openrefine.model

Class RowInRecordMapper

java.lang.Object

org.openrefine.model.RowInRecordMapper

All Implemented Interfaces:

Serializable, RecordMapper, RowMapper

Direct Known Subclasses:

ExpressionBasedOperation.NegativeRowMapper, ExpressionBasedOperation.PositiveRowMapper

public abstract class RowInRecordMapper
extends Object
implements RowMapper, RecordMapper

Like RowMapper except that the enclosing Record is also available. This defines a RecordMapper which maps each row accordingly. When used as a RowMapper, the record argument is set to null. This class is useful when performing a row-wise operation in records mode, as the enclosing record must be available in the expression language.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static RowInRecordMapper	IDENTITY

Constructor Summary

Constructors

Constructor	Description
RowInRecordMapper()

Method Summary

Modifier and Type	Method	Description
Row	call(long rowId, Row row)
List<Row>	call(Record record)	Maps a record to a list of rows.
abstract Row	call(Record record, long rowId, Row row)	Maps a row, in the context of a record.
static RowInRecordMapper	fromRowMapper(RowMapper rowMapper)
abstract boolean	preservesRecordStructure()	Is this mapper guaranteed to preserve the records structure, both as a record mapper and a row mapper?
boolean	preservesRowCount()	If every record is mapped to a list with the same number of rows as what the record contains, set this boolean to true.

Methods inherited from class java.lang.Object

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

Field Detail

IDENTITY

public static final RowInRecordMapper IDENTITY

Constructor Detail

RowInRecordMapper

public RowInRecordMapper()

Method Detail

call

public abstract Row call(Record record,
                         long rowId,
                         Row row)

Maps a row, in the context of a record.

Parameters:

record - the record enclosing the row to map

rowId - the global index of the row in the entire grid

row - the row itself

preservesRecordStructure

public abstract boolean preservesRecordStructure()

Is this mapper guaranteed to preserve the records structure, both as a record mapper and a row mapper?

Specified by:

preservesRecordStructure in interface RecordMapper

Specified by:

preservesRecordStructure in interface RowMapper

call

public List<Row> call(Record record)

Description copied from interface: RecordMapper

Maps a record to a list of rows. The rows may not form a single record, unless RecordMapper.preservesRecordStructure() is true.

Specified by:

call in interface RecordMapper

preservesRowCount

public boolean preservesRowCount()

Description copied from interface: RecordMapper

If every record is mapped to a list with the same number of rows as what the record contains, set this boolean to true. This helps the underlying implementation avoid recomputing row ids.

Specified by:

preservesRowCount in interface RecordMapper

call

public Row call(long rowId,
                Row row)

Specified by:

call in interface RowMapper

fromRowMapper

public static RowInRecordMapper fromRowMapper(RowMapper rowMapper)