java.lang.Object

uk.ac.starlink.util.XmlWriter

uk.ac.starlink.ttools.cea.CeaWriter

uk.ac.starlink.ttools.cea.ImplementationCeaWriter

public class ImplementationCeaWriter extends CeaWriter

CeaWriter implementation which writes an XML document giving CEA Implementation instance. This is what goes in an app-description.xml file local to a STILTS CEA installation (I think).

Since:: 1 Nov 2007
Author:: Mark Taylor

Field Summary

Fields

Modifier and Type

Field

Description

static final String

APPLICATION_ID

static final String

SCHEMA_LOCATION
Constructor Summary

Constructors

Constructor

Description

ImplementationCeaWriter(PrintStream out, CeaTask[] tasks, CeaMetadata meta, boolean redirects, String cmdline)

Constructor.
Method Summary

Modifier and Type

Method

Description

int

configure(String[] args)

Hook for additional configuration of concrete subclasses using command-line flags.

String

getSchemaLocation()

Returns the URL of the schema to which the output of this object conforms.

static String

getUsage()

protected void

writeContent()

Performs the implementation-specific output of XML elements.

Methods inherited from class uk.ac.starlink.ttools.cea.CeaWriter
endElement, main, startElement, startElement, writeDocument, writeInterfaces, writeParameters

Methods inherited from class uk.ac.starlink.util.XmlWriter
addElement, endElement, formatAttribute, formatText, getIndent, getLevel, print, println, setOut, startElement, startElement, writeDeclaration

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details
- SCHEMA_LOCATION
  
  public static final String SCHEMA_LOCATION
  See Also:
  
  Constant Field Values
- APPLICATION_ID
  
  public static final String APPLICATION_ID
  See Also:
  
  Constant Field Values
Constructor Details
- ImplementationCeaWriter
  
  public ImplementationCeaWriter(PrintStream out, CeaTask[] tasks, CeaMetadata meta, boolean redirects, String cmdline)
  
  Constructor.
  
  Parameters:
  
  out - output stream for XML
  
  tasks - list of tasks to be described by the output
  
  meta - application description metadata object
  
  redirects - true iff you want stdout/stderr parameters for standard output/error redirection
  
  cmdline - command line string, used for logging within the output only
Method Details
- getSchemaLocation
  
  public String getSchemaLocation()
  
  Description copied from class: CeaWriter
  
  Returns the URL of the schema to which the output of this object conforms.
  
  Specified by:
  
  getSchemaLocation in class CeaWriter
  
  Returns:
  
  validation schema location
- getUsage
  
  public static String getUsage()
- configure
  
  public int configure(String[] args)
  
  Description copied from class: CeaWriter
  
  Hook for additional configuration of concrete subclasses using command-line flags.
  
  Specified by:
  
  configure in class CeaWriter
  
  Parameters:
  
  args - array of command-line arguments all of which are directed at this object (any generic ones will have been removed)
  
  Returns:
  
  0 for success, otherwise an error status
- writeContent
  
  protected void writeContent() throws SAXException
  
  Description copied from class: CeaWriter
  
  Performs the implementation-specific output of XML elements. Invoked by CeaWriter.writeDocument(); presumably invokes CeaWriter.writeParameters() and CeaWriter.writeInterfaces().
  
  Specified by:
  
  writeContent in class CeaWriter
  
  Throws:
  
  SAXException

Class ImplementationCeaWriter

Field Summary

Constructor Summary

Method Summary

Methods inherited from class uk.ac.starlink.ttools.cea.CeaWriter

Methods inherited from class uk.ac.starlink.util.XmlWriter

Methods inherited from class java.lang.Object

Field Details

SCHEMA_LOCATION

APPLICATION_ID

Constructor Details

ImplementationCeaWriter

Method Details

getSchemaLocation

getUsage

configure

writeContent