gsfc.nssdc.cdf

Class CDFTools

java.lang.Object

gsfc.nssdc.cdf.CDFTools

All Implemented Interfaces:

CDFConstants

public class CDFTools
extends java.lang.Object
implements CDFConstants

CDFTools.java Created: Tue Nov 24 16:14:50 1998

Version:

$Id: CDFTools.java,v 1.2 2021/10/01 14:51:33 mhliu Exp $

Field Summary

Fields

Modifier and Type	Field and Description
static int	ALL_VALUES
static int	NAMED_VALUES
static int	NO_REPORTS
static int	NO_VALUES
static int	NRV_VALUES
static int	REPORT_ERRORS
static int	REPORT_INFORMATION
static int	REPORT_WARNINGS
static int	RV_VALUES

Fields inherited from interface gsfc.nssdc.cdf.CDFConstants

AHUFF_COMPRESSION, ALPHAOSF1_DECODING, ALPHAOSF1_ENCODING, ALPHAVMSd_DECODING, ALPHAVMSd_ENCODING, ALPHAVMSg_DECODING, ALPHAVMSg_ENCODING, ALPHAVMSi_DECODING, ALPHAVMSi_ENCODING, ARM_BIG_DECODING, ARM_BIG_ENCODING, ARM_LITTLE_DECODING, ARM_LITTLE_ENCODING, ATTR_, ATTR_EXISTENCE_, ATTR_EXISTS, ATTR_MAXgENTRY_, ATTR_MAXrENTRY_, ATTR_MAXzENTRY_, ATTR_NAME_, ATTR_NAME_TRUNC, ATTR_NUMBER_, ATTR_NUMgENTRIES_, ATTR_NUMrENTRIES_, ATTR_NUMzENTRIES_, ATTR_SCOPE_, BACKWARD_, BACKWARDFILEoff, BACKWARDFILEon, BAD_ALLOCATE_RECS, BAD_ARGUMENT, BAD_ATTR_NAME, BAD_ATTR_NUM, BAD_BLOCKING_FACTOR, BAD_CACHE_SIZE, BAD_CDF_EXTENSION, BAD_CDF_ID, BAD_CDF_NAME, BAD_CDFSTATUS, BAD_CHECKSUM, BAD_COMPRESSION_PARM, BAD_DATA_TYPE, BAD_DECODING, BAD_DIM_COUNT, BAD_DIM_INDEX, BAD_DIM_INTERVAL, BAD_DIM_SIZE, BAD_ENCODING, BAD_ENTRY_NUM, BAD_FNC_OR_ITEM, BAD_FORMAT, BAD_INITIAL_RECS, BAD_MAJORITY, BAD_MALLOC, BAD_NEGtoPOSfp0_MODE, BAD_NUM_DIMS, BAD_NUM_ELEMS, BAD_NUM_STRINGS, BAD_NUM_VARS, BAD_READONLY_MODE, BAD_REC_COUNT, BAD_REC_INTERVAL, BAD_REC_NUM, BAD_SCOPE, BAD_SCRATCH_DIR, BAD_SPARSEARRAYS_PARM, BAD_VAR_NAME, BAD_VAR_NUM, BAD_zMODE, BADDATE_LEAPSECOND_UPDATED, BeginUnixTimeEPOCH, BeginUnixTimeEPOCH16, BLOCKINGFACTOR_TOO_SMALL, BLOCKINGFACTOR_TOO_SMALL2, CANNOT_ALLOCATE_RECORDS, CANNOT_CHANGE, CANNOT_COMPRESS, CANNOT_CONVERT_WIDECHAR, CANNOT_COPY, CANNOT_INSERT_RECORDS, CANNOT_SPARSEARRAYS, CANNOT_SPARSERECORDS, CDF_, CDF_ACCESS_, CDF_ATTR_NAME_LEN, CDF_ATTR_NAME_LEN256, CDF_BYTE, CDF_CACHESIZE_, CDF_CHAR, CDF_CHECKSUM_, CDF_CLOSE_ERROR, CDF_COMPRESSION_, CDF_COPYRIGHT_, CDF_COPYRIGHT_LEN, CDF_CREATE_ERROR, CDF_DECODING_, CDF_DELETE_ERROR, CDF_DOUBLE, CDF_ENCODING_, CDF_EPOCH, CDF_EPOCH16, CDF_EXISTS, CDF_FLOAT, CDF_FORMAT_, CDF_INCREMENT_, CDF_INFO_, CDF_INT1, CDF_INT2, CDF_INT4, CDF_INT8, CDF_INTERNAL_ERROR, CDF_LEAPSECONDLASTUPDATED_, CDF_MAJORITY_, CDF_MAX_DIMS, CDF_MAX_PARMS, CDF_MIN_DIMS, CDF_NAME_, CDF_NAME_TRUNC, CDF_NEGtoPOSfp0_MODE_, CDF_NUMATTRS_, CDF_NUMgATTRS_, CDF_NUMrVARS_, CDF_NUMvATTRS_, CDF_NUMzVARS_, CDF_OK, CDF_OPEN_ERROR, CDF_PATHNAME_LEN, CDF_READ_ERROR, CDF_READONLY_MODE_, CDF_REAL4, CDF_REAL8, CDF_RELEASE_, CDF_SAVE_ERROR, CDF_SCRATCHDIR_, CDF_STATUS_, CDF_STATUSTEXT_LEN, CDF_TIME_TT2000, CDF_UCHAR, CDF_UINT1, CDF_UINT2, CDF_UINT4, CDF_VAR_NAME_LEN, CDF_VAR_NAME_LEN256, CDF_VERSION_, CDF_WARN, CDF_WRITE_ERROR, CDF_zMODE_, CDFwithSTATS_, CHECKSUM_, CHECKSUM_ERROR, CHECKSUM_NOT_ALLOWED, CLOSE_, COLUMN_MAJOR, COMPRESS_CACHESIZE_, COMPRESSION_ERROR, CONFIRM_, CORRUPTED_V2_CDF, CORRUPTED_V3_CDF, CREATE_, CURgENTRY_EXISTENCE_, CURrENTRY_EXISTENCE_, CURzENTRY_EXISTENCE_, DATATYPE_MISMATCH, DATATYPE_SIZE_, DECOMPRESSION_ERROR, DECSTATION_DECODING, DECSTATION_ENCODING, DEFAULT_BYTE_PADVALUE, DEFAULT_CHAR_PADVALUE, DEFAULT_DOUBLE_PADVALUE, DEFAULT_EPOCH_PADVALUE, DEFAULT_EPOCH16_PADVALUE, DEFAULT_FLOAT_PADVALUE, DEFAULT_INT1_PADVALUE, DEFAULT_INT2_PADVALUE, DEFAULT_INT4_PADVALUE, DEFAULT_INT8_PADVALUE, DEFAULT_REAL4_PADVALUE, DEFAULT_REAL8_PADVALUE, DEFAULT_TT2000_PADVALUE, DEFAULT_UCHAR_PADVALUE, DEFAULT_UINT1_PADVALUE, DEFAULT_UINT2_PADVALUE, DEFAULT_UINT4_PADVALUE, DELETE_, DID_NOT_COMPRESS, EMPTY_COMPRESSED_CDF, END_OF_VAR, EPOCH_STRING_LEN, EPOCH_STRING_LEN_EXTEND, EPOCH1_STRING_LEN, EPOCH1_STRING_LEN_EXTEND, EPOCH2_STRING_LEN, EPOCH2_STRING_LEN_EXTEND, EPOCH3_STRING_LEN, EPOCH3_STRING_LEN_EXTEND, EPOCH4_STRING_LEN, EPOCH4_STRING_LEN_EXTEND, EPOCHx_FORMAT_MAX, EPOCHx_STRING_MAX, FILLED_TT2000_VALUE, FORCED_PARAMETER, FUNCTION_NOT_SUPPORTED, gENTRY_, gENTRY_DATA_, gENTRY_DATASPEC_, gENTRY_DATATYPE_, gENTRY_EXISTENCE_, gENTRY_NUMELEMS_, GET_, GETCDFCHECKSUM_, GETCDFFILEBACKWARD_, GETCDFVALIDATE_, GETLEAPSECONDSENVVAR_, GLOBAL_SCOPE, GZIP_COMPRESSION, HOST_DECODING, HOST_ENCODING, HP_DECODING, HP_ENCODING, HUFF_COMPRESSION, IA64VMSd_DECODING, IA64VMSd_ENCODING, IA64VMSg_DECODING, IA64VMSg_ENCODING, IA64VMSi_DECODING, IA64VMSi_ENCODING, IBM_PC_OVERFLOW, IBMPC_DECODING, IBMPC_ENCODING, IBMRS_DECODING, IBMRS_ENCODING, ILLEGAL_EPOCH_FIELD, ILLEGAL_EPOCH_VALUE, ILLEGAL_FOR_SCOPE, ILLEGAL_IN_zMODE, ILLEGAL_ON_V1_CDF, ILLEGAL_TT2000_VALUE, IS_A_NETCDF, LIB_COPYRIGHT_, LIB_INCREMENT_, LIB_RELEASE_, LIB_subINCREMENT_, LIB_VERSION_, MAC_DECODING, MAC_ENCODING, MD5_CHECKSUM, MULTI_FILE, MULTI_FILE_FORMAT, NA_FOR_VARIABLE, NEGATIVE_FP_ZERO, NEGtoPOSfp0off, NEGtoPOSfp0on, NETWORK_DECODING, NETWORK_ENCODING, NeXT_DECODING, NeXT_ENCODING, NO_ATTR_SELECTED, NO_CDF_SELECTED, NO_CHECKSUM, NO_COMPRESSION, NO_DELETE_ACCESS, NO_ENTRY_SELECTED, NO_MORE_ACCESS, NO_PADVALUE_SPECIFIED, NO_SPARSEARRAYS, NO_SPARSERECORDS, NO_STATUS_SELECTED, NO_SUCH_ATTR, NO_SUCH_CDF, NO_SUCH_ENTRY, NO_SUCH_RECORD, NO_SUCH_VAR, NO_VAR_SELECTED, NO_VARS_IN_CDF, NO_WRITE_ACCESS, NONE_CHECKSUM, NOT_A_CDF, NOT_A_CDF_OR_NOT_SUPPORTED, NOVARY, NULL_, OPEN_, OPTIMAL_ENCODING_TREES, OTHER_CHECKSUM, PAD_SPARSERECORDS, PPC_DECODING, PPC_ENCODING, PRECEEDING_RECORDS_ALLOCATED, PREV_SPARSERECORDS, PUT_, READ_ONLY_DISTRIBUTION, READ_ONLY_MODE, READONLYoff, READONLYon, rENTRY_, rENTRY_DATA_, rENTRY_DATASPEC_, rENTRY_DATATYPE_, rENTRY_EXISTENCE_, rENTRY_NAME_, rENTRY_NUMELEMS_, rENTRY_NUMSTRINGS_, rENTRY_STRINGSDATA_, RLE_COMPRESSION, RLE_OF_ZEROs, ROW_MAJOR, rVAR_, rVAR_ALLOCATEBLOCK_, rVAR_ALLOCATEDFROM_, rVAR_ALLOCATEDTO_, rVAR_ALLOCATERECS_, rVAR_BLOCKINGFACTOR_, rVAR_CACHESIZE_, rVAR_COMPRESSION_, rVAR_DATA_, rVAR_DATASPEC_, rVAR_DATATYPE_, rVAR_DIMVARYS_, rVAR_EXISTENCE_, rVAR_HYPERDATA_, rVAR_INITIALRECS_, rVAR_MAXallocREC_, rVAR_MAXREC_, rVAR_NAME_, rVAR_nINDEXENTRIES_, rVAR_nINDEXLEVELS_, rVAR_nINDEXRECORDS_, rVAR_NUMallocRECS_, rVAR_NUMBER_, rVAR_NUMELEMS_, rVAR_NUMRECS_, rVAR_PADVALUE_, rVAR_RECORDS_, rVAR_RECORDS_RENUMBER_, rVAR_RECVARY_, rVAR_RESERVEPERCENT_, rVAR_SEQDATA_, rVAR_SEQPOS_, rVAR_SPARSEARRAYS_, rVAR_SPARSERECORDS_, rVARs_CACHESIZE_, rVARs_DIMCOUNTS_, rVARs_DIMINDICES_, rVARs_DIMINTERVALS_, rVARs_DIMSIZES_, rVARs_MAXREC_, rVARs_NUMDIMS_, rVARs_RECCOUNT_, rVARs_RECDATA_, rVARs_RECINTERVAL_, rVARs_RECNUMBER_, SAVE_, SCRATCH_CREATE_ERROR, SCRATCH_DELETE_ERROR, SCRATCH_READ_ERROR, SCRATCH_WRITE_ERROR, SELECT_, SGi_DECODING, SGi_ENCODING, SINGLE_FILE, SINGLE_FILE_FORMAT, SOME_ALREADY_ALLOCATED, STAGE_CACHESIZE_, STATUS_TEXT_, STRING_NOT_UTF8_ENCODING, STRINGDELIMITER, SUN_DECODING, SUN_ENCODING, TOO_MANY_PARMS, TOO_MANY_VARS, TRY_TO_READ_NONSTRING_DATA, TT2000_0_STRING_LEN, TT2000_1_STRING_LEN, TT2000_2_STRING_LEN, TT2000_3_STRING_LEN, TT2000_4_STRING_LEN, TT2000_CDF_MAYNEEDUPDATE, TT2000_TIME_ERROR, TT2000_USED_OUTDATED_TABLE, UNABLE_TO_PROCESS_CDF, UNKNOWN_COMPRESSION, UNKNOWN_SPARSENESS, UNSUPPORTED_OPERATION, VALIDATE_, VALIDATEFILEoff, VALIDATEFILEon, VAR_ALREADY_CLOSED, VAR_CLOSE_ERROR, VAR_CREATE_ERROR, VAR_DELETE_ERROR, VAR_EXISTS, VAR_NAME_TRUNC, VAR_OPEN_ERROR, VAR_READ_ERROR, VAR_SAVE_ERROR, VAR_WRITE_ERROR, VARIABLE_SCOPE, VARY, VAX_DECODING, VAX_ENCODING, VIRTUAL_RECORD_DATA, zENTRY_, zENTRY_DATA_, zENTRY_DATASPEC_, zENTRY_DATATYPE_, zENTRY_EXISTENCE_, zENTRY_NAME_, zENTRY_NUMELEMS_, zENTRY_NUMSTRINGS_, zENTRY_STRINGSDATA_, ZLIB_COMPRESS_ERROR, ZLIB_UNCOMPRESS_ERROR, zMODEoff, zMODEon1, zMODEon2, zVAR_, zVAR_ALLOCATEBLOCK_, zVAR_ALLOCATEDFROM_, zVAR_ALLOCATEDTO_, zVAR_ALLOCATERECS_, zVAR_BLOCKINGFACTOR_, zVAR_CACHESIZE_, zVAR_COMPRESSION_, zVAR_DATA_, zVAR_DATASPEC_, zVAR_DATATYPE_, zVAR_DIMCOUNTS_, zVAR_DIMINDICES_, zVAR_DIMINTERVALS_, zVAR_DIMSIZES_, zVAR_DIMVARYS_, zVAR_EXISTENCE_, zVAR_HYPERDATA_, zVAR_INITIALRECS_, zVAR_MAXallocREC_, zVAR_MAXREC_, zVAR_NAME_, zVAR_nINDEXENTRIES_, zVAR_nINDEXLEVELS_, zVAR_nINDEXRECORDS_, zVAR_NUMallocRECS_, zVAR_NUMBER_, zVAR_NUMDIMS_, zVAR_NUMELEMS_, zVAR_NUMRECS_, zVAR_PADVALUE_, zVAR_RECCOUNT_, zVAR_RECINTERVAL_, zVAR_RECNUMBER_, zVAR_RECORDS_, zVAR_RECORDS_RENUMBER_, zVAR_RECVARY_, zVAR_RESERVEPERCENT_, zVAR_SEQDATA_, zVAR_SEQPOS_, zVAR_SPARSEARRAYS_, zVAR_SPARSERECORDS_, zVARs_CACHESIZE_, zVARs_MAXREC_, zVARs_RECDATA_, zVARs_RECNUMBER_

Constructor Summary

Constructors

Constructor and Description
CDFTools()

Method Summary

Modifier and Type	Method and Description
static void	skeletonCDF(java.lang.String skeletonName, java.lang.String cdfName, boolean delete, boolean log, boolean neg2posfp0, boolean statistics, int zMode, int reportType, int cacheSizeD) skeletonCDF produces a CDF file from a skeleton table.
static void	skeletonCDF(java.lang.String skeletonName, java.lang.String cdfName, boolean delete, boolean log, boolean neg2posfp0, boolean statistics, int zMode, int reportType, int cacheSizeD, int cacheSizeS) skeletonCDF produces a CDF file from a skeleton table.
static void	skeletonCDF(java.lang.String skeletonName, java.lang.String cdfName, boolean delete, boolean log, boolean neg2posfp0, boolean statistics, int zMode, int reportType, int cacheSizeD, int cacheSizeS, int cacheSizeC) skeletonCDF produces a CDF file from a skeleton table.
static void	skeletonCDF(java.lang.String skeletonName, java.lang.String cdfName, boolean delete, boolean log, boolean neg2posfp0, boolean statistics, int zMode, int reportType, java.lang.String cacheSize) skeletonCDF produces a CDF file from a skeleton table.
static void	skeletonTable(java.lang.String skeletonName, java.lang.String cdfName, boolean log, boolean format, boolean neg2posfp0, boolean statistics, boolean screen, boolean page, int values, java.lang.String[] valueList, int zMode, int reportType, int cacheSize) skeletonTable produces a skeleton table from a CDF.
static void	skeletonTable(java.lang.String skeletonName, java.lang.String cdfName, boolean log, boolean format, boolean neg2posfp0, boolean statistics, boolean screen, boolean page, int values, java.lang.String[] valueList, int zMode, int reportType, int cacheSizeD, int cacheSizeS) skeletonTable produces a skeleton table from a CDF.
static void	skeletonTable(java.lang.String skeletonName, java.lang.String cdfName, boolean log, boolean format, boolean neg2posfp0, boolean statistics, boolean screen, boolean page, int values, java.lang.String[] valueList, int zMode, int reportType, int cacheSizeD, int cacheSizeS, int cacheSizeC) skeletonTable produces a skeleton table from a CDF.
static void	skeletonTable(java.lang.String skeletonName, java.lang.String cdfName, boolean log, boolean format, boolean neg2posfp0, boolean statistics, boolean screen, boolean page, int values, java.lang.String[] valueList, int zMode, int reportType, java.lang.String cacheSize) skeletonTable produces a skeleton table from a CDF.
static void	skeletonTable(java.lang.String skeletonName, java.lang.String cdfName, boolean log, boolean format, boolean neg2posfp0, boolean statistics, boolean screen, boolean page, int values, java.lang.String[] valueList, int zMode, int reportType, java.lang.String cacheSize, java.lang.String advFormat) skeletonTable produces a skeleton table from a CDF.

Methods inherited from class java.lang.Object

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

Field Detail

NO_VALUES

public static final int NO_VALUES

See Also:

Constant Field Values

NRV_VALUES

public static final int NRV_VALUES

See Also:

Constant Field Values

RV_VALUES

public static final int RV_VALUES

See Also:

Constant Field Values

ALL_VALUES

public static final int ALL_VALUES

See Also:

Constant Field Values

NAMED_VALUES

public static final int NAMED_VALUES

See Also:

Constant Field Values

NO_REPORTS

public static final int NO_REPORTS

See Also:

Constant Field Values

REPORT_ERRORS

public static final int REPORT_ERRORS

See Also:

Constant Field Values

REPORT_WARNINGS

public static final int REPORT_WARNINGS

See Also:

Constant Field Values

REPORT_INFORMATION

public static final int REPORT_INFORMATION

See Also:

Constant Field Values

Constructor Detail

CDFTools

public CDFTools()

Method Detail

skeletonTable

public static void skeletonTable(java.lang.String skeletonName,
                                 java.lang.String cdfName,
                                 boolean log,
                                 boolean format,
                                 boolean neg2posfp0,
                                 boolean statistics,
                                 boolean screen,
                                 boolean page,
                                 int values,
                                 java.lang.String[] valueList,
                                 int zMode,
                                 int reportType,
                                 int cacheSize)
                          throws java.io.IOException,
                                 java.lang.InterruptedException

skeletonTable produces a skeleton table from a CDF. A skeleton table is a text file which can be read by the SkeletonCDF program to build a skeleton CDF.

Parameters:

skeletonName - is the pathname of the skeleton table to be created. (Do not enter an extension because ".skt" is appended automatically). If null is specified, the skeleton table is named <cdfName>.skt in the current directory

cdfName - The pathname of the CDF from which the skeleton table will be created. Do not enter an extension.

log - Specifies whether or not messages are displayed as the program executes.

format - Specifies whether or not the FORMAT attribute is used when writing variable values (if the FORMAT attribute exists and an entry exists for the variable).

neg2posfp0 - Specifies whether or not -0.0 is converted to 0.0 by the CDF library when read from a CDF. -0.0 is an illegal floating point value on VAXes and DEC Alphas running OpenVMS.

statistics - Specifies whether or not caching statistics are displayed at the end of each CDF.

screen - Specifies whether or not the skeleton table is displayed on the terminal screen (written to the "standard output"). If not, the skeleton table is written to a file.

page - If the skeleton table is being displayed on the terminal screen, specifies whether or not the output is displayed one page (screen) at a time.

values - Specifies which variable values are to be put in the skeleton table. It may be one of the following...

CDFTools.NO_VALUES

Ignore all NRV data values.

CDFTools.NRV_VALUES

Put NRV data values in the skeleton table.

CDFTools.RV_VALUES

Put RV variable values in the skeleton table.

CDFTools.ALL_VALUES

Put all variable values in the skeleton table.

CDFTools.NAMED_VALUES

Put named variables values in the skeleton table. This requires that valueList be non-null

valueList - the named variables to list values.

zMode - Specifies which zMode should be used. May be one of the following...

0

Indicates that zMode is disabled.

1

Indicates that zMode/1 should be used (the dimension variances of rVariables will be preserved).

2

Indicates that zMode/2 should be used (the dimensions of rVariables having a variance of NOVARY (false) are hidden.

reportType - Specifies the types of return status codes from the CDF library which should be reported/displayed. report is a bit mask made up from the following CDFTools.NO_REPORTS, CDFTools.REPORT_ERRORS, CDFTools.REPORT_WARNINGS and CDFTools.REPORT_INFORMATION

cacheSize - The number of buffers to be used for the CDF's dotCDF file. Pass 0 to use the default.

Throws:

java.io.IOException - An exception is thrown if the file is bad or non-existent

java.lang.InterruptedException - An exception is thrown if an interrupt is issued Note:
When running an application that use this static method, make sure this cdf.base system property is defined (to the cdf installation). For example,
java -Dcdf.base=/home/cdf/cdf34_1-dist MyApp

skeletonTable

public static void skeletonTable(java.lang.String skeletonName,
                                 java.lang.String cdfName,
                                 boolean log,
                                 boolean format,
                                 boolean neg2posfp0,
                                 boolean statistics,
                                 boolean screen,
                                 boolean page,
                                 int values,
                                 java.lang.String[] valueList,
                                 int zMode,
                                 int reportType,
                                 int cacheSizeD,
                                 int cacheSizeS)
                          throws java.io.IOException,
                                 java.lang.InterruptedException

skeletonTable produces a skeleton table from a CDF. A skeleton table is a text file which can be read by the SkeletonCDF program to build a skeleton CDF.

Parameters:

skeletonName - is the pathname of the skeleton table to be created. (Do not enter an extension because ".skt" is appended automatically). If null is specified, the skeleton table is named <cdfName>.skt in the current directory

cdfName - The pathname of the CDF from which the skeleton table will be created. Do not enter an extension.

log - Specifies whether or not messages are displayed as the program executes.

format - Specifies whether or not the FORMAT attribute is used when writing variable values (if the FORMAT attribute exists and an entry exists for the variable).

neg2posfp0 - Specifies whether or not -0.0 is converted to 0.0 by the CDF library when read from a CDF. -0.0 is an illegal floating point value on VAXes and DEC Alphas running OpenVMS.

statistics - Specifies whether or not caching statistics are displayed at the end of each CDF.

screen - Specifies whether or not the skeleton table is displayed on the terminal screen (written to the "standard output"). If not, the skeleton table is written to a file.

page - If the skeleton table is being displayed on the terminal screen, specifies whether or not the output is displayed one page (screen) at a time.

values - Specifies which variable values are to be put in the skeleton table. It may be one of the following...

CDFTools.NO_VALUES

Ignore all NRV data values.

CDFTools.NRV_VALUES

Put NRV data values in the skeleton table.

CDFTools.RV_VALUES

Put RV variable values in the skeleton table.

CDFTools.ALL_VALUES

Put all variable values in the skeleton table.

CDFTools.NAMED_VALUES

Put named variables values in the skeleton table. This requires that valueList be non-null

valueList - the named variables to list values.

zMode - Specifies which zMode should be used. May be one of the following...

0

Indicates that zMode is disabled.

1

Indicates that zMode/1 should be used (the dimension variances of rVariables will be preserved).

2

Indicates that zMode/2 should be used (the dimensions of rVariables having a variance of NOVARY (false) are hidden.

reportType - Specifies the types of return status codes from the CDF library which should be reported/displayed. report is a bit mask made up from the following CDFTools.NO_REPORTS, CDFTools.REPORT_ERRORS, CDFTools.REPORT_WARNINGS and CDFTools.REPORT_INFORMATION

cacheSizeD - The number of buffers to be used for the CDF's dotCDF file. Pass 0 to use the default.

cacheSizeS - The number of buffers to be used for the CDF's staging file. Pass 0 to use the default.

Throws:

java.io.IOException - An exception is thrown if the file is bad or non-existent

java.lang.InterruptedException - An exception is thrown if an interrupt is issued Note:
When running an application that use this static method, make sure this cdf.base system property is defined (to the cdf installation). For example,
java -Dcdf.base=/home/cdf/cdf34_1-dist MyApp

skeletonTable

public static void skeletonTable(java.lang.String skeletonName,
                                 java.lang.String cdfName,
                                 boolean log,
                                 boolean format,
                                 boolean neg2posfp0,
                                 boolean statistics,
                                 boolean screen,
                                 boolean page,
                                 int values,
                                 java.lang.String[] valueList,
                                 int zMode,
                                 int reportType,
                                 int cacheSizeD,
                                 int cacheSizeS,
                                 int cacheSizeC)
                          throws java.io.IOException,
                                 java.lang.InterruptedException

skeletonTable produces a skeleton table from a CDF. A skeleton table is a text file which can be read by the SkeletonCDF program to build a skeleton CDF.

Parameters:

skeletonName - is the pathname of the skeleton table to be created. (Do not enter an extension because ".skt" is appended automatically). If null is specified, the skeleton table is named <cdfName>.skt in the current directory

cdfName - The pathname of the CDF from which the skeleton table will be created. Do not enter an extension.

log - Specifies whether or not messages are displayed as the program executes.

format - Specifies whether or not the FORMAT attribute is used when writing variable values (if the FORMAT attribute exists and an entry exists for the variable).

neg2posfp0 - Specifies whether or not -0.0 is converted to 0.0 by the CDF library when read from a CDF. -0.0 is an illegal floating point value on VAXes and DEC Alphas running OpenVMS.

statistics - Specifies whether or not caching statistics are displayed at the end of each CDF.

screen - Specifies whether or not the skeleton table is displayed on the terminal screen (written to the "standard output"). If not, the skeleton table is written to a file.

page - If the skeleton table is being displayed on the terminal screen, specifies whether or not the output is displayed one page (screen) at a time.

values - Specifies which variable values are to be put in the skeleton table. It may be one of the following...

CDFTools.NO_VALUES

Ignore all NRV data values.

CDFTools.NRV_VALUES

Put NRV data values in the skeleton table.

CDFTools.RV_VALUES

Put RV variable values in the skeleton table.

CDFTools.ALL_VALUES

Put all variable values in the skeleton table.

CDFTools.NAMED_VALUES

Put named variables values in the skeleton table. This requires that valueList be non-null

valueList - the named variables to list values.

zMode - Specifies which zMode should be used. May be one of the following...

0

Indicates that zMode is disabled.

1

Indicates that zMode/1 should be used (the dimension variances of rVariables will be preserved).

2

Indicates that zMode/2 should be used (the dimensions of rVariables having a variance of NOVARY (false) are hidden.

reportType - Specifies the types of return status codes from the CDF library which should be reported/displayed. report is a bit mask made up from the following CDFTools.NO_REPORTS, CDFTools.REPORT_ERRORS, CDFTools.REPORT_WARNINGS and CDFTools.REPORT_INFORMATION

cacheSizeD - The number of buffers to be used for the CDF's dotCDF file. Pass 0 to use the default.

cacheSizeS - The number of buffers to be used for the CDF's staging file. Pass 0 to use the default.

cacheSizeC - The number of buffers to be used for the CDF's compression scratch file. Pass 0 to use the default.

Throws:

java.io.IOException - An exception is thrown if the file is bad or non-existent

java.lang.InterruptedException - An exception is thrown if an interrupt is issued Note:
When running an application that use this static method, make sure this cdf.base system property is defined (to the cdf installation). For example,
java -Dcdf.base=/home/cdf/cdf34_1-dist MyApp

skeletonTable

public static void skeletonTable(java.lang.String skeletonName,
                                 java.lang.String cdfName,
                                 boolean log,
                                 boolean format,
                                 boolean neg2posfp0,
                                 boolean statistics,
                                 boolean screen,
                                 boolean page,
                                 int values,
                                 java.lang.String[] valueList,
                                 int zMode,
                                 int reportType,
                                 java.lang.String cacheSize)
                          throws java.io.IOException,
                                 java.lang.InterruptedException

skeletonTable produces a skeleton table from a CDF. A skeleton table is a text file which can be read by the SkeletonCDF program to build a skeleton CDF.

Parameters:

skeletonName - is the pathname of the skeleton table to be created. (Do not enter an extension because ".skt" is appended automatically). If null is specified, the skeleton table is named <cdfName>.skt in the current directory

cdfName - The pathname of the CDF from which the skeleton table will be created. Do not enter an extension.

log - Specifies whether or not messages are displayed as the program executes.

format - Specifies whether or not the FORMAT attribute is used when writing variable values (if the FORMAT attribute exists and an entry exists for the variable).

neg2posfp0 - Specifies whether or not -0.0 is converted to 0.0 by the CDF library when read from a CDF. -0.0 is an illegal floating point value on VAXes and DEC Alphas running OpenVMS.

statistics - Specifies whether or not caching statistics are displayed at the end of each CDF.

screen - Specifies whether or not the skeleton table is displayed on the terminal screen (written to the "standard output"). If not, the skeleton table is written to a file.

page - If the skeleton table is being displayed on the terminal screen, specifies whether or not the output is displayed one page (screen) at a time.

values - Specifies which variable values are to be put in the skeleton table. It may be one of the following...

CDFTools.NO_VALUES

Ignore all NRV data values.

CDFTools.NRV_VALUES

Put NRV data values in the skeleton table.

CDFTools.RV_VALUES

Put RV variable values in the skeleton table.

CDFTools.ALL_VALUES

Put all variable values in the skeleton table.

CDFTools.NAMED_VALUES

Put named variables values in the skeleton table. This requires that valueList be non-null

valueList - the named variables to list values.

zMode - Specifies which zMode should be used. May be one of the following...

0

Indicates that zMode is disabled.

1

Indicates that zMode/1 should be used (the dimension variances of rVariables will be preserved).

2

Indicates that zMode/2 should be used (the dimensions of rVariables having a variance of NOVARY (false) are hidden.

reportType - Specifies the types of return status codes from the CDF library which should be reported/displayed. report is a bit mask made up from the following CDFTools.NO_REPORTS, CDFTools.REPORT_ERRORS, CDFTools.REPORT_WARNINGS and CDFTools.REPORT_INFORMATION

cacheSize - The number of buffers to be used for the CDF's dotCDF file, staging file, and compression scratch file. This field used only in the CDF access process will not change anything to the contents of the skeleton table. Large number(s) will likely reduce physical I/Os if variable data are involved. If this field is null, the default cache sizes chosen by the CDF library are used. The cache sizes are specified with a comma-separated list of <number><type> pairs where <number> is the number of cache buffers and <type> is the type of file. The file <type>'s are as follows: `d' for the dotCDF file, `s' for the staging file, and `c' for the compression scratch file. For example, `200d,100s' specifies 200 cache buffers for the dotCDF file and 100 cache buffers for the staging file. The dotCDF file cache size can also be specified without the `d' <type> for compatibility with older CDF releases (eg. `200,100s'). Note that not all of the file types must be specified. Those not specified will receive a default cache size.

Throws:

java.io.IOException - An exception is thrown if the file is bad or non-existent

java.lang.InterruptedException - An exception is thrown if an interrupt is issued Note:
When running an application that use this static method, make sure this cdf.base system property is defined (to the cdf installation). For example,
java -Dcdf.base=/home/cdf/cdf34_1-dist MyApp

skeletonTable

public static void skeletonTable(java.lang.String skeletonName,
                                 java.lang.String cdfName,
                                 boolean log,
                                 boolean format,
                                 boolean neg2posfp0,
                                 boolean statistics,
                                 boolean screen,
                                 boolean page,
                                 int values,
                                 java.lang.String[] valueList,
                                 int zMode,
                                 int reportType,
                                 java.lang.String cacheSize,
                                 java.lang.String advFormat)
                          throws java.io.IOException,
                                 java.lang.InterruptedException

skeletonTable produces a skeleton table from a CDF. A skeleton table is a text file which can be read by the SkeletonCDF program to build a skeleton CDF.

Parameters:

skeletonName - is the pathname of the skeleton table to be created. (Do not enter an extension because ".skt" is appended automatically). If null is specified, the skeleton table is named <cdfName>.skt in the current directory

cdfName - The pathname of the CDF from which the skeleton table will be created. Do not enter an extension.

log - Specifies whether or not messages are displayed as the program executes.

format - Specifies whether or not the FORMAT attribute is used when writing variable values (if the FORMAT attribute exists and an entry exists for the variable). Metadata always uses noformat form.

neg2posfp0 - Specifies whether or not -0.0 is converted to 0.0 by the CDF library when read from a CDF. -0.0 is an illegal floating point value on VAXes and DEC Alphas running OpenVMS.

statistics - Specifies whether or not caching statistics are displayed at the end of each CDF.

screen - Specifies whether or not the skeleton table is displayed on the terminal screen (written to the "standard output"). If not, the skeleton table is written to a file.

page - If the skeleton table is being displayed on the terminal screen, specifies whether or not the output is displayed one page (screen) at a time.

values - Specifies which variable values are to be put in the skeleton table. It may be one of the following...

CDFTools.NO_VALUES

Ignore all NRV data values.

CDFTools.NRV_VALUES

Put NRV data values in the skeleton table.

CDFTools.RV_VALUES

Put RV variable values in the skeleton table.

CDFTools.ALL_VALUES

Put all variable values in the skeleton table.

CDFTools.NAMED_VALUES

Put named variables values in the skeleton table. This requires that valueList be non-null

valueList - the named variables to list values.

zMode - Specifies which zMode should be used. May be one of the following...

0

Indicates that zMode is disabled.

1

Indicates that zMode/1 should be used (the dimension variances of rVariables will be preserved).

2

Indicates that zMode/2 should be used (the dimensions of rVariables having a variance of NOVARY (false) are hidden.

reportType - Specifies the types of return status codes from the CDF library which should be reported/displayed. report is a bit mask made up from the following CDFTools.NO_REPORTS, CDFTools.REPORT_ERRORS, CDFTools.REPORT_WARNINGS and CDFTools.REPORT_INFORMATION

cacheSize - The number of buffers to be used for the CDF's dotCDF file, staging file, and compression scratch file. This field used only in the CDF access process will not change anything to the contents of the skeleton table. Large number(s) will likely reduce physical I/Os if variable data are involved. If this field is null, the default cache sizes chosen by the CDF library are used. The cache sizes are specified with a comma-separated list of <number><type> pairs where <number> is the number of cache buffers and <type> is the type of file. The file <type>'s are as follows: `d' for the dotCDF file, `s' for the staging file, and `c' for the compression scratch file. For example, `200d,100s' specifies 200 cache buffers for the dotCDF file and 100 cache buffers for the staging file. The dotCDF file cache size can also be specified without the `d' <type> for compatibility with older CDF releases (eg. `200,100s'). Note that not all of the file types must be specified. Those not specified will receive a default cache size.

advFormat - This new argument supersedes the prior format argument. It accepts one of "best", "no", "metaonly", "dataonly" or "all" options. "best" option all use the best approach to encode floating point data with a higher precision, even larger than the FORMAT attribute for both metadata and data. "no" option will not use and FORMAT attribute, "metaonly" will use FORMAT attribute for metdata only. "dataonly" will use FORMAT attribute for data only. "all" option will use FORMAT attribute for both metadata and data. "best" option is the default. If null is passed in, which is the old method calling this method, it is changed to "best" option that works as C based tool would do.

Throws:

java.io.IOException - An exception is thrown if the file is bad or non-existent

java.lang.InterruptedException - An exception is thrown if an interrupt is issued Note:
When running an application that use this static method, make sure this cdf.base system property is defined (to the cdf installation). For example,
java -Dcdf.base=/home/cdf/cdf34_1-dist MyApp

skeletonCDF

public static void skeletonCDF(java.lang.String skeletonName,
                               java.lang.String cdfName,
                               boolean delete,
                               boolean log,
                               boolean neg2posfp0,
                               boolean statistics,
                               int zMode,
                               int reportType,
                               int cacheSizeD)
                        throws java.io.IOException,
                               java.lang.InterruptedException

skeletonCDF produces a CDF file from a skeleton table. A skeleton table is a text file which can be made through a text editor, or by SkeletonCDF program from an existng CDF.

Parameters:

skeletonName - is the pathname of the skeleton table to be used to create a CDF. (Do not enter an extension because ".skt" is appended automatically). If null is specified, the skeleton table is named <cdfName>.skt in the current directory

cdfName - The pathname of the created CDF from the skeleton table. Do not enter an extension.

delete - specifies whether or not the CDF should be deleted if it already exists.

log - Specifies whether or not messages are displayed as the program executes.

neg2posfp0 - Specifies whether or not -0.0 is converted to 0.0 by the CDF library when read from a CDF. -0.0 is an illegal floating point value on VAXes and DEC Alphas running OpenVMS.

statistics - Specifies whether or not caching statistics are displayed at the end of each CDF.

zMode - Specifies which zMode should be used. May be one of the following...

0

Indicates that zMode is disabled.

1

Indicates that zMode/1 should be used (the dimension variances of rVariables will be preserved).

2

Indicates that zMode/2 should be used (the dimensions of rVariables having a variance of NOVARY (false) are hidden.

reportType - Specifies the types of return status codes from the CDF library which should be reported/displayed. report is a bit mask made up from the following CDFTools.NO_REPORTS, CDFTools.REPORT_ERRORS, CDFTools.REPORT_WARNINGS and CDFTools.REPORT_INFORMATION

cacheSizeD - The number of buffers to be used for the CDF's dotCDF file. Pass 0 to use the default.

Throws:

java.io.IOException - An exception is thrown if the file is bad or non-existent

java.lang.InterruptedException - An exception is thrown if an interrupt is issued Note:
When running an application that use this static method, make sure this cdf.base system property is defined (to the cdf installation). For example,
java -Dcdf.base=/home/cdf/cdf34_1-dist MyApp

skeletonCDF

public static void skeletonCDF(java.lang.String skeletonName,
                               java.lang.String cdfName,
                               boolean delete,
                               boolean log,
                               boolean neg2posfp0,
                               boolean statistics,
                               int zMode,
                               int reportType,
                               int cacheSizeD,
                               int cacheSizeS)
                        throws java.io.IOException,
                               java.lang.InterruptedException

skeletonCDF produces a CDF file from a skeleton table. A skeleton table is a text file which can be made through a text editor, or by SkeletonCDF program from an existng CDF.

Parameters:

skeletonName - is the pathname of the skeleton table to be used to create a CDF. (Do not enter an extension because ".skt" is appended automatically). If null is specified, the skeleton table is named <cdfName>.skt in the current directory

cdfName - The pathname of the created CDF from the skeleton table. Do not enter an extension.

delete - specifies whether or not the CDF should be deleted if it already exists.

log - Specifies whether or not messages are displayed as the program executes.

neg2posfp0 - Specifies whether or not -0.0 is converted to 0.0 by the CDF library when read from a CDF. -0.0 is an illegal floating point value on VAXes and DEC Alphas running OpenVMS.

statistics - Specifies whether or not caching statistics are displayed at the end of each CDF.

zMode - Specifies which zMode should be used. May be one of the following...

0

Indicates that zMode is disabled.

1

Indicates that zMode/1 should be used (the dimension variances of rVariables will be preserved).

2

Indicates that zMode/2 should be used (the dimensions of rVariables having a variance of NOVARY (false) are hidden.

reportType - Specifies the types of return status codes from the CDF library which should be reported/displayed. report is a bit mask made up from the following CDFTools.NO_REPORTS, CDFTools.REPORT_ERRORS, CDFTools.REPORT_WARNINGS and CDFTools.REPORT_INFORMATION

cacheSizeD - The number of buffers to be used for the CDF's dotCDF file. Pass 0 to use the default.

cacheSizeS - The number of buffers to be used for the CDF's staging file. Pass 0 to use the default.

Throws:

java.io.IOException - An exception is thrown if the file is bad or non-existent

java.lang.InterruptedException - An exception is thrown if an interrupt is issued Note:
When running an application that use this static method, make sure this cdf.base system property is defined (to the cdf installation). For example,
java -Dcdf.base=/home/cdf/cdf34_1-dist MyApp

skeletonCDF

public static void skeletonCDF(java.lang.String skeletonName,
                               java.lang.String cdfName,
                               boolean delete,
                               boolean log,
                               boolean neg2posfp0,
                               boolean statistics,
                               int zMode,
                               int reportType,
                               int cacheSizeD,
                               int cacheSizeS,
                               int cacheSizeC)
                        throws java.io.IOException,
                               java.lang.InterruptedException

skeletonCDF produces a CDF file from a skeleton table. A skeleton table is a text file which can be made through a text editor, or by SkeletonCDF program from an existng CDF.

Parameters:

skeletonName - is the pathname of the skeleton table to be used to create a CDF. (Do not enter an extension because ".skt" is appended automatically). If null is specified, the skeleton table is named <cdfName>.skt in the current directory

cdfName - The pathname of the created CDF from the skeleton table. Do not enter an extension.

delete - specifies whether or not the CDF should be deleted if it already exists.

log - Specifies whether or not messages are displayed as the program executes.

neg2posfp0 - Specifies whether or not -0.0 is converted to 0.0 by the CDF library when read from a CDF. -0.0 is an illegal floating point value on VAXes and DEC Alphas running OpenVMS.

statistics - Specifies whether or not caching statistics are displayed at the end of each CDF.

zMode - Specifies which zMode should be used. May be one of the following...

0

Indicates that zMode is disabled.

1

Indicates that zMode/1 should be used (the dimension variances of rVariables will be preserved).

2

Indicates that zMode/2 should be used (the dimensions of rVariables having a variance of NOVARY (false) are hidden.

reportType - Specifies the types of return status codes from the CDF library which should be reported/displayed. report is a bit mask made up from the following CDFTools.NO_REPORTS, CDFTools.REPORT_ERRORS, CDFTools.REPORT_WARNINGS and CDFTools.REPORT_INFORMATION

cacheSizeD - The number of buffers to be used for the CDF's dotCDF file. Pass 0 to use the default.

cacheSizeS - The number of buffers to be used for the CDF's staging file. Pass 0 to use the default.

cacheSizeC - The number of buffers to be used for the CDF's compression scratch file. Pass 0 to use the default.

Throws:

java.io.IOException - An exception is thrown if the file is bad or non-existent

java.lang.InterruptedException - An exception is thrown if an interrupt is issued Note:
When running an application that use this static method, make sure this cdf.base system property is defined (to the cdf installation). For example,
java -Dcdf.base=/home/cdf/cdf34_1-dist MyApp

skeletonCDF

public static void skeletonCDF(java.lang.String skeletonName,
                               java.lang.String cdfName,
                               boolean delete,
                               boolean log,
                               boolean neg2posfp0,
                               boolean statistics,
                               int zMode,
                               int reportType,
                               java.lang.String cacheSize)
                        throws java.io.IOException,
                               java.lang.InterruptedException

skeletonCDF produces a CDF file from a skeleton table. A skeleton table is a text file which can be made through a text editor, or by SkeletonCDF program from an existng CDF.

Parameters:

skeletonName - is the pathname of the skeleton table to be used to create a CDF. (Do not enter an extension because ".skt" is appended automatically). If null is specified, the skeleton table is named <cdfName>.skt in the current directory

cdfName - The pathname of the created CDF from the skeleton table. Do not enter an extension.

delete - specifies whether or not the CDF should be deleted if it already exists.

log - Specifies whether or not messages are displayed as the program executes.

neg2posfp0 - Specifies whether or not -0.0 is converted to 0.0 by the CDF library when read from a CDF. -0.0 is an illegal floating point value on VAXes and DEC Alphas running OpenVMS.

statistics - Specifies whether or not caching statistics are displayed at the end of each CDF.

zMode - Specifies which zMode should be used. May be one of the following...

0

Indicates that zMode is disabled.

1

Indicates that zMode/1 should be used (the dimension variances of rVariables will be preserved).

2

Indicates that zMode/2 should be used (the dimensions of rVariables having a variance of NOVARY (false) are hidden.

reportType - Specifies the types of return status codes from the CDF library which should be reported/displayed. report is a bit mask made up from the following CDFTools.NO_REPORTS, CDFTools.REPORT_ERRORS, CDFTools.REPORT_WARNINGS and CDFTools.REPORT_INFORMATION

cacheSize - The number of buffers to be used for the CDF's dotCDF file, staging file, and compression scratch file. This field used only in the CDF access process will not change the contents of the CDF. Large number(s) will likely reduce physical I/Os if variable data are involved. If this field is null, default cache sizes chosen by the CDF library are used. The cache sizes are specified with a comma-separated list of <number><type> pairs where <number> is the number of cache buffers and <type> is the type of file. The file <type>'s are as follows: `d' for the dotCDF file, `s' for the staging file, and `c' for the compression scratch file. For example, `200d,100s' specifies 200 cache buffers for the dotCDF file and 100 cache buffers for the staging file. The dotCDF file cache size can also be specified without the `d' <type> for compatibility with older CDF releases (eg. `200,100s'). Note that not all of the file types must be specified. Those not specified will receive a default cache size.

Throws:

java.io.IOException - An exception is thrown if the file is bad or non-existent

java.lang.InterruptedException - An exception is thrown if an interrupt is issued Note:
When running an application that use this static method, make sure this cdf.base system property is defined (to the cdf installation). For example,
java -Dcdf.base=/home/cdf/cdf34_1-dist MyApp