Class SimpleLayerType

  • All Implemented Interfaces:
    LayerType
    Direct Known Subclasses:
    SpotPlotter.SpotLayerType

    public class SimpleLayerType
    extends java.lang.Object
    implements LayerType
    LayerType representing a single Plotter.
    Since:
    15 Sep 2014
    Author:
    Mark Taylor
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      uk.ac.starlink.task.Parameter<?>[] getAssociatedParameters​(java.lang.String suffix)
      Returns a list of zero or more additional parameters associated with this layer type that may be required to turn it into the specification of an actual Plotter object.
      Coord[] getExtraCoords()
      Returns a list of any non-positional coordinates associated with this layer.
      java.lang.String getName()
      Returns the name of this layer type.
      Plotter<?> getPlotter()
      Returns this layer type's single plotter.
      Plotter<?> getPlotter​(uk.ac.starlink.task.Environment env, java.lang.String suffix)
      Acquires a Plotter for this layer type.
      int getPositionCount()
      Returns the number of coordinate positions associated with this layer.
      ConfigKey<?>[] getStyleKeys()
      Returns the style keys associated with this layer type.
      java.lang.String getXmlDescription()
      Returns an XML description of this layer type.
      • Methods inherited from class java.lang.Object

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

      • SimpleLayerType

        public SimpleLayerType​(Plotter<?> plotter)
        Constructor.
        Parameters:
        plotter - plotter
    • Method Detail

      • getName

        public java.lang.String getName()
        Description copied from interface: LayerType
        Returns the name of this layer type.
        Specified by:
        getName in interface LayerType
        Returns:
        name as selected by user
      • getXmlDescription

        public java.lang.String getXmlDescription()
        Description copied from interface: LayerType
        Returns an XML description of this layer type.
        Specified by:
        getXmlDescription in interface LayerType
        Returns:
        one or more <p> elements
      • getAssociatedParameters

        public uk.ac.starlink.task.Parameter<?>[] getAssociatedParameters​(java.lang.String suffix)
        Description copied from interface: LayerType
        Returns a list of zero or more additional parameters associated with this layer type that may be required to turn it into the specification of an actual Plotter object.
        Specified by:
        getAssociatedParameters in interface LayerType
        Parameters:
        suffix - layer suffix string for use in the execution environment
        Returns:
        zero or more associated parameters, for documentation purposes
      • getPlotter

        public Plotter<?> getPlotter​(uk.ac.starlink.task.Environment env,
                                     java.lang.String suffix)
        Description copied from interface: LayerType
        Acquires a Plotter for this layer type.
        Specified by:
        getPlotter in interface LayerType
        Parameters:
        env - execution environment
        suffix - layer suffix string
        Returns:
        plotter
      • getPlotter

        public Plotter<?> getPlotter()
        Returns this layer type's single plotter.
        Returns:
        plotter
      • getPositionCount

        public int getPositionCount()
        Description copied from interface: LayerType
        Returns the number of coordinate positions associated with this layer.
        Specified by:
        getPositionCount in interface LayerType
        Returns:
        DataGeom-type positional coordinate multiplicity
      • getExtraCoords

        public Coord[] getExtraCoords()
        Description copied from interface: LayerType
        Returns a list of any non-positional coordinates associated with this layer.
        Specified by:
        getExtraCoords in interface LayerType
        Returns:
        zero or more non-positional coordinates
      • getStyleKeys

        public ConfigKey<?>[] getStyleKeys()
        Description copied from interface: LayerType
        Returns the style keys associated with this layer type.
        Specified by:
        getStyleKeys in interface LayerType
        Returns:
        zero or more style keys associated with every layer produced by this type