Curator: Curator

In j2scode/nlpStudio: Natural Language Processing Environment

Description

Curator Class responsible for building, validating and executing queries into objects that manage history or states of other objects. Concretely, this class manages queries into Historian and StateManager objects.

Usage

Curator

Arguments

className	Character string containing the class to which the query objects belong.
objectName	Character string containing the name of the object being queried.
dateFrom	ISO or 8601 formatted date indicating the date from which data should be returned.
dateTo	ISO or 8601 formatted date indicating the date to which data should be returned.
lastN	Numeric indicating the last N minutes, hours, days weeks or months for which data should be returned. Values will be rounded to nearest integer.
unit	Character string indicating the unit of time associated with the lastN variable. Valid values include c("min", "hour", "day", "week", "month")

Format

An object of class R6ClassGenerator of length 24.

Details

Curator Methods: The Curator methods are as follows:

• initialize(target)Initializes a Curator object for the target object.

• buildQuery()Builds the query for the target object.

• submitQuery()Submits the query to the target object.

• getQuery()Returns the query to the calling method.

Getter/Setter Methods: The query can be built, parameter at a time with the following getter/setter methods

• classNameGetter/setter method for the classNsme query parameter.

• objectNameGetter/setter method for the objectName query parameter.

• dateFromGetter/setter method for the dateFrom query parameter.

• dateToGetter/setter method for the dateTo query parameter.

• lastNGetter/setter method for the lastN query parameter.

• unitGetter/setter method for the unit query parameter.

Author(s)

John James, [e-mail]

j2scode/nlpStudio documentation built on May 9, 2019, 12:54 p.m.