DLESE Tools
v1.6.0

org.dlese.dpc.schemedit.standards.td
Class TeachersDomainLexicon

java.lang.Object
  extended by org.dlese.dpc.schemedit.standards.td.TeachersDomainLexicon
All Implemented Interfaces:
StandardsDocument

public class TeachersDomainLexicon
extends Object
implements StandardsDocument

Reads a file representing the Teacher's Domain Lexicon XML as a Standards Document (and individual lexicon terms contained within) via the StdDocument and Standard classes. Provides lists of StandardsNodes for use in UI JSP.

Author:
ostwald

Constructor Summary
TeachersDomainLexicon(File source)
          Constructor for the TeachersDomainLexicon object
TeachersDomainLexicon(StdDocument stdDoc)
          Constructor for the TeachersDomainLexicon object
 
Method Summary
 void destroy()
          NOT YET DOCUMENTED
 String getAuthor()
          Gets the author attribute of the TeachersDomainLexicon object
 String getCreated()
          Gets the created attribute of the TeachersDomainLexicon object
 String getDocKey()
          Gets the docKey attribute of the TeachersDomainLexicon object
 String getId()
          Gets the id attribute of the TeachersDomainLexicon object
 int getMaxNodes()
          Gets the maxNodes attribute of the TeachersDomainLexicon object
 List getNodeList()
          Returns a flat list containing all StandardsNodes in the standardsTree.
 String getRendererTag()
          Gets the rendererTag attribute of the TeachersDomainLexicon object
 StandardsNode getRootNode()
          Gets the rootNode attribute of the TeachersDomainLexicon object
 StandardsNode getStandard(String id)
          Get a StandardNode by id
 String getTitle()
          Gets the title attribute of the TeachersDomainLexicon object
 String getTopic()
          Gets the topic attribute of the TeachersDomainLexicon object
 void init(StdDocument stdDoc)
          Initialize the TeachersDomainLexicon by populating the standardsMap and tree
static void main(String[] args)
          The main program for the TeachersDomainLexicon class
 void printNodeList()
          Description of the Method
 void printStandardsDocument()
          Walk down a hierarchical tree of StandardsNodes and print an indented display
 void setMaxNodes(int max)
          Sets the maxNodes attribute of the TeachersDomainLexicon object
 int size()
          NOT YET DOCUMENTED
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TeachersDomainLexicon

public TeachersDomainLexicon(File source)
                      throws Exception
Constructor for the TeachersDomainLexicon object

Parameters:
source - StdDocument file
Throws:
Exception - if StdDocument file cannot be processed

TeachersDomainLexicon

public TeachersDomainLexicon(StdDocument stdDoc)
                      throws Exception
Constructor for the TeachersDomainLexicon object

Parameters:
stdDoc - NOT YET DOCUMENTED
Throws:
Exception - NOT YET DOCUMENTED
Method Detail

init

public void init(StdDocument stdDoc)
          throws Exception
Initialize the TeachersDomainLexicon by populating the standardsMap and tree

Parameters:
stdDoc - NOT YET DOCUMENTED
Throws:
Exception - NOT YET DOCUMENTED

getId

public String getId()
Gets the id attribute of the TeachersDomainLexicon object

Returns:
The id value

getAuthor

public String getAuthor()
Gets the author attribute of the TeachersDomainLexicon object

Specified by:
getAuthor in interface StandardsDocument
Returns:
The author value

getTopic

public String getTopic()
Gets the topic attribute of the TeachersDomainLexicon object

Specified by:
getTopic in interface StandardsDocument
Returns:
The topic value

getCreated

public String getCreated()
Gets the created attribute of the TeachersDomainLexicon object

Returns:
The created value

getTitle

public String getTitle()
Gets the title attribute of the TeachersDomainLexicon object

Returns:
The title value

getDocKey

public String getDocKey()
Gets the docKey attribute of the TeachersDomainLexicon object

Returns:
The docKey value

getRendererTag

public String getRendererTag()
Gets the rendererTag attribute of the TeachersDomainLexicon object

Returns:
The rendererTag value

setMaxNodes

public void setMaxNodes(int max)
Sets the maxNodes attribute of the TeachersDomainLexicon object

Parameters:
max - The new maxNodes value

getMaxNodes

public int getMaxNodes()
Gets the maxNodes attribute of the TeachersDomainLexicon object

Returns:
The maxNodes value

getStandard

public StandardsNode getStandard(String id)
Get a StandardNode by id

Specified by:
getStandard in interface StandardsDocument
Parameters:
id - NOT YET DOCUMENTED
Returns:
The standard value

getRootNode

public StandardsNode getRootNode()
Gets the rootNode attribute of the TeachersDomainLexicon object

Specified by:
getRootNode in interface StandardsDocument
Returns:
The rootNode value

printStandardsDocument

public void printStandardsDocument()
Walk down a hierarchical tree of StandardsNodes and print an indented display


getNodeList

public List getNodeList()
Returns a flat list containing all StandardsNodes in the standardsTree.

Specified by:
getNodeList in interface StandardsDocument
Returns:
The nodeList value

printNodeList

public void printNodeList()
Description of the Method


size

public int size()
NOT YET DOCUMENTED

Specified by:
size in interface StandardsDocument
Returns:
NOT YET DOCUMENTED

main

public static void main(String[] args)
                 throws Exception
The main program for the TeachersDomainLexicon class

Parameters:
args - The command line arguments
Throws:
Exception - NOT YET DOCUMENTED

destroy

public void destroy()
NOT YET DOCUMENTED

Specified by:
destroy in interface StandardsDocument

DLESE Tools
v1.6.0