RomPropertyTree: Nested Property Object

In HARPgroup/hydro-tools: Data processing and accessors for VAHydro

Nested Property Object

Description

Object for storing a property and all of its sub-properties.

Details

Has standard methods for managing data and meta data. This object class will use a recursive query to navigate a graph style database (e.g. VA Hydro) to get the requested property and all first-, second-, etc. order proerpties below it.

Value

Instance of type RomPropertyTree

Super class

hydrotools::RomDataGroup -> RomPropertyTree

Public fields

base_entity_type

kind of entity

pk_name

the name of this entity's pk column, always root_pid

prop_list

The raw property rows returned. This will contain all subproperties of the property requested upon initialization of this instance

mps

linked features

geom

feature geometry WKT

sql_select_from

Enhanced form of query overrides default SQL guess from hydrotools:::fn_guess_sql(). This will use a recurvsive query to get property and all subproperties

Methods

Public methods

• RomPropertyTree$new()

• RomPropertyTree$get_id()

• RomPropertyTree$to_list()

• RomPropertyTree$from_list()

• RomPropertyTree$save()

• RomPropertyTree$load_data()

• RomPropertyTree$clone()

Inherited methods

• hydrotools::RomDataGroup$get_vardef()
• hydrotools::RomDataGroup$handle_config()
• hydrotools::RomDataGroup$load_plugin()

---

Method new()

Usage

RomPropertyTree$new(datasource = NULL, config, load_remote = FALSE)

Arguments

datasource

RESTful repository object

config

list of attributes to set, see also: to_list() for format. These should contain identifying information about the requested property and will ultimatley be passed to RomDataGroup$new() and to RomDataSource$get()

load_remote

automatically query REST dataa source for matches?

Returns

object instance of RomPropertyTree, populated with details of requested property and all subproperties (in propvalues())

---

Method get_id()

Usage

RomPropertyTree$get_id()

Returns

get_id the unique id of this entity alias to remote pkid, subclassed as function

---

Method to_list()

Usage

RomPropertyTree$to_list()

Returns

list of object attributes suitable for input to new() and from_list() methods

---

Method from_list()

Usage

RomPropertyTree$from_list(config)

Arguments

config

list of properties to set, see also: to_list() for format

Returns

NULL

---

Method save()

Usage

RomPropertyTree$save(push_remote = FALSE)

Arguments

push_remote

update locally only or push to remote database

Returns

NULL

---

Method load_data()

Usage

RomPropertyTree$load_data(config, load_remote)

Arguments

config

list of properties from RomDataGroup$new()

load_remote

automatically query remote data source for matches?

Returns

Nothing, but will set the properties on this instance of RomPropertyTree with appropriate variable definitions in prop_list() and propvalues() via self$datasource$set_prop()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

RomPropertyTree$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

See Also

NA

Examples

NA

HARPgroup/hydro-tools documentation built on July 4, 2025, 11:05 a.m.