State: State
In j2scode/NLPStudio: Natural Language Processing Environment

Description Usage Arguments Format Details Author(s) See Also

State This class takes receives query, save, and restore requests from client applications and visitor methods, validates the request, and dispatches the appropriate visitor class for fullfillment.

State

`dateFrom`	A parameter of the query method. An ISO 8601 formatted date indicating the date from which states should be returned.
`dateTo`	A parameter of the query method. An ISO 8601 formatted date indicating the date to which states should be returned.
`class`	A parameter of the query method. A character string indicating the class of state objects that should be returned.
`objectName`	A parameter of the query method. A character string indicating the object for which states should be returned.
`object`	A serializable object to be serialized or deserialized.

An object of class R6ClassGenerator of length 24.

The State class is a participant of the State family of classes.

State Family of Classes Overview: The State family of classes is responsible for object persistence and data recovery in the NLPStudio package and is comprised of the following participants.

State Class Family Participants:

State: This class oversees the process of saving, restoring and querying states. It takes requests from client applications and dispatches instantiates the appropriate visitor to fulfill the request. This class also provides state query functionality.
Curator: This class oversees the process of restoring a composite to a prior state.
StateManager: This class has a persistent single object that receives a save/restore request from a visitor, keeps track of the saved states, and their locations, and dispatches the appropriate save/restore method within the State class to serialize or deserialize the object.
StateServer: This class is responsible for serializing and deserializing object states.

State Class Methods: The following methods are defined for this class:

new(): Method for instantiating objects of the State class. Obtains the list of serializeable classes for validation puroses.
query(dateFrom, dateTo, class, objectName): Method for quering the saved states. Returns a list of states matching the query parameters.
save(object): Method for saving the state of a serializable object. This method invokes the accept method on the object which dispatches the appropriate save visitor.
restore(object): Method for restoring an the designated object to the state identified by the stateId parameter. The method invokes the accept method on the object, which dispatches the appropriate restore visitor to obtain the prior state, then invokes the Curator to return the composite to the prior state