Package nom.tam.fits.compression.provider.param.base

Class CompressColumnParameter<T,OPTION>

java.lang.Object

nom.tam.fits.compression.provider.param.base.CompressParameter<OPTION>

nom.tam.fits.compression.provider.param.base.CompressColumnParameter<T,OPTION>

Type Parameters:

T - The generic array type that contains the individual parameters for each tile as a table column.

OPTION - The generic type of compression option that is associated with these parameters

All Implemented Interfaces:

Cloneable, ICompressColumnParameter, ICompressParameter

Direct Known Subclasses:

ZBlankColumnParameter

public abstract class CompressColumnParameter<T,OPTION>
extends CompressParameter<OPTION>
implements ICompressColumnParameter

(for internal use) Compression parameters that are stored in the table along with the compressed data. Each parameter is associated to a comlumn in the table, and the parameter takes the value that is stored in the same row as the compressed data themselves.

It is possible to make independent copies of a set of such parameters, e.g. for parallel processing. In such cases all copies share their underlying column data with the original, so changing the sotrage array of column data in either the original or any of its decendants will affect the original and all decendans equally.

Author:

Attila Kovacs

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CompressColumnParameter(String name, OPTION option, Class<T> type)

Method Summary

Modifier and Type	Method	Description
T	getColumnData()	Returns the data column, in which each entry stores the parameter value for the compressed data of the corresponding row in the table.
void	setColumnData(Object columnValue, int sizeValue)	Sets new parameter data for each compressed row to be stored along as a separate parameter column in the compressed table.

Methods inherited from class nom.tam.fits.compression.provider.param.base.CompressParameter

copy, getName, getOption

Methods inherited from class java.lang.Object

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

Methods inherited from interface nom.tam.fits.compression.provider.param.api.ICompressColumnParameter

column, column, getValueFromColumn, initializedColumn, setValueFromColumn, setValueInColumn

Methods inherited from interface nom.tam.fits.compression.provider.param.api.ICompressParameter

getName

Constructor Details

CompressColumnParameter

protected CompressColumnParameter(String name,
 OPTION option,
 Class<T> type)

Method Details

getColumnData

public T getColumnData()

Description copied from interface: ICompressColumnParameter

Returns the data column, in which each entry stores the parameter value for the compressed data of the corresponding row in the table.

Specified by:

getColumnData in interface ICompressColumnParameter

Returns:

The array that contains the data for each compressed row.

See Also:

• ICompressColumnParameter.setColumnData(Object, int)
• ICompressColumnParameter.getValueFromColumn(int)
• ICompressColumnParameter.setValueInColumn(int)

setColumnData

public void setColumnData(Object columnValue,
 int sizeValue)

Description copied from interface: ICompressColumnParameter

Sets new parameter data for each compressed row to be stored along as a separate parameter column in the compressed table. To discard prior column data with no replacement, you can call this as setColumnData(null, 0).

Specified by:

setColumnData in interface ICompressColumnParameter

Parameters:

columnValue - The array that contains the data for each compressed row. If not null the size parameter is ignored, and the size of the array is used instead.

sizeValue - The number of compressed rows in the table, if the column argument is null. If size is zero or negative, any prior column data will be discarded and null will be set.

See Also:

• ICompressColumnParameter.getColumnData()