R/CopyFileSet.R

In DecisionScients/NLPStudio: Natural Language Processing in Objected Oriented R Environment

#------------------------------------------------------------------------------#
#                               CopyFileSet                                    #
#------------------------------------------------------------------------------#
#' CopyFileSet
#'
#' \code{CopyFileSet} Encapsulates the command to copy a FileSet object.
#'
#' @param to Director into which the FileSet should be moved.
#' @param fileStudio FileStudio object
#'
#' @docType class
#' @author John James, \email{jjames@@dataScienceSalon.org}
#' @family FileStudio Command Classes
#' @export
CopyFileSet <- R6::R6Class(
  classname = "CopyFileSet",
  lock_objects = FALSE,
  lock_class = FALSE,
  inherit = Cmd0,

  private = list(
    ..to = character(),
    ..fileStudio = character(),
    ..name = character()
  ),

  public = list(
    initialize = function(fileStudio, to, name = NULL) {

      private$loadServices(name = 'CopyFileSet')

      # Validation
      private$..params <- list()
      private$..params$classes$name <- list('fileStudio')
      private$..params$classes$objects <- list(fileStudio)
      private$..params$classes$valid <- list('FileStudio')
      v <- private$validator$validate(self)
      if (v$code == FALSE) {
        private$logR$log( method = 'initialize', event = v$msg, level = 'Error')
        stop()
      }

      private$..to <- to
      private$..fileStudio <- fileStudio
      private$..name <- name

      invisible(self)
    },

    getReceiver = function() private$..fileStudio,
    getInputClass = function() return('FileSet'),
    getOutputClass = function() return('FileSet'),

    execute = function(x) {

      fileSet <- private$..fileStudio$copy(x, to = private$..to, name = private$..name)
      return(fileSet)
    }
  )
)