co.cask.cdap.data2.dataset2

Interface DatasetNamespace

All Known Implementing Classes:

DefaultDatasetNamespace

public interface DatasetNamespace

Performs namespacing for datasets.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	contains(String name, String namespaceId) Checks if the specified namespace contains the specified dataset instance name
Id.DatasetInstance	fromNamespaced(Id.DatasetInstance datasetInstanceId) Returns a new Id.DatasetInstance with the namespaceId prefix removed from the instance name in the specified Id.DatasetInstance e.g.
Id.DatasetInstance	fromNamespaced(String namespaced) Returns a new Id.DatasetInstance with the namespaceId prefix removed from the specified instance name e.g.
Id.DatasetInstance	namespace(Id.DatasetInstance datasetInstanceId) Namespaces (applies the namespace as a prefix) to the specified Id.DatasetInstance String namespacedInstanceName = datasetInstanceId.getNamespace() + "." + datasetInstanceId.getId(); return Id.DatasetInstance.from(datasetInstanceId.getNamespace(), namespacedInstanceName) e.g.
String	namespace(Id.Namespace namespaceId, String suffix) Namespaces (applies the namespace as a prefix) to the specified suffix Used for applying namespace to part table names
Id.DatasetInstance	namespace(String datasetInstanceName) Namespaces (applies the namespace as a prefix) to the specified dataset instance name Used for dataset instances in the system namespace Calls #namespace(Id.DatasetInstance.from(Id.Namespace.SYSTEM, datasetInstanceName)

Method Detail

namespace

Id.DatasetInstance namespace(String datasetInstanceName)

Namespaces (applies the namespace as a prefix) to the specified dataset instance name Used for dataset instances in the system namespace Calls #namespace(Id.DatasetInstance.from(Id.Namespace.SYSTEM, datasetInstanceName)

Parameters:

datasetInstanceName - name of the dataset instance to be namespaced

Returns:

namespaced Id.DatasetInstance of the dataset

See Also:

namespace(Id.DatasetInstance)

namespace

Id.DatasetInstance namespace(Id.DatasetInstance datasetInstanceId)

Namespaces (applies the namespace as a prefix) to the specified Id.DatasetInstance String namespacedInstanceName = datasetInstanceId.getNamespace() + "." + datasetInstanceId.getId(); return Id.DatasetInstance.from(datasetInstanceId.getNamespace(), namespacedInstanceName) e.g. If Id.DatasetInstance(default, purchases) is passed, it will return Id.DatasetInstance(default, cdap.default.purchases)

Parameters:

datasetInstanceId - Id.DatasetInstance for the dataset instance to be namespaced

Returns:

namespaced Id.DatasetInstance of the dataset

namespace

String namespace(Id.Namespace namespaceId,
               String suffix)

Namespaces (applies the namespace as a prefix) to the specified suffix Used for applying namespace to part table names

Parameters:

namespaceId - the Id.Namespace to namespace the suffix with

suffix - the suffix to namespace

Returns:

String containing the suffix prefixed with the specified namespace

fromNamespaced

Id.DatasetInstance fromNamespaced(String namespaced)

Returns a new Id.DatasetInstance with the namespaceId prefix removed from the specified instance name e.g. if cdap.myspace.myinstance is passed, this will return Id.DatasetInstance(myspace, myinstance)

Parameters:

namespaced - namespaced name of the dataset

Returns:

original Id.DatasetInstance of the dataset or null if name is not within this namespace

See Also:

fromNamespaced(Id.DatasetInstance)

fromNamespaced

@Nullable
Id.DatasetInstance fromNamespaced(Id.DatasetInstance datasetInstanceId)

Returns a new Id.DatasetInstance with the namespaceId prefix removed from the instance name in the specified Id.DatasetInstance e.g. If Id.DatasetInstance(default, cdap.default.purchases) is passed, this will return Id.DatasetInstance(default, purchases)

Parameters:

datasetInstanceId - namespaced Id.DatasetInstance of the dataset

Returns:

original Id.DatasetInstance of the dataset or null if name is not within this namespace

contains

boolean contains(String name,
               String namespaceId)

Checks if the specified namespace contains the specified dataset instance name

Parameters:

name - namespaced name of the dataset

Returns:

true if the dataset belongs to this namespace