Main Page | Modules | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members | Related Pages

YadaGrammar Class Reference
[YadaConfiguration - managing configurations]

Inheritance diagram for YadaGrammar:

Inheritance graph
[legend]
Collaboration diagram for YadaGrammar:

Collaboration graph
[legend]
List of all members.

Detailed Description

YadaGrammar - bundled information about a CDG grammar

Author:
Michael Daum
Id
YadaGrammar.tcl,v 1.24 2004/10/15 17:24:37 micha Exp

Definition at line 19 of file YadaGrammar.tcl.

Public Member Functions

 clone (TclList args)
 deleteWordgraphs ()
 displayTitle ()
 fromDOM (domNode rootNode)
 getPersistanceFileName ()
 getSelection ()
 getWordgraph (TclString wgName)
 getWordgraphs ()
 hasSavedState ()
 isModified ()
 isUpToDate ()
 load ()
 persistenceFileInSync ()
 rescan ()
 resetModified ()
 save ()
 scan ()
 setModified ()
 setSelection (TclList args)
 setWordgraph (YadaWordgraph wordgraph)
 toDOM ()

Public Attributes

TclList files = {}
TclRef name

Protected Attributes

TclNumber _modified = 0

Private Member Functions

 YadaGrammar (TclList args)
 ~YadaGrammar ()

Private Attributes

TclNumber _isUpToDate = 0
TclRef _selected
TclString _selection = ""
TclArray _wordgraphs


Constructor & Destructor Documentation

YadaGrammar::YadaGrammar TclList  args  )  [private]
 

constructor

Definition at line 67 of file YadaGrammar.tcl.

YadaGrammar::~YadaGrammar  )  [private]
 

destructor

Definition at line 76 of file YadaGrammar.tcl.


Member Function Documentation

YadaGrammar::clone TclList  args  ) 
 

clone

Definition at line 338 of file YadaGrammar.tcl.

YadaGrammar::deleteWordgraphs  ) 
 

deleteWordgraphs

Definition at line 153 of file YadaGrammar.tcl.

YadaConfigItem::displayTitle  )  [inherited]
 

Displays title in main window (reflecting modification state of document).

Definition at line 128 of file YadaConfigItem.tcl.

YadaGrammar::fromDOM domNode  rootNode  ) 
 

Initialize Object with DOM node (that has saved the object state)

Parameters:
rootNode root DOM-Node (Tag <yada>)

Reimplemented from YadaConfigItem.

Definition at line 122 of file YadaGrammar.tcl.

YadaGrammar::getPersistanceFileName  )  [virtual]
 

Getting unique file name from registry.

Implements YadaConfigItem.

Definition at line 412 of file YadaGrammar.tcl.

YadaGrammar::getSelection  ) 
 

getSelection

Definition at line 331 of file YadaGrammar.tcl.

YadaGrammar::getWordgraph TclString  wgName  ) 
 

getWordgraph

Definition at line 176 of file YadaGrammar.tcl.

YadaGrammar::getWordgraphs  ) 
 

getWordgraphs

Definition at line 164 of file YadaGrammar.tcl.

YadaConfigItem::hasSavedState  )  [inherited]
 

Predicate returning 1, if file containing persistant state of YadaGrammar exists, otherwise 0 Definition at line 115 of file YadaConfigItem.tcl.

YadaConfigItem::isModified  )  [inherited]
 

Predicate returning 1, if configuration data has changed, 0 otherwise.

Definition at line 87 of file YadaConfigItem.tcl.

YadaGrammar::isUpToDate  ) 
 

Returns the value of private member variable _isUpToDate.

Definition at line 377 of file YadaGrammar.tcl.

YadaConfigItem::load  )  [inherited]
 

Loads object state from unique file (depends on object name).

Definition at line 66 of file YadaConfigItem.tcl.

YadaGrammar::persistenceFileInSync  ) 
 

Predicate returning 1, if grammar file has been changed since the last saving, otherwise 0 If no persistant state file exists, 1 is returned Definition at line 388 of file YadaGrammar.tcl.

YadaGrammar::rescan  ) 
 

rescan

# for debugging Definition at line 208 of file YadaGrammar.tcl.

YadaConfigItem::resetModified  )  [inherited]
 

Removes modification mark.

Definition at line 105 of file YadaConfigItem.tcl.

YadaConfigItem::save  )  [inherited]
 

Serializes object state to unique file (depends on object name).

Definition at line 45 of file YadaConfigItem.tcl.

YadaGrammar::scan  ) 
 

scan

Definition at line 199 of file YadaGrammar.tcl.

YadaConfigItem::setModified  )  [inherited]
 

Marks item as modified.

Definition at line 94 of file YadaConfigItem.tcl.

YadaGrammar::setSelection TclList  args  ) 
 

setSelection

Definition at line 315 of file YadaGrammar.tcl.

YadaGrammar::setWordgraph YadaWordgraph  wordgraph  ) 
 

setWordgraph registers a YadaWordgraph object Definition at line 188 of file YadaGrammar.tcl.

YadaGrammar::toDOM  ) 
 

Serializes Object into a DOM-XML-Node

Returns:
root DOM node representing the Grammar-Object (root tag <yada>)

Reimplemented from YadaConfigItem.

Definition at line 85 of file YadaGrammar.tcl.


Member Data Documentation

TclNumber YadaGrammar::_isUpToDate = 0 [private]
 

flag indicating whether the grammars _wordgraphs are up to date. If not we reconstruct this array in scan() or rescan(). Definition at line 36 of file YadaGrammar.tcl.

TclRef YadaGrammar::_selected [private]
 

array mapping selection attribute to wordgraph-id

Definition at line 39 of file YadaGrammar.tcl.

TclString YadaGrammar::_selection = "" [private]
 

list of selected wordgraph ids

Definition at line 29 of file YadaGrammar.tcl.

TclArray YadaGrammar::_wordgraphs [private]
 

array mapping wordgraph ids to YadaWordgraph s

Definition at line 32 of file YadaGrammar.tcl.

YadaGrammar::files = {}
 

list of all files making up the grammar

Definition at line 360 of file YadaGrammar.tcl.


The documentation for this class was generated from the following file:
YADA 2.0-alpha (20 Oct 2004)