io.cdap.cdap.api.dataset.lib

Class ObjectStores

java.lang.Object

io.cdap.cdap.api.dataset.lib.ObjectStores

public final class ObjectStores
extends Object

Utility for describing ObjectStore and similar datasets within application configuration.

Method Summary

Modifier and Type	Method and Description
static void	createIndexedObjectStore(ApplicationConfigurer configurer, String datasetName, Type type) Same as createIndexedObjectStore(ApplicationConfigurer, String, Type, DatasetProperties) but with empty properties.
static void	createIndexedObjectStore(ApplicationConfigurer configurer, String datasetName, Type type, DatasetProperties props) Adds IndexedObjectStore dataset to be created at application deploy if not exists.
static void	createObjectStore(ApplicationConfigurer configurer, String datasetName, Type type) Same as createObjectStore(ApplicationConfigurer, String, Type, DatasetProperties) but with empty properties.
static void	createObjectStore(ApplicationConfigurer configurer, String datasetName, Type type, DatasetProperties props) Adds an ObjectStore dataset to be created at application deploy if it does not exist.
static DatasetProperties	objectStoreProperties(Type type, DatasetProperties props) Creates properties for ObjectStore dataset instance.

Methods inherited from class java.lang.Object

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

Method Detail

createObjectStore

public static void createObjectStore(ApplicationConfigurer configurer,
                                     String datasetName,
                                     Type type,
                                     DatasetProperties props)
                              throws UnsupportedTypeException

Adds an ObjectStore dataset to be created at application deploy if it does not exist.

Parameters:

configurer - application configurer

datasetName - dataset name

type - type of objects to be stored in ObjectStore

props - any additional dataset properties

Throws:

UnsupportedTypeException

createObjectStore

public static void createObjectStore(ApplicationConfigurer configurer,
                                     String datasetName,
                                     Type type)
                              throws UnsupportedTypeException

Same as createObjectStore(ApplicationConfigurer, String, Type, DatasetProperties) but with empty properties.

Throws:

UnsupportedTypeException

createIndexedObjectStore

public static void createIndexedObjectStore(ApplicationConfigurer configurer,
                                            String datasetName,
                                            Type type,
                                            DatasetProperties props)
                                     throws UnsupportedTypeException

Adds IndexedObjectStore dataset to be created at application deploy if not exists.

Parameters:

configurer - application configurer

datasetName - dataset name

type - type of objects to be stored in IndexedObjectStore

props - any additional dataset properties

Throws:

UnsupportedTypeException

createIndexedObjectStore

public static void createIndexedObjectStore(ApplicationConfigurer configurer,
                                            String datasetName,
                                            Type type)
                                     throws UnsupportedTypeException

Same as createIndexedObjectStore(ApplicationConfigurer, String, Type, DatasetProperties) but with empty properties.

Throws:

UnsupportedTypeException

objectStoreProperties

public static DatasetProperties objectStoreProperties(Type type,
                                                      DatasetProperties props)
                                               throws UnsupportedTypeException

Creates properties for ObjectStore dataset instance.

Parameters:

type - type of objects to be stored in dataset

Returns:

DatasetProperties for the dataset

Throws:

UnsupportedTypeException