Class DataDescriptor

java.lang.Object

gaiasky.util.datadesc.DataDescriptor

public class DataDescriptor
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
List<DatasetDesc>	datasets	Raw datasets list, where each dataset has a type
static DataDescriptor	localDataDescriptor
int	numUpdates
String[]	recommended	Recommended datasets as an array of keys.
static DataDescriptor	serverDataDescriptor
List<DatasetType>	types	View organised by types, where each time has a list of datasets
boolean	updatesAvailable

Constructor Summary

Constructors

Constructor	Description
DataDescriptor(List<DatasetType> types, List<DatasetDesc> datasets)
DataDescriptor(List<DatasetType> types, List<DatasetDesc> datasets, String[] recommended)

Method Summary

Modifier and Type	Method	Description
boolean	datasetPresent(String key)	Checks whether the dataset with the given name is present in the data folder.
DatasetDesc	findDatasetByDescriptor(Path descriptorFile)	Finds the dataset with the given descriptor file in the dataset descriptor list.
DatasetDesc	findDatasetByKey(String key)	Finds the dataset with the given key in the dataset descriptor list.
DatasetDesc	findDatasetByName(String name)	Finds the dataset with the given name in the dataset descriptor list.

Methods inherited from class Object

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

Field Details

localDataDescriptor

public static DataDescriptor localDataDescriptor

serverDataDescriptor

public static DataDescriptor serverDataDescriptor

types

public List<DatasetType> types

View organised by types, where each time has a list of datasets

datasets

public List<DatasetDesc> datasets

Raw datasets list, where each dataset has a type

recommended

public String[] recommended

Recommended datasets as an array of keys.

updatesAvailable

public boolean updatesAvailable

numUpdates

public int numUpdates

Constructor Details

DataDescriptor

public DataDescriptor(List<DatasetType> types,
 List<DatasetDesc> datasets,
 String[] recommended)

DataDescriptor

public DataDescriptor(List<DatasetType> types,
 List<DatasetDesc> datasets)

Method Details

findDatasetByName

public DatasetDesc findDatasetByName(String name)

Finds the dataset with the given name in the dataset descriptor list.

Parameters:

name - The name of the dataset.

Returns:

The dataset descriptor or null if it was not found.

findDatasetByKey

public DatasetDesc findDatasetByKey(String key)

Finds the dataset with the given key in the dataset descriptor list.

Parameters:

key - The key of the dataset.

Returns:

The dataset descriptor or null if it was not found.

datasetPresent

public boolean datasetPresent(String key)

Checks whether the dataset with the given name is present in the data folder.

Parameters:

key - The dataset key.

Returns:

True if the dataset is present, false otherwise.

findDatasetByDescriptor

public DatasetDesc findDatasetByDescriptor(Path descriptorFile)
                                    throws IOException

Finds the dataset with the given descriptor file in the dataset descriptor list.

Parameters:

descriptorFile - The filename of the descriptor file.

Returns:

The dataset descriptor or null if it was not found.

Throws:

IOException