org.dlese.dpc.schemedit.standards.commcore

Class CommCoreStandardsDocument

java.lang.Object

org.dlese.dpc.schemedit.standards.commcore.CommCoreStandardsDocument

All Implemented Interfaces:

StandardsDocument

public class CommCoreStandardsDocument
extends java.lang.Object
implements StandardsDocument

Provides acess to a single CommCore Standards Document (and individual standards contained within) via the StdDocument and Standard classes. Provides lists of StandardsNodes for use in UI JSP.

Author:

ostwald

Constructor Summary

Constructors

Constructor and Description
CommCoreStandardsDocument(java.io.File source) Constructor for the CommCoreStandardsDocument object
CommCoreStandardsDocument(StdDocument stdDoc) Constructor for the CommCoreStandardsDocument object

Method Summary

Modifier and Type	Method and Description
void	destroy() NOT YET DOCUMENTED
java.lang.String	getAuthor() Gets the author attribute of the CommCoreStandardsDocument object
java.lang.String	getCreated() Gets the created attribute of the CommCoreStandardsDocument object
java.lang.String	getDocKey() Gets the docKey attribute of the CommCoreStandardsDocument object
java.lang.String	getId() Gets the id attribute of the CommCoreStandardsDocument object
int	getMaxNodes() Gets the maxNodes attribute of the CommCoreStandardsDocument object
java.util.List	getNodeList() Returns a flat list containing all StandardsNodes in the standardsTree.
java.lang.String	getRendererTag() Gets the rendererTag attribute of the CommCoreStandardsDocument object
StandardsNode	getRootNode() Gets the rootNode attribute of the CommCoreStandardsDocument object
StandardsNode	getStandard(java.lang.String id) Get a StandardNode by id
java.lang.String	getTitle() Gets the title attribute of the CommCoreStandardsDocument object
java.lang.String	getTopic() Gets the topic attribute of the CommCoreStandardsDocument object
void	init(StdDocument stdDoc) Initialize the CommCoreStandardsDocument by populating the standardsMap and tree
static void	main(java.lang.String[] args) The main program for the CommCoreStandardsDocument 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 CommCoreStandardsDocument 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

CommCoreStandardsDocument

public CommCoreStandardsDocument(java.io.File source)
                          throws java.lang.Exception

Constructor for the CommCoreStandardsDocument object

Parameters:

source - StdDocument file

Throws:

java.lang.Exception - if StdDocument file cannot be processed

CommCoreStandardsDocument

public CommCoreStandardsDocument(StdDocument stdDoc)
                          throws java.lang.Exception

Constructor for the CommCoreStandardsDocument object

Parameters:

stdDoc - NOT YET DOCUMENTED

Throws:

java.lang.Exception - NOT YET DOCUMENTED

Method Detail

init

public void init(StdDocument stdDoc)
          throws java.lang.Exception

Initialize the CommCoreStandardsDocument by populating the standardsMap and tree

Parameters:

stdDoc - NOT YET DOCUMENTED

Throws:

java.lang.Exception - NOT YET DOCUMENTED

getId

public java.lang.String getId()

Gets the id attribute of the CommCoreStandardsDocument object

Returns:

The id value

getAuthor

public java.lang.String getAuthor()

Gets the author attribute of the CommCoreStandardsDocument object

Specified by:

getAuthor in interface StandardsDocument

Returns:

The author value

getTopic

public java.lang.String getTopic()

Gets the topic attribute of the CommCoreStandardsDocument object

Specified by:

getTopic in interface StandardsDocument

Returns:

The topic value

getCreated

public java.lang.String getCreated()

Gets the created attribute of the CommCoreStandardsDocument object

Returns:

The created value

getTitle

public java.lang.String getTitle()

Gets the title attribute of the CommCoreStandardsDocument object

Returns:

The title value

getDocKey

public java.lang.String getDocKey()

Gets the docKey attribute of the CommCoreStandardsDocument object

Returns:

The docKey value

getRendererTag

public java.lang.String getRendererTag()

Gets the rendererTag attribute of the CommCoreStandardsDocument object

Returns:

The rendererTag value

setMaxNodes

public void setMaxNodes(int max)

Sets the maxNodes attribute of the CommCoreStandardsDocument object

Parameters:

max - The new maxNodes value

getMaxNodes

public int getMaxNodes()

Gets the maxNodes attribute of the CommCoreStandardsDocument object

Returns:

The maxNodes value

getStandard

public StandardsNode getStandard(java.lang.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 CommCoreStandardsDocument 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 java.util.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(java.lang.String[] args)
                 throws java.lang.Exception

The main program for the CommCoreStandardsDocument class

Parameters:

args - The command line arguments

Throws:

java.lang.Exception - NOT YET DOCUMENTED

destroy

public void destroy()

NOT YET DOCUMENTED

Specified by:

destroy in interface StandardsDocument