io.cdap.cdap.api.dataset.lib

Class IndexedTableDefinition

java.lang.Object

io.cdap.cdap.api.dataset.lib.AbstractDatasetDefinition<D,DatasetAdmin>

io.cdap.cdap.api.dataset.lib.CompositeDatasetDefinition<IndexedTable>

io.cdap.cdap.api.dataset.lib.IndexedTableDefinition

All Implemented Interfaces:

DatasetDefinition<IndexedTable,DatasetAdmin>, Reconfigurable

@Beta
public class IndexedTableDefinition
extends CompositeDatasetDefinition<IndexedTable>

DatasetDefinition for IndexedTable.

Field Summary

Fields inherited from interface io.cdap.cdap.api.dataset.DatasetDefinition

NO_ARGUMENTS

Constructor Summary

Constructors

Constructor and Description
IndexedTableDefinition(String name, DatasetDefinition<? extends Table,?> tableDef)

Method Summary

Modifier and Type	Method and Description
DatasetSpecification	configure(String instanceName, DatasetProperties properties) Configures new instance of the dataset.
IndexedTable	getDataset(DatasetContext datasetContext, DatasetSpecification spec, Map<String,String> arguments, ClassLoader classLoader) Provides dataset to be used to perform data operations on the dataset instance data defined by passed DatasetSpecification and the given arguments.
DatasetSpecification	reconfigure(String instanceName, DatasetProperties newProperties, DatasetSpecification currentSpec) Validates the new properties, including a compatibility check with the existing spec, and returns a new dataset specification for the dataset instance.

Methods inherited from class io.cdap.cdap.api.dataset.lib.CompositeDatasetDefinition

getAdmin, getDataset, getDelegate

Methods inherited from class io.cdap.cdap.api.dataset.lib.AbstractDatasetDefinition

getName, reconfigure

Methods inherited from class java.lang.Object

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

Constructor Detail

IndexedTableDefinition

public IndexedTableDefinition(String name,
                              DatasetDefinition<? extends Table,?> tableDef)

Method Detail

configure

public DatasetSpecification configure(String instanceName,
                                      DatasetProperties properties)

Description copied from interface: DatasetDefinition

Configures new instance of the dataset.

Specified by:

configure in interface DatasetDefinition<IndexedTable,DatasetAdmin>

Overrides:

configure in class CompositeDatasetDefinition<IndexedTable>

Parameters:

instanceName - name of the instance

properties - instance configuration properties

Returns:

instance of DatasetSpecification that fully describes dataset instance. The DatasetSpecification can be used to create DatasetAdmin and Dataset to perform administrative and data operations respectively, see DatasetDefinition.getAdmin(DatasetContext, DatasetSpecification, ClassLoader) and DatasetDefinition.getDataset(DatasetContext, DatasetSpecification, Map, ClassLoader).

reconfigure

public DatasetSpecification reconfigure(String instanceName,
                                        DatasetProperties newProperties,
                                        DatasetSpecification currentSpec)
                                 throws IncompatibleUpdateException

Description copied from interface: Reconfigurable

Validates the new properties, including a compatibility check with the existing spec, and returns a new dataset specification for the dataset instance.

Specified by:

reconfigure in interface Reconfigurable

Overrides:

reconfigure in class CompositeDatasetDefinition<IndexedTable>

newProperties - the updated dataset properties, to be validated by this method

currentSpec - the current specification of the dataset

Returns:

a new dataset specification, created from the new properties

Throws:

IncompatibleUpdateException - if the new properties are not compatible with the existing dataset

getDataset

public IndexedTable getDataset(DatasetContext datasetContext,
                               DatasetSpecification spec,
                               Map<String,String> arguments,
                               ClassLoader classLoader)
                        throws IOException

Description copied from interface: DatasetDefinition

Provides dataset to be used to perform data operations on the dataset instance data defined by passed DatasetSpecification and the given arguments.

Parameters:

datasetContext - context for the dataset

spec - specification of the dataset instance.

arguments - arguments for this instance of the dataset. Should not be null - provide an empty map for no arguments.

classLoader - classloader to use when executing dataset operations

Returns:

dataset to perform object operations

Throws:

IOException