Package org.openrefine.operations.cell

Class MultiValuedCellJoinOperation

  • All Implemented Interfaces:
    Operation
    public class MultiValuedCellJoinOperation
extends Object
implements Operation
    Within a record, joins the non-blank cells of a column into the first cell, with the specified separator. The keyColumnName can be used to specify which column should be treated as record key (although this parameter has never been exposed in the UI as of 2020-05).
    Author:
    Antonin Delpeuch

    • Field Detail

      • _columnName

        protected final String _columnName

      • _keyColumnName

        protected final String _keyColumnName

      • _separator

        protected final String _separator

    • Constructor Detail

      • MultiValuedCellJoinOperation

        public MultiValuedCellJoinOperation​(String columnName,
                                    String keyColumnName,
                                    String separator)

    • Method Detail

      • apply

        public ChangeResult apply​(Grid projectState,
                          ChangeContext context)
                   throws OperationException
        Description copied from interface: Operation
        Derives the new grid state from the current grid state. Executing this method should be quick (even on large datasets) since it is expected to just derive the new grid from the existing one without actually executing any expensive computation. Long-running computations should rather go in the derivation of a ChangeData which will be fetched asynchronously.
        Specified by:
        apply in interface Operation
        Parameters:
        projectState - the state of the grid before the change
        Returns:
        an object which bundles up various pieces of information produced by the operation: primarily, the new grid after applying the operation. This object can be subclassed to expose more information, which should be serializable with Jackson so that it reaches the frontend.
        Throws:
        OperationException - when the change cannot be applied to the given grid

      • getColumnName

        public String getColumnName()

      • getKeyColumnName

        public String getKeyColumnName()

      • getSeparator

        public String getSeparator()

      • getDescription

        public String getDescription()
        Description copied from interface: Operation
        A short human-readable description of what this operation does.
        Specified by:
        getDescription in interface Operation

      • recordMapper

        protected static RecordMapper recordMapper​(int columnIdx,
                                           String separator)