uk.ac.starlink.cdf

Interface CdfTableProfile

public interface CdfTableProfile

Encapsulates choices about how to do the conversion from a CDF to a StarTable.

Suitable implementations for the attribute finding methods may be based on the ISTP Metadata Guidelines.

Since:

24 Jun 2013

Author:

Mark Taylor

See Also:

CdfTableBuilder

Method Summary

Modifier and Type	Method and Description
String	getBlankValueAttribute(String[] attNames) Returns the name of the CDF Variable Attribute whose value is used to specify magic blank values for the variable data.
String	getDepend0Attribute(String[] attNames) Returns the name of the CDF Variable Attribute whose value is used to determine the independent variable with which a given variable's dependent value is associated.
String	getDescriptionAttribute(String[] attNames) Returns the name of the CDF Variable Attribute whose value is used to supply the column description metadata for the converted StarTable.
String	getUnitAttribute(String[] attNames) Returns the name of the CDF Variable Attribute whose value is used to supply the column units metadata for the converted StarTable.
boolean	invariantVariablesToParameters() Determines whether CDF variables with fixed (non-record-varying) values are turned into columns or parameters in the StarTable.

Method Detail

invariantVariablesToParameters

boolean invariantVariablesToParameters()

Determines whether CDF variables with fixed (non-record-varying) values are turned into columns or parameters in the StarTable.

Returns:

if true, non-record-varying variables will be table parameters, if false they will be table columns with the same value in each row

getDescriptionAttribute

String getDescriptionAttribute(String[] attNames)

Returns the name of the CDF Variable Attribute whose value is used to supply the column description metadata for the converted StarTable.

Parameters:

attNames - names of all the variable attributes present in the CDF

Returns:

attribute name for description; if null or not present, column has no description

See Also:

ValueInfo.getDescription()

getUnitAttribute

String getUnitAttribute(String[] attNames)

Returns the name of the CDF Variable Attribute whose value is used to supply the column units metadata for the converted StarTable.

Parameters:

attNames - names of all the variable attributes present in the CDF

Returns:

attribute name for unit string; if null or not present, column has no units

See Also:

ValueInfo.getUnitString()

getBlankValueAttribute

String getBlankValueAttribute(String[] attNames)

Returns the name of the CDF Variable Attribute whose value is used to specify magic blank values for the variable data. This is typically "FILLVAL".

Parameters:

attNames - names of all the variable attributes present in the CDF

Returns:

attribute name for blank value; if null or not present, column has no magic blank value

getDepend0Attribute

String getDepend0Attribute(String[] attNames)

Returns the name of the CDF Variable Attribute whose value is used to determine the independent variable with which a given variable's dependent value is associated.

Parameters:

attNames - names of all the variable attributes present in the CDF

Returns:

attribute name for associated indpendent variable; if null or not present, dependency is not known