Document: Document
In j2scode/nlpStudio: Natural Language Processing Environment

Description Usage Arguments Format Details Author(s) See Also

Document An abstract class that defines the interfaces and primary methods for the DocumentText, DocumentRdata, DocumentCsv, and DocumentXlsx sub classes.

Document

`name`	Character string indicating the name of the document or file. Required for all objects.
`desc`	Character string containing the description of the document.
`content`	Nested list of content to be written to files.
`fileName`	Character string indicating File object's file name.
`parent`	An object of the Lab or DocumentCollection class that represents the parent object.
`visitor`	An object of one of the visitor classes.
`stateId`	Character string that uniquely identifies an object and its state at a specific point in time.

An object of class R6ClassGenerator of length 24.

Document Family of Classes Overview:

The Document family of classes is an implementation of the composite pattern documented in the book "Design Patterns: Elements of Reusable Object-Oriented Software" by Erich Gamma, Richard Helm, Ralph Johnson and John Vlissides (hence Gang of Four). This pattern allows composite and individual objects to be treated uniformly.

The following sections include:

Class Participants: Classes the comprise this composite pattern.
Class Collaborators: Classes which interact with the Document0 class.
Class Methods: Methods included in the interface.

Document Family of Classes Participants: The participants of the Document0 class are:

Document0: This component class specifies an abstract interface for all leaf and composite document classes.
DocumentCollection: The composite class that maintains the hierarchical structure of document collections (composites) and individual documents (leafs).
Document: This "abstract leaf" class defines the interface for DocumentText, DocumentRdata, DocumentCsv, and DocumentXlsx sub-classes.
DocumentText: This "concrete leaf" class for text documents.
DocumentCsv: This "concrete leaf" class for csv documents.
DocumentRdata: This "concrete leaf" class for RData documents.
DocumentXlsx: This "concrete leaf" class for excel documents.

Document Class Collaborators: The collaborators of the Document family are:

State: Class responsible for saving current and restoring prior states of objects.
Curator: Class responsible for maintaining the object hierarchy.
Historian: Class responsible for maintaining the history of events on objects.
Reader: Class responsible for initiating the document read operation.
Writer: Class responsible for initiating the document write operation.
VReader: Visitor class responsible for performing read operations through the Document hierarchy.
VWriter: Visitor class responsible for performing write operations through the Document hierarchy.
VCurator: Visitor class that fulfills commands from the Curator class.

Document Methods: There are six types of methods within the Document 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 to prior object states.
Visitor Methods: Methods for implementation of and messaging with objects of the visitor classes.

Document Core Methods:

new(name, desc)Method for instantiating a document
getName()Method for obtaining the document name.
exposeObject(requester)Method for obtaining the document data in a list format if invoked by authorized method.
restore(requester, prior)Method for restoring an object to a prior state, as per the object parameter.
addContent(content)Method for adding content to the document object. This method is invoked by the read visitor.

Document 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 inherited from the Document0 class.

Document Composite Methods:

addChild(document)Not implemented for this class.
getChildren()Returns NULL.
removeChild(document)Not implemented for this class.
parent()Getter/Setter method for retrieving and changing the parent of a Document class object.

Document State Methods:

saveState()Method that initiates the process of saving the current state of the object. This method is inherited from the Document0 class.
restoreState()Method that initiates the process of restoring an object to a prior state. This method is inherited from the Document0 class.

Document Visitor Methods: