eu.deepen.cdf.library

Class CDFLibrary

java.lang.Object

eu.deepen.cdf.library.CDFLibrary

public class CDFLibrary
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String	DATASETATTRIBUTE_FIELD_DESCRIPTION
private static java.lang.String	DATASETATTRIBUTE_UNITS
private static java.lang.String	PATH_SEPARATOR
private static java.lang.String	XMLFILENAME

Constructor Summary

Constructors

Constructor and Description
CDFLibrary()

Method Summary

Methods

Modifier and Type	Method and Description
void	addAttribute(int dataset_id, byte[] attribute_value, java.lang.String attribute_type) Insert a description in UTF-8 format into the dataset identified by datase_id.
void	closeFile(int file_id) Close a CDF file
void	createDataset(int file_id, java.lang.String datasetname, java.lang.String groupName, DataStructure<?> dset_data, java.lang.String attribute_units, java.lang.String field_description) Create a new dataset named datasetname into the group groupName
int	createFile(java.lang.String cdfFileName) Create a new CDF file named cdfFileName and return its id
int	createGroup(int file_id, java.lang.String groupName) Create a new group named groupName in the file referenced by file_id and return the id of the new group
private void	createIntegerDoubleDataset(int file_id, java.lang.String datasetname, java.lang.String groupName, DataStructure<?> dset_data, java.lang.String attribute_units, java.lang.String field_description)
private void	createStringDataset(int file_id, java.lang.String datasetname, java.lang.String groupName, DataStructure<?> dset_data, java.lang.String attribute_units, java.lang.String field_description)
KeywordsBean	getKeywords() Read and parse the xml file and return the it through the associated bean
int	openFile(java.lang.String cdfFileName) Open a CDF file named cdfFileName.
void	printGroup(int g_id, java.lang.String indent) Recursively print a group and its members.
DataStructure<?>	readDoubleDataset(int file_id, java.lang.String dsetname) Read a dataset (dsetname) of double values and return a DataStructure
DataStructure<?>	readIntegerDataset(int file_id, java.lang.String dsetname) Read a dataset (dsetname) of int values and return a DataStructure
private KeywordsBean	readKeywordsXML()
DataStructure<?>	readStringDataset(int file_id, java.lang.String dsetname) Read a dataset (dsetname) of String values and return a DataStructure
boolean	saveKeywords(KeywordsBean keywords) Save in xml format the keywords bean

Methods inherited from class java.lang.Object

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

Field Detail

PATH_SEPARATOR

private static final java.lang.String PATH_SEPARATOR

See Also:

Constant Field Values

DATASETATTRIBUTE_UNITS

private static final java.lang.String DATASETATTRIBUTE_UNITS

See Also:

Constant Field Values

DATASETATTRIBUTE_FIELD_DESCRIPTION

private static final java.lang.String DATASETATTRIBUTE_FIELD_DESCRIPTION

See Also:

Constant Field Values

XMLFILENAME

private static final java.lang.String XMLFILENAME

See Also:

Constant Field Values

Constructor Detail

CDFLibrary

public CDFLibrary()

Method Detail

readDoubleDataset

public DataStructure<?> readDoubleDataset(int file_id,
                                 java.lang.String dsetname)

Read a dataset (dsetname) of double values and return a DataStructure

Parameters:

file_id - identifier of CDF file returned by openFile(String) or createFile(String)

dsetname - Path of Dataset to read. String have to start with "/" char.

Returns:

DataStructure The object can be cast to the right type of Array structure (see data package)

readIntegerDataset

public DataStructure<?> readIntegerDataset(int file_id,
                                  java.lang.String dsetname)

Read a dataset (dsetname) of int values and return a DataStructure

Parameters:

file_id - identifier of CDF file returned by openFile(String) or createFile(String)

dsetname - Path of Dataset to read. String have to start with "/" char.

Returns:

DataStructure The object can be casted to the right type of Array structure (see data package)

readStringDataset

public DataStructure<?> readStringDataset(int file_id,
                                 java.lang.String dsetname)

Read a dataset (dsetname) of String values and return a DataStructure

Parameters:

file_id - identifier of CDF file returned by openFile(String) or createFile(String)

dsetname - Path of Dataset to read. String have to start with "/" char.

Returns:

DataStructure The object can be casted to the right type of Array structure (see data package)

printGroup

public void printGroup(int g_id,
              java.lang.String indent)
                throws java.lang.Exception

Recursively print a group and its members.

Parameters:

g_id - Identifier of a group

indent - Indentation of output string

Throws:

java.lang.Exception

createGroup

public int createGroup(int file_id,
              java.lang.String groupName)

Create a new group named groupName in the file referenced by file_id and return the id of the new group

Parameters:

file_id - id of the file where to create the new group

groupName - name of the group to be created. The string have to start with "/" char.

Returns:

id of the created group

addAttribute

public void addAttribute(int dataset_id,
                byte[] attribute_value,
                java.lang.String attribute_type)

Insert a description in UTF-8 format into the dataset identified by datase_id.

Parameters:

dataset_id - Identifier of dataset

attribute_value - Description to insert

attribute_type - Used as prefix of description. Only "Description" and "Units" are used with this library

createDataset

public void createDataset(int file_id,
                 java.lang.String datasetname,
                 java.lang.String groupName,
                 DataStructure<?> dset_data,
                 java.lang.String attribute_units,
                 java.lang.String field_description)

Create a new dataset named datasetname into the group groupName

Parameters:

file_id - Identifier of CDF file

datasetname - Name of the dataset to be created

groupName - Name of the group where to create the new dataset. groupName have to start with "/" char.

dset_data - Values of the new dataset

attribute_units - Units attribute for dataset

field_description - Description attribute for dataset

createIntegerDoubleDataset

private void createIntegerDoubleDataset(int file_id,
                              java.lang.String datasetname,
                              java.lang.String groupName,
                              DataStructure<?> dset_data,
                              java.lang.String attribute_units,
                              java.lang.String field_description)

createStringDataset

private void createStringDataset(int file_id,
                       java.lang.String datasetname,
                       java.lang.String groupName,
                       DataStructure<?> dset_data,
                       java.lang.String attribute_units,
                       java.lang.String field_description)

createFile

public int createFile(java.lang.String cdfFileName)

Create a new CDF file named cdfFileName and return its id

Parameters:

cdfFileName - Name of CDF file to be created

Returns:

The identifier of the new CDF file

openFile

public int openFile(java.lang.String cdfFileName)

Open a CDF file named cdfFileName. The file will be open in read-only mode.

Parameters:

cdfFileName - The name of CDF file to open.

Returns:

the identifier of the opened CDF file.

closeFile

public void closeFile(int file_id)
               throws ncsa.hdf.hdf5lib.exceptions.HDF5LibraryException

Close a CDF file

Parameters:

file_id - the identifier of the file to be closed

Throws:

ncsa.hdf.hdf5lib.exceptions.HDF5LibraryException

getKeywords

public KeywordsBean getKeywords()

Read and parse the xml file and return the it through the associated bean

Returns:

@see eu.deepen.cdf.library.keywords.KeywordsBean

saveKeywords

public boolean saveKeywords(KeywordsBean keywords)

Save in xml format the keywords bean

Parameters:

keywords - Bean with defined keywords

Returns:

true if operation is successful, false otherwise

readKeywordsXML

private KeywordsBean readKeywordsXML()