R/WriteBin.R

In j2scode/nlpStudio: Natural Language Processing Environment

## ---- WriteBin
#==============================================================================#
#                                   WriteBin                                   #
#==============================================================================#
#' WriteBin
#'
#'
#' \code{WriteBin} Class contains the data and methods for writing files in binary format.
#'
#' This class inherits from the Write0 abstract class and provides the data
#' and methods for writing files in binary format.
#'
#' @docType class
#'
#' @section Methods:
#' \describe{
#'  \item{\code{writeData(directory, fileName)}}{Writes the content in binary format in the file path indicated in the document object}
#' }
#'
#' @param content Character vector of binary content to be written.
#' @param name Character string indicating the name of the object to be written,
#' @param path Character string indicating the location of the file to be written.
#'
#' @author John James, \email{j2sdatalab@@gmail.com}
#' @family Document i/o classes
#' @export
WriteBin <- R6::R6Class(
  classname = "WriteBin",
  inherit = Write0,

  public = list(
    writeData = function(name, path, content) {

      # Validate parameters
      if (missing(path)) {
        v <- Validator0$new()
        v$notify(class = "WriteBin", method = "writeData", fieldName = "path",
                 level = "Error", value = "",
                 msg = paste("Unable to write document. Path is missing without a default",
                             "See ?WriteBin for assistance."),
                 expect = TRUE)
        stop()
      }
      v <- ValidatorClass$new()
      if (v$validate(class = "WriteBin", method = "writeData", fieldName = "path",
                 level = "Error", value = path,
                 msg = paste("Unable to write document. Path is not a character string.",
                             "See ?WriteBin for assistance."),
                 expect = "character") == FALSE) {
        stop()
      }

      v <- ValidatorPath$new()
      if (v$validate(class = "WriteBin", method = "writeData", fieldName = "path",
                 level = "Error", value = path,
                 msg = paste("Unable to write document. Path", path, "is invalid.",
                             "See ?WriteBin for assistance."),
                 expect = TRUE) == FALSE) {
        stop()
      }

      if (missing(content)) {
        v <- Validator0$new()
        v$notify(class = "WriteBin", method = "writeData",
                   fieldName = "content", value = "", level = "Error",
                   msg = paste("Unable to write content. Content is missing with no default",
                               "See ?WriteBin for assistance."),
                   expect = TRUE)
        stop()
      }

      v <- ValidatorNotEmpty$new()
      if (v$validate(class = "WriteBin", method = "writeData",
                 fieldName = "content", value = content, level = "Error",
                 msg = paste("Unable to write content. Content must not be empty.",
                             "See ?WriteBin for assistance."),
                 expect = TRUE) == FALSE) {
        stop()
      }


      writeBin(content, path)
    }
  )
)