SurfaceFactory (Starjava TTOOLS API)

All Known Implementing Classes:

CubeSurfaceFactory, PlaneSurfaceFactory, SkySurfaceFactory, TimeSurfaceFactory
```
public interface SurfaceFactory<P,A>
```
Generates members of a family of Surface objects. Surface configuration is provided by two objects of parameterised types, a Profile (type P) and an Aspect (type A). The profile provides fixed configuration items, and the aspect provides items that may change according to different views of the same surface, in particular as the result of pan/zoom type operations. This object is self-documenting, in that it can report the the configuration keys required to specify profile/aspect.

Since:

11 Feb 2013

Author:

Mark Taylor

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`A`	`createAspect(P profile, ConfigMap aspectConfig, Range[] ranges)` Creates an aspect from configuration information.
`Navigator<A>`	`createNavigator(ConfigMap navigatorConfig)` Creates a navigator from configuration information.
`P`	`createProfile(ConfigMap config)` Creates a profile that can be used when creating a plot surface.
`Surface`	`createSurface(java.awt.Rectangle plotBounds, P profile, A aspect)` Returns a new plot surface.
`ConfigKey[]`	`getAspectKeys()` Returns the configuration keys that may be used to configure aspect for this surface factory.
`ConfigKey[]`	`getNavigatorKeys()` Returns the configuration keys that may be used to configure a navigator for use with this surface factory.
`ConfigKey[]`	`getProfileKeys()` Returns the configuration keys used to configure profile for this surface factory.
`Range[]`	`readRanges(P profile, PlotLayer[] layers, DataStore dataStore)` Provides the ranges that may be passed to `createAspect`.
`boolean`	`useRanges(P profile, ConfigMap aspectConfig)` Indicates whether ranges should be provided to generate an aspect.

- Method Detail
  - createSurface
```
Surface createSurface(java.awt.Rectangle plotBounds,
                      P profile,
                      A aspect)
```
    Returns a new plot surface.
    
    Parameters:
    
    plotBounds - rectangle to containing actual plot data (not insets)
    
    profile - configuration object defining plot style
    
    aspect - configuration object defining plot viewpoint
    
    Returns:
    
    new plot surface
  - getProfileKeys
```
ConfigKey[] getProfileKeys()
```
    Returns the configuration keys used to configure profile for this surface factory. The returned keys are used in the map supplied to the createProfile method.
    
    Returns:
    
    profile configuration keys
  - createProfile
```
P createProfile(ConfigMap config)
```
    Creates a profile that can be used when creating a plot surface. The keys that are significant in the supplied config map are those returned by getProfileKeys. The return value can be used as input to createSurface and other methods in this class.
    
    Parameters:
    
    config - map of profile configuration items
    
    Returns:
    
    factory-specific plot surface profile
  - getAspectKeys
```
ConfigKey[] getAspectKeys()
```
    Returns the configuration keys that may be used to configure aspect for this surface factory. The returned keys are used in the map supplied to the useRanges and createAspect methods.
    
    Returns:
    
    aspect configuration keys
  - useRanges
```
boolean useRanges(P profile,
                  ConfigMap aspectConfig)
```
    Indicates whether ranges should be provided to generate an aspect. If true, it is beneficial to pass the result of readRanges to createAspect alongside the arguments of this method. If false, any such ranges will be ignored.
    
    Parameters:
    
    profile - surface configuration profile
    
    aspectConfig - configuration map that may contain keys from getAspectKeys
    
    Returns:
    
    true iff calculated ranges will be of use
  - readRanges
```
@Slow
Range[] readRanges(P profile,
                         PlotLayer[] layers,
                         DataStore dataStore)
```
    Provides the ranges that may be passed to createAspect. There is only any point calling this if useRanges returns true.
    
    Parameters:
    
    profile - surface configuration profile
    
    layers - plot layers to be plotted
    
    dataStore - contains actual data
    
    Returns:
    
    data ranges covered by the given layers filled in from data
  - createAspect
```
A createAspect(P profile,
               ConfigMap aspectConfig,
               Range[] ranges)
```
    Creates an aspect from configuration information. The ranges argument will be used only if useRanges returns true. It is legal to give the ranges argument as null in any case. In all cases, the returned value must be non-null and usable by createSurface.
    
    Parameters:
    
    profile - surface configuration profile
    
    aspectConfig - configuration map that may contain keys from getAspectKeys
    
    ranges - range data filled in from layers, or null
    
    Returns:
    
    new aspect
  - getNavigatorKeys
```
ConfigKey[] getNavigatorKeys()
```
    Returns the configuration keys that may be used to configure a navigator for use with this surface factory. The returned keys are used in the map supplied to the createNavigator(uk.ac.starlink.ttools.plot2.config.ConfigMap) method.
    
    Returns:
    
    navigator configuration keys
  - createNavigator
```
Navigator<A> createNavigator(ConfigMap navigatorConfig)
```
    Creates a navigator from configuration information. The returned value will be non-null.
    
    Parameters:
    
    navigatorConfig - configuration map that may contain keys from getNavigatorKeys
    
    Returns:
    
    navigator for use with surfaces produced by this factory

Interface SurfaceFactory<P,A>

Method Summary

Method Detail

createSurface

getProfileKeys

createProfile

getAspectKeys

useRanges

readRanges

createAspect

getNavigatorKeys

createNavigator