org.dlese.dpc.standards.commcore

Class StdDocument

java.lang.Object

org.dlese.dpc.standards.commcore.StdDocument

public class StdDocument
extends java.lang.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

Constructors

Constructor and Description
StdDocument(java.lang.String path) Constructor for the StdDocument object given the path to an XML file.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAuthor() Gets the author attribute of the StdDocument object
java.lang.String	getDescription() Gets the description attribute of the StdDocument object
java.lang.String	getFileCreated() Gets the fileCreated attribute of the StdDocument object
java.lang.String	getIdentifier() Gets the identifier attribute of the StdDocument object
java.util.Set	getIdentifiers() Gets the lisf of asn IDs defined by the StdDocument object
java.lang.String	getPath() Gets the path attribute of the StdDocument object
Standard	getRootStandard() Gets the rootStandard attribute of the StdDocument object
Standard	getStandard(java.lang.String id) Gets the Standard having provicded id
java.util.Collection	getStandards() Gets all standards contained in this StdDocument
java.util.List	getStandardsAtLevel(int level) Gets the standards at the specified level of the standards hierarchy of the StdDocument object
java.lang.String	getTitle() Gets the title attribute of the StdDocument object
java.lang.String	getTopic() Gets the topic attribute of the StdDocument object
java.lang.String	getUid() Gets the uid attribute of the StdDocument object
java.lang.String	getVersion() Gets the version attribute of the StdDocument object
static void	main(java.lang.String[] args) The main program for the StdDocument class
java.lang.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(java.lang.String path)
            throws java.lang.Exception

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

Parameters:

path - Description of the Parameter

Throws:

java.lang.Exception - Description of the Exception

Method Detail

getPath

public java.lang.String getPath()

Gets the path attribute of the StdDocument object

Returns:

The path value

getFileCreated

public java.lang.String getFileCreated()

Gets the fileCreated attribute of the StdDocument object

Returns:

The fileCreated value

getIdentifier

public java.lang.String getIdentifier()

Gets the identifier attribute of the StdDocument object

Returns:

The identifier value

getUid

public java.lang.String getUid()

Gets the uid attribute of the StdDocument object

Returns:

The uid value

getTitle

public java.lang.String getTitle()

Gets the title attribute of the StdDocument object

Returns:

The title value

getDescription

public java.lang.String getDescription()

Gets the description attribute of the StdDocument object

Returns:

The description value

getVersion

public java.lang.String getVersion()

Gets the version attribute of the StdDocument object

Returns:

The version value

getAuthor

public java.lang.String getAuthor()

Gets the author attribute of the StdDocument object

Returns:

The author value

getTopic

public java.lang.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(java.lang.String id)

Gets the Standard having provicded id

Parameters:

id - Description of the Parameter

Returns:

The standard value

getStandards

public java.util.Collection getStandards()

Gets all standards contained in this StdDocument

Returns:

The standards value

getStandardsAtLevel

public java.util.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 java.util.Set getIdentifiers()

Gets the lisf of asn IDs defined by the StdDocument object

Returns:

The identifiers value

toString

public java.lang.String toString()

Description of the Method

Overrides:

toString in class java.lang.Object

Returns:

Description of the Return Value

main

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

The main program for the StdDocument class

Parameters:

args - The command line arguments

Throws:

java.lang.Exception - Description of the Exception