DataStoreParameter (Starjava TTOOLS API)

Skip navigation links

All Classes

SEARCH:

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- uk.ac.starlink.task.Parameter<T>
- - uk.ac.starlink.task.ChoiceParameter<DataStoreFactory>
  - - uk.ac.starlink.ttools.plot2.task.DataStoreParameter

```
public class DataStoreParameter
extends uk.ac.starlink.task.ChoiceParameter<DataStoreFactory>
```
Parameter to control the way that plot data is cached prior to performing one or more plots.

Since:

1 Mark 2013

Author:

Mark Taylor

Field Summary

Fields
Modifier and Type	Field	Description
`static DataStoreFactory`	`BASIC_CACHE`	Cached storage: data is first read into arrays in memory.
`static DataStoreFactory`	`SIMPLE`	Simple storage: data is read on demand from table every time.
`static DataStoreFactory`	`SMART_CACHE`	Smart cached storage: like BASIC_CACHE but tries to spot non-varying columns etc for more efficient storage.

Fields inherited from class uk.ac.starlink.task.Parameter
BY_NAME

Constructor Summary

Constructors
Constructor Description

DataStoreParameter(java.lang.String name)
Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`DataStoreFactory`	`getDefaultForCaching(boolean isCachingSensible)`	Returns the default value for this parameter based on whether caching is believed to be a good idea.
`void`	`setDefaultCaching(boolean caching)`	Sets whether caching generally is or is not advised.

Methods inherited from class uk.ac.starlink.task.ChoiceParameter
addOption, addOption, clearOptions, getName, getOption, getOptionNames, getOptions, getOptionValueList, getUsage, objectToString, setDefaultOption, setUsage, stringifyOption, stringToObject

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from class uk.ac.starlink.task.Parameter
clearValue, getDescription, getName, getPosition, getPreferExplicit, getPrompt, getStringDefault, getValueClass, isNullPermitted, objectValue, setDescription, setDescription, setName, setNullPermitted, setPosition, setPreferExplicit, setPrompt, setStringDefault, setValue, setValueFromObject, setValueFromString, stringValue, toArray, toString

- Field Detail
  - SIMPLE
```
public static final DataStoreFactory SIMPLE
```
    Simple storage: data is read on demand from table every time.
  - BASIC_CACHE
```
public static final DataStoreFactory BASIC_CACHE
```
    Cached storage: data is first read into arrays in memory.
  - SMART_CACHE
```
public static final DataStoreFactory SMART_CACHE
```
    Smart cached storage: like BASIC_CACHE but tries to spot non-varying columns etc for more efficient storage.
- Constructor Detail
  - DataStoreParameter
```
public DataStoreParameter(java.lang.String name)
```
    Constructor.
    
    Parameters:
    
    name - parameter name
- Method Detail
  - setDefaultCaching
```
public void setDefaultCaching(boolean caching)
```
    Sets whether caching generally is or is not advised. This affects the default value of this parameter.
    
    Parameters:
    
    caching - true if caching is likely to be a good strategy
  - getDefaultForCaching
```
public DataStoreFactory getDefaultForCaching(boolean isCachingSensible)
```
    Returns the default value for this parameter based on whether caching is believed to be a good idea.
    
    Parameters:
    
    isCachingSensible - true if caching is likely to be a good strategy
    
    Returns:
    
    best default option

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Copyright © 2018 Central Laboratory of the Research Councils. All Rights Reserved.