org.dlese.dpc.standards.asn

Class AsnDocument

java.lang.Object

org.dlese.dpc.standards.asn.AsnDocument

Direct Known Subclasses:

AsnMappingDocument

public class AsnDocument
extends java.lang.Object

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

Author:

ostwald

Constructor Summary

Constructors

Constructor and Description
AsnDocument(java.io.File file) Constructor for the AsnDocument object given the path to an ASN XML file.

Method Summary

Modifier and Type	Method and Description
boolean	authorIsAAAS() Returns true if
boolean	authorIsColorado() Returns true if the author of this AsnDocument is Colorado
java.lang.String	getAuthor() Gets the author attribute of the AsnDocument object
java.lang.String	getAuthor(AsnAuthors authors) Gets the author attribute of the AsnDocument object
java.lang.String	getAuthorPurl() Gets the authorPurl attribute of the AsnDocument object
java.lang.String	getCreated() Gets the created attribute of the AsnDocument object
java.lang.String	getDescription() Gets the description attribute of the AsnDocument object
java.lang.String	getFileCreated() Gets the fileCreated attribute of the AsnDocument object
java.lang.String	getIdentifier() Gets the identifier attribute of the AsnDocument object (the full ASN Purl id)
java.util.Set	getIdentifiers() Gets the list of asn IDs defined by the AsnDocument object
java.lang.String	getPath() Gets the path attribute of the AsnDocument object
AsnStandard	getRootStandard() Gets the rootStandard attribute of the AsnDocument object
AsnStandard	getStandard(java.lang.String id) Gets the AsnStandard having provicded id
java.util.Collection	getStandards() Gets all standards contained in this AsnDocument
java.util.List	getStandardsAtLevel(int level) Gets the standards at the specified level of the standards hierarchy of the AsnDocument object
java.lang.String	getTitle() Gets the title attribute of the AsnDocument object
java.lang.String	getTopic() Gets the topic attribute of the AsnDocument object
java.lang.String	getTopic(AsnTopics topics) Gets the topic attribute of the AsnDocument object
java.lang.String	getTopicPurl() Gets the topicPurl attribute of the AsnDocument object
java.lang.String	getUid() Gets the unique part of the ASN purl id
java.lang.String	getVersion() Gets the version attribute of the AsnDocument object
static void	main(java.lang.String[] args) The main program for the AsnDocument 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

AsnDocument

public AsnDocument(java.io.File file)
            throws java.lang.Exception

Constructor for the AsnDocument object given the path to an ASN 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 AsnDocument object

Returns:

The path value

getFileCreated

public java.lang.String getFileCreated()

Gets the fileCreated attribute of the AsnDocument object

Returns:

The fileCreated value

getCreated

public java.lang.String getCreated()

Gets the created attribute of the AsnDocument object

Returns:

The created value

getIdentifier

public java.lang.String getIdentifier()

Gets the identifier attribute of the AsnDocument object (the full ASN Purl id)

Returns:

The identifier value (e.g., "http://purl.org/ASN/resources/S1015D9B")

getUid

public java.lang.String getUid()

Gets the unique part of the ASN purl id

Returns:

The uid value (e.g., "S1015D9B")

getTitle

public java.lang.String getTitle()

Gets the title attribute of the AsnDocument object

Returns:

The title value

getDescription

public java.lang.String getDescription()

Gets the description attribute of the AsnDocument object

Returns:

The description value

getVersion

public java.lang.String getVersion()

Gets the version attribute of the AsnDocument object

Returns:

The version value

getAuthorPurl

public java.lang.String getAuthorPurl()

Gets the authorPurl attribute of the AsnDocument object

Returns:

The authorPurl value

getAuthor

public java.lang.String getAuthor()

Gets the author attribute of the AsnDocument object

Returns:

The author value

getAuthor

public java.lang.String getAuthor(AsnAuthors authors)

Gets the author attribute of the AsnDocument object

Parameters:

authors - Description of the Parameter

Returns:

The author value

getTopicPurl

public java.lang.String getTopicPurl()

Gets the topicPurl attribute of the AsnDocument object

Returns:

The topicPurl value

getTopic

public java.lang.String getTopic()

Gets the topic attribute of the AsnDocument object

Returns:

The topic value

getTopic

public java.lang.String getTopic(AsnTopics topics)

Gets the topic attribute of the AsnDocument object

Parameters:

topics - Description of the Parameter

Returns:

The topic value

getRootStandard

public AsnStandard getRootStandard()

Gets the rootStandard attribute of the AsnDocument object

Returns:

The rootStandard value

getStandard

public AsnStandard getStandard(java.lang.String id)

Gets the AsnStandard 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 AsnDocument

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 AsnDocument object

Parameters:

level - Description of the Parameter

Returns:

The standardsAtLevel value

authorIsColorado

public boolean authorIsColorado()

Returns true if the author of this AsnDocument is Colorado

Returns:

The coloradoBenchmark value

authorIsAAAS

public boolean authorIsAAAS()

Returns true if

Returns:

The aAASBenchmark value

getIdentifiers

public java.util.Set getIdentifiers()

Gets the list of asn IDs defined by the AsnDocument 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 AsnDocument class

Parameters:

args - The command line arguments

Throws:

java.lang.Exception - Description of the Exception