Interface Operation

    • Method Detail

      • apply

        ChangeResult apply​(Grid projectState,
                           ChangeContext context)
                    throws OperationException
        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.
        projectState - the state of the grid before the change
        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.
        OperationException - when the change cannot be applied to the given grid
      • getDescription

        String getDescription()
        A short human-readable description of what this operation does.
      • isReproducible

        default boolean isReproducible()
        Could this operation be meaningfully re-applied to another project, or is it too specific to the data in this project? Operations which affect a single row or cell designated by a row index should return false, indicating that they are small fixes that should likely not be part of a reusable pipeline.
      • getOperationId

        default String getOperationId()