uk.ac.starlink.ttools.build
Class LayerTypeDoc

java.lang.Object
  extended by uk.ac.starlink.ttools.build.LayerTypeDoc

public class LayerTypeDoc
extends Object

Writes XML text documenting known plot2 LayerTypes. Output is to standard output. This class is designed to be used from its main method.

Since:
15 Sep 2014
Author:
Mark Taylor

Constructor Summary
LayerTypeDoc(boolean basicXml)
          Constructor.
 
Method Summary
static Map<String,LayerType> getLayerTypes(TypedPlot2Task[] tasks)
          Returns a map (keyed by name) of all the LayerTypes used by a given list of tasks.
static TypedPlot2Task[] getPlot2Tasks()
          Returns a list of all the TypedPlot2Tasks known to Stilts.
 String getXmlDoc(LayerType layerType)
          Returns an XML element giving full user documentation for a given layer type.
static String layerTypeRef(LayerType ltype)
          Returns XML text that can be used to reference a LayerType description in the user document.
static void main(String[] args)
          Main method.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

LayerTypeDoc

public LayerTypeDoc(boolean basicXml)
Constructor.

Parameters:
basicXml - avoid XML constructs that won't show up in text output
Method Detail

getXmlDoc

public String getXmlDoc(LayerType layerType)
Returns an XML element giving full user documentation for a given layer type.

Parameters:
layerType - layer type
Returns:
text of <subsect> element

getPlot2Tasks

public static TypedPlot2Task[] getPlot2Tasks()
                                      throws LoadException
Returns a list of all the TypedPlot2Tasks known to Stilts.

Returns:
plot tasks
Throws:
LoadException

getLayerTypes

public static Map<String,LayerType> getLayerTypes(TypedPlot2Task[] tasks)
Returns a map (keyed by name) of all the LayerTypes used by a given list of tasks.

Parameters:
known - task list
Returns:
known layer types

layerTypeRef

public static String layerTypeRef(LayerType ltype)
Returns XML text that can be used to reference a LayerType description in the user document.

Parameters:
ltype - layer type
Returns:
<ref> element

main

public static void main(String[] args)
                 throws LoadException
Main method. Try -help.

Throws:
LoadException


Copyright © 2015 Central Laboratory of the Research Councils. All Rights Reserved.