io.cdap.cdap.api.dataset.lib

Class ObjectMappedTableProperties

java.lang.Object

io.cdap.cdap.api.dataset.lib.ObjectMappedTableProperties

@Beta
public class ObjectMappedTableProperties
extends Object

Helper to build properties for an ObjectMappedTable.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ObjectMappedTableProperties.Builder A Builder to construct properties for ObjectMappedTable datasets.

Field Summary

Fields

Modifier and Type	Field and Description
static String	OBJECT_SCHEMA The schema of objects in the table.
static String	OBJECT_TYPE The type of object in the table.
static String	ROW_KEY_EXPLORE_NAME The name of the Hive table column for the key of objects stored in the table.
static String	ROW_KEY_EXPLORE_TYPE The type of the Hive table column for the row key of objects stored in the table.

Constructor Summary

Constructors

Constructor and Description
ObjectMappedTableProperties()

Method Summary

Modifier and Type	Method and Description
static ObjectMappedTableProperties.Builder	builder()
static Schema	getObjectSchema(Map<String,String> properties)
static String	getObjectTypeRepresentation(Map<String,String> properties)
static String	getRowKeyExploreName(Map<String,String> properties)
static Schema.Type	getRowKeyExploreType(Map<String,String> properties)

Methods inherited from class java.lang.Object

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

Field Detail

OBJECT_TYPE

public static final String OBJECT_TYPE

The type of object in the table.

See Also:

Constant Field Values

OBJECT_SCHEMA

public static final String OBJECT_SCHEMA

The schema of objects in the table. This schema does not include the row key.

See Also:

Constant Field Values

ROW_KEY_EXPLORE_NAME

public static final String ROW_KEY_EXPLORE_NAME

The name of the Hive table column for the key of objects stored in the table. See ObjectMappedTableProperties.Builder.setRowKeyExploreName(String) for details.

See Also:

Constant Field Values

ROW_KEY_EXPLORE_TYPE

public static final String ROW_KEY_EXPLORE_TYPE

The type of the Hive table column for the row key of objects stored in the table. See ObjectMappedTableProperties.Builder.setRowKeyExploreType(Schema.Type) for details.

See Also:

Constant Field Values

Constructor Detail

ObjectMappedTableProperties

public ObjectMappedTableProperties()

Method Detail

builder

public static ObjectMappedTableProperties.Builder builder()

getObjectTypeRepresentation

public static String getObjectTypeRepresentation(Map<String,String> properties)

Returns:

The serialized representation of the type of objects in the table.

getObjectSchema

public static Schema getObjectSchema(Map<String,String> properties)
                              throws IOException

Returns:

The schema of objects in the table.

Throws:

IOException

getRowKeyExploreName

public static String getRowKeyExploreName(Map<String,String> properties)

Returns:

The name of the key to use when exploring the table.

getRowKeyExploreType

public static Schema.Type getRowKeyExploreType(Map<String,String> properties)

Returns:

The type of the key when exploring the table.