org.dlese.dpc.standards.commcore
Class StdDocument

java.lang.Object
  org.dlese.dpc.standards.commcore.StdDocument

public class StdDocument
extends Object

Encapsulates an ASN Standards Document by reading the source XML file and creating a hierarchy of Standard instances. Also provides lookup for Standards by their id.

Author:

ostwald

Constructor Summary

StdDocument(String path)
Constructor for the StdDocument object given the path to an XML file.

Method Summary

String	getAuthor() Gets the author attribute of the StdDocument object
String	getDescription() Gets the description attribute of the StdDocument object
String	getFileCreated() Gets the fileCreated attribute of the StdDocument object
String	getIdentifier() Gets the identifier attribute of the StdDocument object
Set	getIdentifiers() Gets the lisf of asn IDs defined by the StdDocument object
String	getPath() Gets the path attribute of the StdDocument object
Standard	getRootStandard() Gets the rootStandard attribute of the StdDocument object
Standard	getStandard(String id) Gets the Standard having provicded id
Collection	getStandards() Gets all standards contained in this StdDocument
List	getStandardsAtLevel(int level) Gets the standards at the specified level of the standards hierarchy of the StdDocument object
String	getTitle() Gets the title attribute of the StdDocument object
String	getTopic() Gets the topic attribute of the StdDocument object
String	getUid() Gets the uid attribute of the StdDocument object
String	getVersion() Gets the version attribute of the StdDocument object
static void	main(String[] args) The main program for the StdDocument class
String	toString() Description of the Method

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

StdDocument

public StdDocument(String path)
            throws Exception

Constructor for the StdDocument object given the path to an XML file.

Parameters:

path - Description of the Parameter

Throws:

Exception - Description of the Exception

Method Detail

getPath

public String getPath()

Gets the path attribute of the StdDocument object

Returns:

The path value

getFileCreated

public String getFileCreated()

Gets the fileCreated attribute of the StdDocument object

Returns:

The fileCreated value

getIdentifier

public String getIdentifier()

Gets the identifier attribute of the StdDocument object

Returns:

The identifier value

getUid

public String getUid()

Gets the uid attribute of the StdDocument object

Returns:

The uid value

getTitle

public String getTitle()

Gets the title attribute of the StdDocument object

Returns:

The title value

getDescription

public String getDescription()

Gets the description attribute of the StdDocument object

Returns:

The description value

getVersion

public String getVersion()

Gets the version attribute of the StdDocument object

Returns:

The version value

getAuthor

public String getAuthor()

Gets the author attribute of the StdDocument object

Returns:

The author value

getTopic

public String getTopic()

Gets the topic attribute of the StdDocument object

Returns:

The topic value

getRootStandard

public Standard getRootStandard()

Gets the rootStandard attribute of the StdDocument object

Returns:

The rootStandard value

getStandard

public Standard getStandard(String id)

Gets the Standard having provicded id

Parameters:

id - Description of the Parameter

Returns:

The standard value

getStandards

public Collection getStandards()

Gets all standards contained in this StdDocument

Returns:

The standards value

getStandardsAtLevel

public List getStandardsAtLevel(int level)

Gets the standards at the specified level of the standards hierarchy of the StdDocument object

Parameters:

level - Description of the Parameter

Returns:

The standardsAtLevel value

getIdentifiers

public Set getIdentifiers()

Gets the lisf of asn IDs defined by the StdDocument object

Returns:

The identifiers value

toString

public String toString()

Description of the Method

Overrides:

toString in class Object

Returns:

Description of the Return Value

main

public static void main(String[] args)
                 throws Exception

The main program for the StdDocument class

Parameters:

args - The command line arguments

Throws:

Exception - Description of the Exception