Class SchemeDoc


  • public class SchemeDoc
    extends java.lang.Object
    Writes a section of XML text documenting the details of TableSchemes available within the STILTS application.
    Since:
    4 Sep 2020
    Author:
    Mark Taylor
    • Constructor Summary

      Constructors 
      Constructor Description
      SchemeDoc​(boolean requiresDoc)
      Constructor.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getXmlDoc​(uk.ac.starlink.table.TableScheme scheme)
      Returns a string containing an XML subsubsect element decribing a given TableScheme.
      static void main​(java.lang.String[] args)
      Writes a sequence of XML subsubsect elements to standard output, documenting the TableSchemes available by default from STILTS.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • SchemeDoc

        public SchemeDoc​(boolean requiresDoc)
        Constructor.
        Parameters:
        requiresDoc - if true, an error is generated for TableSchemes that do not implement the interface uk.ac.starlink.table.Documented
    • Method Detail

      • getXmlDoc

        public java.lang.String getXmlDoc​(uk.ac.starlink.table.TableScheme scheme)
                                   throws java.io.IOException
        Returns a string containing an XML subsubsect element decribing a given TableScheme.
        Parameters:
        scheme - table scheme, preferably implementing Documented
        Returns:
        XML text
        Throws:
        java.io.IOException
      • main

        public static void main​(java.lang.String[] args)
                         throws java.io.IOException
        Writes a sequence of XML subsubsect elements to standard output, documenting the TableSchemes available by default from STILTS.
        Throws:
        java.io.IOException