io.cdap.cdap.api.dataset.lib

Class CompositeDatasetDefinition<D extends Dataset>

java.lang.Object

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

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

Type Parameters:

D - defines data operations that can be performed on this dataset instance

All Implemented Interfaces:

DatasetDefinition<D,DatasetAdmin>, Reconfigurable

Direct Known Subclasses:

CounterTimeseriesTableDefinition, IndexedObjectStoreDefinition, IndexedTableDefinition, KeyValueTableDefinition, TimeseriesTableDefinition

@Beta
public abstract class CompositeDatasetDefinition<D extends Dataset>
extends AbstractDatasetDefinition<D,DatasetAdmin>
implements Reconfigurable

Handy implementation of DatasetDefinition that implements basic methods by delegating logic execution to underlying dataset definitions.

Field Summary

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

NO_ARGUMENTS

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CompositeDatasetDefinition(String name, Map<String,? extends DatasetDefinition> delegates) Constructor that takes an info about underlying datasets
protected	CompositeDatasetDefinition(String name, String delegateName, DatasetDefinition delegate) Constructor that takes one underlying dataset.
protected	CompositeDatasetDefinition(String name, String delegateNameA, DatasetDefinition delegateA, String delegateNameB, DatasetDefinition delegateB) Constructor that takes two underlying datasets.

Method Summary

Modifier and Type	Method and Description
DatasetSpecification	configure(String instanceName, DatasetProperties properties) Configures new instance of the dataset.
DatasetAdmin	getAdmin(DatasetContext datasetContext, DatasetSpecification spec, ClassLoader classLoader) Provides dataset admin to be used to perform administrative operations on the dataset instance defined by passed DatasetSpecification.
protected <T extends Dataset> T	getDataset(DatasetContext datasetContext, String name, DatasetSpecification spec, Map<String,String> arguments, ClassLoader classLoader) Gets a Dataset instance from the delegates with the given instance name.
protected <DS extends Dataset,DA extends DatasetAdmin> DatasetDefinition<DS,DA>	getDelegate(String name)
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.AbstractDatasetDefinition

getName, reconfigure

Methods inherited from class java.lang.Object

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

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

getDataset

Constructor Detail

CompositeDatasetDefinition

protected CompositeDatasetDefinition(String name,
                                     Map<String,? extends DatasetDefinition> delegates)

Constructor that takes an info about underlying datasets

Parameters:

name - this dataset type name

delegates - map of [dataset instance name] -> [dataset definition] to use for this instance name

CompositeDatasetDefinition

protected CompositeDatasetDefinition(String name,
                                     String delegateName,
                                     DatasetDefinition delegate)

Constructor that takes one underlying dataset.

Parameters:

name - this dataset type name

delegateName - name of the first delegate

delegate - dataset definition for the second delegate

CompositeDatasetDefinition

protected CompositeDatasetDefinition(String name,
                                     String delegateNameA,
                                     DatasetDefinition delegateA,
                                     String delegateNameB,
                                     DatasetDefinition delegateB)

Constructor that takes two underlying datasets.

Parameters:

name - this dataset type name

delegateNameA - name of the first delegate

delegateA - dataset definition for the first delegate

delegateNameB - name of the second delegate

delegateB - dataset definition for the second delegate

Method Detail

getDataset

protected final <T extends Dataset> T getDataset(DatasetContext datasetContext,
                                                 String name,
                                                 DatasetSpecification spec,
                                                 Map<String,String> arguments,
                                                 ClassLoader classLoader)
                                          throws IOException

Gets a Dataset instance from the delegates with the given instance name.

Type Parameters:

T - type of the dataset

Parameters:

datasetContext - the context which the get call is happening

name - name of the dataset

spec - the DatasetSpecification for the outer dataset

arguments - dataset arguments

classLoader - classloader for loading the dataset

Returns:

a dataset instance

Throws:

IOException - if failed to get a dataset instance

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<D extends Dataset,DatasetAdmin>

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

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

getAdmin

public final DatasetAdmin getAdmin(DatasetContext datasetContext,
                                   DatasetSpecification spec,
                                   ClassLoader classLoader)
                            throws IOException

Description copied from interface: DatasetDefinition

Provides dataset admin to be used to perform administrative operations on the dataset instance defined by passed DatasetSpecification.

Specified by:

getAdmin in interface DatasetDefinition<D extends Dataset,DatasetAdmin>

Parameters:

datasetContext - context for the dataset

spec - specification of the dataset instance.

classLoader - classloader to use when executing admin operations

Returns:

dataset admin to perform administrative operations

Throws:

IOException

getDelegate

protected <DS extends Dataset,DA extends DatasetAdmin> DatasetDefinition<DS,DA> getDelegate(String name)