MarkStyleFactory (Starjava TTOOLS API)

java.lang.Object

uk.ac.starlink.ttools.plottask.StyleFactory

uk.ac.starlink.ttools.plottask.MarkStyleFactory

public class MarkStyleFactory extends StyleFactory

StyleFactory for obtaining MarkStyle instances suitable for use with a scatter plot.

Since:: 8 Aug 2008
Author:: Mark Taylor

Constructor Summary

Constructors

Constructor

Description

MarkStyleFactory(String prefix, int errNdim)

Constructor.
Method Summary

Modifier and Type

Method

Description

uk.ac.starlink.task.Parameter<?>[]

getParameters(String stSuffix)

Returns the parameters used by this factory.

Style

getStyle(uk.ac.starlink.task.Environment env, String stSuffix)

Returns a MarkStyle instance.

Methods inherited from class StyleFactory
getStyleIndex, paramName

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

Constructor Details
- MarkStyleFactory
  
  public MarkStyleFactory(String prefix, int errNdim)
  
  Constructor.
  
  Parameters:
  
  prefix - prefix to be prepended to all parameters used by this factory
  
  errNdim - number of dimensions in which errors may be displayed
Method Details
- getParameters
  
  public uk.ac.starlink.task.Parameter<?>[] getParameters(String stSuffix)
  
  Description copied from class: StyleFactory
  
  Returns the parameters used by this factory.
  
  Specified by:
  
  getParameters in class StyleFactory
  
  Parameters:
  
  stSuffix - label identifying the data set for which the style will be required
- getStyle
  
  public Style getStyle(uk.ac.starlink.task.Environment env, String stSuffix) throws uk.ac.starlink.task.TaskException
  
  Returns a MarkStyle instance.
  
  Specified by:
  
  getStyle in class StyleFactory
  
  Parameters:
  
  env - execution environment
  
  stSuffix - label identifying the data set for which the style is required
  
  Returns:
  
  plotting style
  
  Throws:
  
  uk.ac.starlink.task.TaskException