Package org.dlese.dpc.standards.asn

Class AsnDocument

java.lang.Object
org.dlese.dpc.standards.asn.AsnDocument
Direct Known Subclasses:
AsnMappingDocument
public class AsnDocument extends 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 Details

    • AsnDocument

      public AsnDocument(File file) throws Exception
      Constructor for the AsnDocument object given the path to an ASN XML file.
      Parameters:
      path - Description of the Parameter
      Throws:
      Exception - Description of the Exception

  • Method Details

    • getPath

      public String getPath()
      Gets the path attribute of the AsnDocument object
      Returns:
      The path value

    • getFileCreated

      public String getFileCreated()
      Gets the fileCreated attribute of the AsnDocument object
      Returns:
      The fileCreated value

    • getCreated

      public String getCreated()
      Gets the created attribute of the AsnDocument object
      Returns:
      The created value

    • getIdentifier

      public 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 String getUid()
      Gets the unique part of the ASN purl id
      Returns:
      The uid value (e.g., "S1015D9B")

    • getTitle

      public String getTitle()
      Gets the title attribute of the AsnDocument object
      Returns:
      The title value

    • getDescription

      public String getDescription()
      Gets the description attribute of the AsnDocument object
      Returns:
      The description value

    • getVersion

      public String getVersion()
      Gets the version attribute of the AsnDocument object
      Returns:
      The version value

    • getAuthorPurl

      public String getAuthorPurl()
      Gets the authorPurl attribute of the AsnDocument object
      Returns:
      The authorPurl value

    • getAuthor

      public String getAuthor()
      Gets the author attribute of the AsnDocument object
      Returns:
      The author value

    • getAuthor

      public String getAuthor(AsnAuthors authors)
      Gets the author attribute of the AsnDocument object
      Parameters:
      authors - Description of the Parameter
      Returns:
      The author value

    • getTopicPurl

      public String getTopicPurl()
      Gets the topicPurl attribute of the AsnDocument object
      Returns:
      The topicPurl value

    • getTopic

      public String getTopic()
      Gets the topic attribute of the AsnDocument object
      Returns:
      The topic value

    • getTopic

      public 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(String id)
      Gets the AsnStandard having provicded id
      Parameters:
      id - Description of the Parameter
      Returns:
      The standard value

    • getStandards

      public Collection getStandards()
      Gets all standards contained in this AsnDocument
      Returns:
      The standards value

    • getStandardsAtLevel

      public 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 Set getIdentifiers()
      Gets the list of asn IDs defined by the AsnDocument 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 AsnDocument class
      Parameters:
      args - The command line arguments
      Throws:
      Exception - Description of the Exception