Template: Template
In DataScienceSalon/NLPStudio1: Natural Language Processing Environment
Description
Usage
Format
Details
Class participants and collaborators
Class methods
Author(s)
Description
Template Template for class definitions
Usage
1
Format
An object of class R6ClassGenerator of length 24.
Details
More descriptive text
Class participants and collaborators
Family of Classes Participants:
The participants of the ... class are:
Template: This component class specifies an abstract interface
for all leaf and composite document classes.
Family of Classes Collaborators:
The collaborators of the .... family are:
Lab: Class responsible for document collections.
Class methods
Template Methods:
There are six types of methods within the Template class and they are:
Core Methods: Core methods shared by both Document and
DocumentCollection objects.
Getter/Setter Methods: Active binding methods for getting and setting
selected private members.
Composite Methods: Methods implemented by the DocumentCollection
class to maintain the document heirarchy.
State Methods: Methods for saving current and restoring prior states of objects .
Visitor Methods: Methods for implementation of and messaging
with objects of the visitor classes.
Template Core Methods:
new(name, desc)Base method for instantiating
an object of the Document or DocumentCollection classes.
Specific behaviors implemented in the subclasses.
getName()Returns the name of the current object.
exposeObject(requester)Base method for returning the elements of the current object if invoked by an authorized method.
restore(requester, prior)Base method for restoring an object
to a prior state, as per the object parameter.
Template Field Getter/Setter Active Binding Methods:
desc()Method used to get / set the description variable.
Implemented as an active binding and so the field may be updated
by assignment. This method is concrete and inherited by sub-classes.
Template Composite Methods:
addChild(document)Base method for adding documents to a
collection. Specific behaviors implemented in the DocumentCollection composite
sub-class
getChildren()Base method for retrieving child objects. Specific behaviors
implemented in the DocumentCollection subclass
removeChild(document)Base method for removing documents from
a collection. Specific behaviors implemented in the DocumentCollection composite
sub-class
parent(value)Getter/setter method for the parent field, implemented as an active binding on the private member.
Template State Methods:
saveState()Method for saving the current state of an object to file.
restoreState(prior)Method for restoring an object to a prior state.
Template Visitor Methods:
accept(visitor)Method for accepting the visitor objects. Subclasses override these methods.
Author(s)
John James, jjames@datasciencesalon.org
DataScienceSalon/NLPStudio1 documentation built on May 26, 2019, 7:24 a.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Description Usage Format Details Class participants and collaborators Class methods Author(s)
Description
Template Template for class definitions
Usage
1 |
Format
An object of class R6ClassGenerator of length 24.
Details
More descriptive text
Class participants and collaborators
Family of Classes Participants: The participants of the ... class are:
Template: This component class specifies an abstract interface for all leaf and composite document classes.
Family of Classes Collaborators: The collaborators of the .... family are:
Lab: Class responsible for document collections.
Class methods
Template Methods: There are six types of methods within the Template class and they are:
Core Methods: Core methods shared by both Document and DocumentCollection objects.
Getter/Setter Methods: Active binding methods for getting and setting selected private members.
Composite Methods: Methods implemented by the DocumentCollection class to maintain the document heirarchy.
State Methods: Methods for saving current and restoring prior states of objects .
Visitor Methods: Methods for implementation of and messaging with objects of the visitor classes.
Template Core Methods:
new(name, desc)Base method for instantiating an object of the Document or DocumentCollection classes. Specific behaviors implemented in the subclasses.getName()Returns the name of the current object.exposeObject(requester)Base method for returning the elements of the current object if invoked by an authorized method.restore(requester, prior)Base method for restoring an object to a prior state, as per the object parameter.
Template Field Getter/Setter Active Binding Methods:
desc()Method used to get / set the description variable. Implemented as an active binding and so the field may be updated by assignment. This method is concrete and inherited by sub-classes.
Template Composite Methods:
addChild(document)Base method for adding documents to a collection. Specific behaviors implemented in the DocumentCollection composite sub-classgetChildren()Base method for retrieving child objects. Specific behaviors implemented in the DocumentCollection subclassremoveChild(document)Base method for removing documents from a collection. Specific behaviors implemented in the DocumentCollection composite sub-classparent(value)Getter/setter method for the parent field, implemented as an active binding on the private member.
Template State Methods:
saveState()Method for saving the current state of an object to file.restoreState(prior)Method for restoring an object to a prior state.
Template Visitor Methods:
accept(visitor)Method for accepting the visitor objects. Subclasses override these methods.
Author(s)
John James, jjames@datasciencesalon.org
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.