uk.ac.starlink.ttools.server

Class PlotSession<P,A>

java.lang.Object

uk.ac.starlink.ttools.server.PlotSession<P,A>

public class PlotSession<P,A>
extends Object

Maintains state for a server-side plot. This object manages client- and server-side communications to allow plot navigation driven by user mouse actions in the browser.

Since:

13 Dec 2019

Author:

Mark Taylor

Field Summary

Fields

Modifier and Type	Field and Description
static String	BOUNDS_KEY
static PlotService	COUNT_SERVICE
static String	DATAPOS_KEY
static String	FORMAT_KEY
static PlotService	HTML_SERVICE
static String	IMGSRC_KEY
static PlotService	IMGSRC_SERVICE
static String	JS_FILE Name of JavaScript plotting library resource.
static String	MESSAGE_KEY
static PlotService	POSITION_SERVICE
static PlotService	ROW_SERVICE
static PlotService[]	SERVICES Available PlotService instances.
static PlotService	STATE_SERVICE
static String	STATICSVG_KEY
static String	TRANSIENTSVG_KEY
static String	TXTPOS_KEY

Constructor Summary

Constructors

Constructor and Description
PlotSession(String plotTxt, PlotScene<P,A> scene, Navigator<A> navigator, GraphicExporter exporter, DataStore dataStore, Dimension size, DiskCache imgCache) Constructor.

Method Summary

Modifier and Type	Method and Description
static void	init() Must be called before any session is instantiated.

Methods inherited from class java.lang.Object

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

Field Detail

JS_FILE

public static final String JS_FILE

Name of JavaScript plotting library resource.

See Also:

Constant Field Values

IMGSRC_KEY

public static final String IMGSRC_KEY

See Also:

Constant Field Values

TRANSIENTSVG_KEY

public static final String TRANSIENTSVG_KEY

See Also:

Constant Field Values

STATICSVG_KEY

public static final String STATICSVG_KEY

See Also:

Constant Field Values

DATAPOS_KEY

public static final String DATAPOS_KEY

See Also:

Constant Field Values

TXTPOS_KEY

public static final String TXTPOS_KEY

See Also:

Constant Field Values

MESSAGE_KEY

public static final String MESSAGE_KEY

See Also:

Constant Field Values

BOUNDS_KEY

public static final String BOUNDS_KEY

See Also:

Constant Field Values

FORMAT_KEY

public static final String FORMAT_KEY

See Also:

Constant Field Values

HTML_SERVICE

public static final PlotService HTML_SERVICE

STATE_SERVICE

public static final PlotService STATE_SERVICE

IMGSRC_SERVICE

public static final PlotService IMGSRC_SERVICE

POSITION_SERVICE

public static final PlotService POSITION_SERVICE

COUNT_SERVICE

public static final PlotService COUNT_SERVICE

ROW_SERVICE

public static final PlotService ROW_SERVICE

SERVICES

public static final PlotService[] SERVICES

Available PlotService instances.

Constructor Detail

PlotSession

public PlotSession(String plotTxt,
                   PlotScene<P,A> scene,
                   Navigator<A> navigator,
                   GraphicExporter exporter,
                   DataStore dataStore,
                   Dimension size,
                   DiskCache imgCache)

Constructor.

Parameters:

plotTxt - plot text; this is transmitted alongside the sessionId in plot requests so that the session can be reconstructed if the session expires

scene - contains parsed plot information

navigator - plot navigation object

exporter - defines image graphics format

dataStore - data storage

size - initial dimension of IMG element

imgCache - disk cache for storing default image files; may be null for no caching

Method Detail

init

public static void init()
                 throws IOException

Must be called before any session is instantiated.

Throws:

IOException