Package uk.ac.starlink.ttools.cea

Class CeaMetadata

  • public class CeaMetadata
extends java.lang.Object
    Encapsulates the metadata required for a CEA application description.
    Since:
    20-MAR-2008
    Author:
    Mark Taylor

    • Constructor Summary

      Constructors 
      Constructor Description
      CeaMetadata​(java.lang.String ivorn, java.lang.String shortName, java.lang.String longName, java.lang.String refUrl, java.lang.String description)
      Constructor.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static CeaMetadata createStiltsMetadata​(CeaTask[] tasks)
      Creates a metadata object for the STILTS application with a given list of tasks.
      static CeaMetadata createTaskMetadata​(CeaTask task)
      Creates a metadata object for a CEA application providing only a single STILTS task.
      java.lang.String getDescription()
      Returns description text for this application.
      java.lang.String getIvorn()
      Returns the application ID.
      java.lang.String getLongName()
      Returns the long name of the application.
      java.lang.String getRefUrl()
      Returns the URL for reference documentation.
      java.lang.String getShortName()
      Returns the short name of the application.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • CeaMetadata

        public CeaMetadata​(java.lang.String ivorn,
                   java.lang.String shortName,
                   java.lang.String longName,
                   java.lang.String refUrl,
                   java.lang.String description)
        Constructor.
        Parameters:
        ivorn - application ID
        shortName - short name
        longName - long name
        refUrl - URL for reference documentation
        description - textual description

    • Method Detail

      • getIvorn

        public java.lang.String getIvorn()
        Returns the application ID.
        Returns:
        ivorn

      • getShortName

        public java.lang.String getShortName()
        Returns the short name of the application.
        Returns:
        short name

      • getLongName

        public java.lang.String getLongName()
        Returns the long name of the application.
        Returns:
        long name

      • getRefUrl

        public java.lang.String getRefUrl()
        Returns the URL for reference documentation.
        Returns:
        reference URL

      • getDescription

        public java.lang.String getDescription()
        Returns description text for this application.
        Returns:
        description

      • createStiltsMetadata

        public static CeaMetadata createStiltsMetadata​(CeaTask[] tasks)
        Creates a metadata object for the STILTS application with a given list of tasks.
        Parameters:
        tasks - tasks to include in this deployment
        Returns:
        new metadata object

      • createTaskMetadata

        public static CeaMetadata createTaskMetadata​(CeaTask task)
        Creates a metadata object for a CEA application providing only a single STILTS task.
        Parameters:
        task - single task
        Returns:
        new metadata object