R/SortField.r

In naturalis/nbaR: R Package Client for the Netherlands Biodiversity API

# Netherlands Biodiversity API
#
# Access to the digitised Natural History collection at the Naturalis Biodiversity Center
#
# OpenAPI spec version: v2
# Contact: support@naturalis.nl
# Generated by: https://github.com/swagger-api/swagger-codegen.git

#'
#' @docType class
#'
#' @format R6 class
#'
#' @usage
#' # SortField$new()
#'
#' @format
#' R6 class
#'
#' @title SortField Class
#'
#' @description
#' For more information on the NBA object model, please refer to the
#' official NBA documentation at
#' \href{https://docs.biodiversitydata.nl}{https://docs.biodiversitydata.nl} and
#' the NBA model and endpoints reference at
#' \href{https://docs.biodiversitydata.nl/endpoints-reference}{https://docs.biodiversitydata.nl/endpoints-reference}.
#'
#' @details Model class for SortField objects.
#'
#'
#' @field path  character
#'
#' @field sortOrder  character
#'
#' @field ascending  logical
#'
#'
#'
#' @section Methods:
#' \describe{
#'
#' \item{\code{$new()}}{
#'
#'   Constructor SortField object.
#'
#' }
#' \item{\code{$fromList(SortFieldList)}}{
#'
#'   Create SortField object from list.
#'
#' }
#'
#' \item{\code{$toList()}}{
#'
#'   Get list representation of SortField.
#'
#' }
#' \item{\code{fromJSONString(SortFieldJson)}}{
#'
#'   Create SortField object from JSON.
#'
#' }
#' \item{\code{toJSONString(pretty=TRUE)}}{
#'
#'   Get JSON representation of SortField.
#'
#' }
#' }
#' @importFrom R6 R6Class
#' @importFrom jsonlite fromJSON toJSON
#' @export
SortField <- R6::R6Class(
  "SortField",
  public = list(
    `path` = NULL,
    `sortOrder` = NULL,
    `ascending` = NULL,
    initialize = function(
                              `path`,
                              `sortOrder`,
                              `ascending`) {
      if (!missing(`path`)) {
        self[["path"]] <- `path`
      }
      if (!missing(`sortOrder`)) {
        stopifnot(
          is.character(`sortOrder`),
          length(`sortOrder`) == 1
        )
        self[["sortOrder"]] <- `sortOrder`
      }
      if (!missing(`ascending`)) {
        self[["ascending"]] <- `ascending`
      }
    },
    toList = function() {
      SortFieldList <- list()
      if (!is.null(self[["path"]])) {
        SortFieldList[["path"]] <-
          self[["path"]]
      }
      if (!is.null(self[["sortOrder"]])) {
        SortFieldList[["sortOrder"]] <-
          self[["sortOrder"]]
      }
      if (!is.null(self[["ascending"]])) {
        SortFieldList[["ascending"]] <-
          self[["ascending"]]
      }
      ## omit empty nested lists in returned list
      SortFieldList[vapply(
        SortFieldList,
        length,
        FUN.VALUE = integer(1)
      ) > 0]
    },
    fromList = function(SortFieldList,
                            typeMapping = NULL) {
      self[["path"]] <-
        SortFieldList[["path"]]
      self[["sortOrder"]] <-
        SortFieldList[["sortOrder"]]
      self[["ascending"]] <-
        SortFieldList[["ascending"]]
      invisible(self)
    },
    toJSONString = function(pretty = TRUE) {
      jsonlite::toJSON(
        self$toList(),
        simplifyVector = TRUE,
        auto_unbox = TRUE,
        pretty = pretty
      )
    },
    fromJSONString = function(SortFieldJson,
                                  typeMapping = NULL) {
      SortFieldList <- jsonlite::fromJSON(
        SortFieldJson,
        simplifyVector = FALSE
      )
      self <- self$fromList(SortFieldList)
      invisible(self)
    },
    print = function(...) {
      ## print class name
      cat("<SortField>\n")
      ## print all members with values
      cat("Fields:\n")
      if (typeof(self$path) == "environment") {
        cat("\tpath:\tobject of class", paste0("<", class(self$path)[1], ">"), "\n")
      }
      else if (typeof(self$path) == "list") {
        cat("\tpath:\tlist of length", length(self$path), "\n")
      }
      else {
        cat("\tpath:\t", self$path, "\n")
      }
      if (typeof(self$sortOrder) == "environment") {
        cat("\tsortOrder:\tobject of class", paste0("<", class(self$sortOrder)[1], ">"), "\n")
      }
      else if (typeof(self$sortOrder) == "list") {
        cat("\tsortOrder:\tlist of length", length(self$sortOrder), "\n")
      }
      else {
        cat("\tsortOrder:\t", self$sortOrder, "\n")
      }
      if (typeof(self$ascending) == "environment") {
        cat("\tascending:\tobject of class", paste0("<", class(self$ascending)[1], ">"), "\n")
      }
      else if (typeof(self$ascending) == "list") {
        cat("\tascending:\tlist of length", length(self$ascending), "\n")
      }
      else {
        cat("\tascending:\t", self$ascending, "\n")
      }
      ## print all methods
      cat("Methods:\n")
      cat("\tfromJSONString\n")
      cat("\ttoJSONString\n")
      cat("\tfromList\n")
      cat("\ttoList\n")
      cat("\tprint\n")
      invisible(self)
    }
  )
)