edu.iris.Fissures.IfPlottable

Interface PlottableDCOperations

All Known Subinterfaces:

PlottableDC

All Known Implementing Classes:

_PlottableDCStub, PlottableDCPOA, PlottableDCPOATie

public interface PlottableDCOperations

Method Summary

Modifier and Type	Method and Description
boolean	custom_sizes() Whether or not the PlottableDC can create custom dimensioned Plottables.
Dimension[]	get_event_sizes() Gets the sizes of cached plottables for an event's data.
Plottable[]	get_for_day(ChannelId channel_id, int year, int jday, Dimension pixel_size) Gets a Plottable for an entire day, for example for a helicorder display.
Plottable[]	get_for_event(EventAccess event, ChannelId channel_id, Dimension pixel_size) Gets a Plottable for a particular seismic event.
Plottable[]	get_plottable(RequestFilter request, Dimension pixel_size) Gets a Plottable for a specific time window for a channel at the given size.
Dimension[]	get_whole_day_sizes() Gets the sizes of cached plottables for a whole day of data.

Method Detail

custom_sizes

boolean custom_sizes()

Whether or not the PlottableDC can create custom dimensioned Plottables. Clients should be aware that even if the server is capable of custom dimensions, it may be faster to us the cached dimensions for events and whole day Plottables.

get_plottable

Plottable[] get_plottable(RequestFilter request,
                          Dimension pixel_size)
                   throws PlottableNotAvailable,
                          UnsupportedDimension,
                          NotImplemented

Gets a Plottable for a specific time window for a channel at the given size. Because of the extra overhead of handling custom time ranges, this functionality is optional.

Throws:

PlottableNotAvailable

UnsupportedDimension

NotImplemented

get_whole_day_sizes

Dimension[] get_whole_day_sizes()

Gets the sizes of cached plottables for a whole day of data. A PlottableDC may be able to generate Plottables of arbitrary dimensions, but for performance reasons may only cache certain dimensions. A client should use cached dimensions if possible.

get_for_day

Plottable[] get_for_day(ChannelId channel_id,
                        int year,
                        int jday,
                        Dimension pixel_size)
                 throws PlottableNotAvailable,
                        UnsupportedDimension

Gets a Plottable for an entire day, for example for a helicorder display. For faster response, the client should use one of the cached dimensions.

Throws:

PlottableNotAvailable

UnsupportedDimension

get_event_sizes

Dimension[] get_event_sizes()

Gets the sizes of cached plottables for an event's data. A PlottableDC may be able to generate Plottables of arbitrary dimensions, but for performance reasons may only cache certain dimensions. A client should use cached dimensions if possible.

get_for_event

Plottable[] get_for_event(EventAccess event,
                          ChannelId channel_id,
                          Dimension pixel_size)
                   throws PlottableNotAvailable,
                          UnsupportedDimension

Gets a Plottable for a particular seismic event. For faster response, the client should use one of the cached dimensions.

Throws:

PlottableNotAvailable

UnsupportedDimension