com.pervasive.datarush.operators.io.staging

Class DatasetMetadata

java.lang.Object

com.pervasive.datarush.operators.io.staging.DatasetMetadata

public final class DatasetMetadata
extends Object

The metadata describing a staging dataset. This header is found on all staging dataset files.

Constructor Summary

Constructors

Constructor and Description
DatasetMetadata(FileClient fileClient, File dataset) Creates a DatasetMetadata for an existing dataset.
DatasetMetadata(FileClient fileClient, Path dataset) Creates a DatasetMetadata for an existing dataset.
DatasetMetadata(FileClient fileClient, String datasetName) Creates a DatasetMetadata for an existing dataset.

Method Summary

Modifier and Type	Method and Description
int	getBlockSize() Returns the block size of the data set.
long	getRowCount() Returns the number of rows in the data set or -1 if unknown.
TokenType	getSchema() Returns the schema of the data set.
DatasetStorageFormat	getStorageFormat() Gets the storage format of the data-set.
static boolean	isDataset(URL file) Returns whether the given file is a valid dataset

Methods inherited from class java.lang.Object

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

Constructor Detail

DatasetMetadata

public DatasetMetadata(FileClient fileClient,
                       String datasetName)

Creates a DatasetMetadata for an existing dataset. Loads the specified dataset.

Parameters:

fileClient - the client

datasetName - the name of the dataset to load

DatasetMetadata

public DatasetMetadata(FileClient fileClient,
                       File dataset)

Creates a DatasetMetadata for an existing dataset. Loads the specified dataset.

Parameters:

fileClient - the client

dataset - the name of the dataset to load

DatasetMetadata

public DatasetMetadata(FileClient fileClient,
                       Path dataset)

Creates a DatasetMetadata for an existing dataset. Loads the specified dataset.

Parameters:

fileClient - the client

dataset - the name of the dataset to load

Method Detail

getStorageFormat

public final DatasetStorageFormat getStorageFormat()

Gets the storage format of the data-set.

Returns:

the storage format of the data-set.

getSchema

public final TokenType getSchema()

Returns the schema of the data set.

Returns:

the schema of the data set.

getBlockSize

public final int getBlockSize()

Returns the block size of the data set.

Returns:

the block size of the data set.

getRowCount

public final long getRowCount()

Returns the number of rows in the data set or -1 if unknown.

Returns:

the number of rows in the data set or -1 if unknown.

isDataset

public static boolean isDataset(URL file)

Returns whether the given file is a valid dataset

Parameters:

file - the file

Returns:

whether the given file is a valid dataset