org.finra.herd.service.helper

Class DdlGenerator

java.lang.Object

org.finra.herd.service.helper.DdlGenerator

Direct Known Subclasses:

Hive13DdlGenerator

public abstract class DdlGenerator
extends Object

Base abstract class for DDL generation. All DDL generators will extend this class.

Field Summary

Fields

Modifier and Type	Field and Description
static String	NON_PARTITIONED_TABLE_LOCATION_CUSTOM_DDL_TOKEN
static String	PARTITIONED_TABLE_LOCATION_CUSTOM_DDL_TOKEN
static String	TABLE_NAME_CUSTOM_DDL_TOKEN

Constructor Summary

Constructors

Constructor and Description
DdlGenerator()

Method Summary

Modifier and Type	Method and Description
abstract String	generateCreateTableDdl(BusinessObjectDataDdlRequest request, BusinessObjectFormatEntity businessObjectFormatEntity, CustomDdlEntity customDdlEntity, BusinessObjectDataStatusEntity businessObjectDataStatusEntity, List<String> storageNames, List<StorageEntity> requestedStorageEntities, Map<String,StorageEntity> cachedStorageEntities, Map<String,String> cachedS3BucketNames) This method generates the create table DDL as per specified business object data DDL request.
abstract String	generateCreateTableDdl(BusinessObjectFormatDdlRequest request, BusinessObjectFormatEntity businessObjectFormatEntity, CustomDdlEntity customDdlEntity) This method generates the create table DDL as per specified business object format DDL request.
abstract String	generateReplaceColumnsStatement(BusinessObjectFormatDdlRequest request, BusinessObjectFormatEntity businessObjectFormatEntity)
abstract BusinessObjectDataDdlOutputFormatEnum	getDdlOutputFormat() Gets the supported DDL output format that this generator can support.

Methods inherited from class java.lang.Object

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

Field Detail

NON_PARTITIONED_TABLE_LOCATION_CUSTOM_DDL_TOKEN

public static final String NON_PARTITIONED_TABLE_LOCATION_CUSTOM_DDL_TOKEN

See Also:

Constant Field Values

PARTITIONED_TABLE_LOCATION_CUSTOM_DDL_TOKEN

public static final String PARTITIONED_TABLE_LOCATION_CUSTOM_DDL_TOKEN

See Also:

Constant Field Values

TABLE_NAME_CUSTOM_DDL_TOKEN

public static final String TABLE_NAME_CUSTOM_DDL_TOKEN

See Also:

Constant Field Values

Constructor Detail

DdlGenerator

public DdlGenerator()

Method Detail

generateCreateTableDdl

public abstract String generateCreateTableDdl(BusinessObjectFormatDdlRequest request,
                                              BusinessObjectFormatEntity businessObjectFormatEntity,
                                              CustomDdlEntity customDdlEntity)

This method generates the create table DDL as per specified business object format DDL request.

Parameters:

request - the business object format DDL request

businessObjectFormatEntity - the business object format entity

customDdlEntity - the optional custom DDL entity

Returns:

the generated DDL

generateCreateTableDdl

public abstract String generateCreateTableDdl(BusinessObjectDataDdlRequest request,
                                              BusinessObjectFormatEntity businessObjectFormatEntity,
                                              CustomDdlEntity customDdlEntity,
                                              BusinessObjectDataStatusEntity businessObjectDataStatusEntity,
                                              List<String> storageNames,
                                              List<StorageEntity> requestedStorageEntities,
                                              Map<String,StorageEntity> cachedStorageEntities,
                                              Map<String,String> cachedS3BucketNames)

This method generates the create table DDL as per specified business object data DDL request.

Parameters:

request - the business object data DDL request

businessObjectFormatEntity - the business object format entity

customDdlEntity - the optional custom DDL entity

businessObjectDataStatusEntity - the business object data status for available business object data

storageNames - the list of storage names, maybe empty

requestedStorageEntities - the list of storage entities per storage names specified in the request

cachedStorageEntities - the map of storage names in upper case to the relative storage entities

cachedS3BucketNames - the map of storage names in upper case to the relative S3 bucket names

Returns:

the generated DDL

generateReplaceColumnsStatement

public abstract String generateReplaceColumnsStatement(BusinessObjectFormatDdlRequest request,
                                                       BusinessObjectFormatEntity businessObjectFormatEntity)

getDdlOutputFormat

public abstract BusinessObjectDataDdlOutputFormatEnum getDdlOutputFormat()

Gets the supported DDL output format that this generator can support.

Returns:

BusinessObjectDataDdlOutputFormatEnum supported output format.