R/ExplorerTree.R

In DavidBarke/shinyExplorer: Explorer and Contextmenu for Shiny apps

#' Explorer Tree
#'
#' @section Methods:
#' \describe{
#'   \item{\code{new(root_id = NULL, root_object = Object$new("/"))}}{Initialize a new explorer tree object.
#'     \tabular{ll}{
#'       \code{root_id} \tab Identifier of the root node. If \code{\link[base]{NULL}},
#'       this identifier is created internally.
#'     }
#'     Return: Object of class \code{ExplorerTree}.
#'   }
#'   \item{\code{get_node(id)}}{Get the node of the explorer tree with \code{id == id}.
#'   }
#'   \item{\code{get_node_ids()}}{Get the ids of all nodes of the explorer tree as a
#'     \code{\link[base]{character}} vector.
#'   }
#'   \item{\code{get_root_node()}}{Get the root node of the explorer tree, which is equivalent
#'     to calling \code{this$get_node(root_id)}, where \code{root_id} is the id, which was
#'     passed to \code{this$new}.
#'   }
#' }
#'
#' @name ExplorerTree
NULL

#' @export
ExplorerTree <- R6::R6Class(
  classname = "ExplorerTree",
  public = list(
    initialize = function(root_id = NULL, root_object = Object$new("/")) {
      private$node_storage <- ObjectStorage$new(allowed_classes = "ExplorerNode")

      private$root <- ExplorerNode$new(
        id = root_id,
        node_storage = private$node_storage,
        object = root_object
      )

      private$node_storage$add_object(private$root)

      return(self)
    },

    get_node = function(id) {
      if (!(id %in% private$node_storage$get_ids())) {
        stop(
          paste(
            "ExplorerTree: There is no node with id", id,
            "in the explorer tree."
          )
        )
      }

      private$node_storage$get_object(id)
    },

    get_node_ids = function() {
      private$node_storage$get_ids()
    },

    get_root_node = function() {
      private$root
    }
  ),
  private = list(
    node_storage = NULL,
    root = NULL
  )
)