org.finra.herd.service.helper

Class BusinessObjectDataDaoHelper

java.lang.Object

org.finra.herd.service.helper.BusinessObjectDataDaoHelper

@Component
public class BusinessObjectDataDaoHelper
extends Object

Helper for business object data related operations which require DAO.

Constructor Summary

Constructors

Constructor and Description
BusinessObjectDataDaoHelper()

Method Summary

Modifier and Type	Method and Description
List<List<String>>	buildPartitionFilters(List<PartitionValueFilter> partitionValueFilters, PartitionValueFilter standalonePartitionValueFilter, BusinessObjectFormatKey businessObjectFormatKey, Integer businessObjectDataVersion, BusinessObjectDataStatusEntity businessObjectDataStatusEntity, List<StorageEntity> storageEntities, StoragePlatformEntity storagePlatformEntity, StoragePlatformEntity excludedStoragePlatformEntity, BusinessObjectFormatEntity businessObjectFormatEntity) Build partition filters based on the specified partition value filters.
BusinessObjectData	createBusinessObjectData(BusinessObjectDataCreateRequest request) Creates a new business object data from the request information.
BusinessObjectData	createBusinessObjectData(BusinessObjectDataCreateRequest request, boolean fileSizeRequired, boolean useFullFilePath) Creates a new business object data from the request information.
StorageUnitEntity	createStorageUnitEntity(BusinessObjectDataEntity businessObjectDataEntity, StorageEntity storageEntity, StorageDirectory storageDirectory, List<StorageFile> storageFiles, Boolean isDiscoverStorageFiles, Boolean isUseFullFilePath) Creates a storage unit entity per specified parameters.
BusinessObjectData	deleteBusinessObjectData(BusinessObjectDataKey businessObjectDataKey, Boolean deleteFiles) Deletes an existing business object data.
BusinessObjectDataEntity	getBusinessObjectDataEntity(BusinessObjectDataKey businessObjectDataKey) Gets business object data based on the key information.
BusinessObjectDataEntity	getBusinessObjectDataEntityByKeyAndStatus(BusinessObjectDataKey businessObjectDataKey, BusinessObjectDataStatusEntity businessObjectDataStatusEntity) Retrieves business object data by it's key.
BusinessObjectDataStatusEntity	getBusinessObjectStatusEntityForAvailableData(String businessObjectDataStatus) Returns business object data status entity that should be used for available business object data as per optionally specified business object data status value.
List<String>	getPartitionValues(PartitionValueFilter partitionValueFilter, String partitionKey, int partitionColumnPosition, BusinessObjectFormatKey businessObjectFormatKey, Integer businessObjectDataVersion, BusinessObjectDataStatusEntity businessObjectDataStatusEntity, List<StorageEntity> storageEntities, StoragePlatformEntity storagePlatformEntity, StoragePlatformEntity excludedStoragePlatformEntity, BusinessObjectFormatEntity businessObjectFormatEntity) Builds a list of partition values from the partition value filter.
void	triggerNotificationsForCreateBusinessObjectData(BusinessObjectData businessObjectData) Trigger business object data and storage unit notification for business object data creation event.
void	triggerNotificationsForInvalidateUnregisteredBusinessObjectData(BusinessObjectDataInvalidateUnregisteredResponse businessObjectDataInvalidateUnregisteredResponse) Trigger business object data and storage unit notification for unregistered business object data invalidation event.
void	updateBusinessObjectDataStatus(BusinessObjectDataEntity businessObjectDataEntity, String status) Update the business object data status.
void	validateBusinessObjectDataKeys(List<BusinessObjectDataKey> keys) Validates the business object data keys.

Methods inherited from class java.lang.Object

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

Constructor Detail

BusinessObjectDataDaoHelper

public BusinessObjectDataDaoHelper()

Method Detail

buildPartitionFilters

public List<List<String>> buildPartitionFilters(List<PartitionValueFilter> partitionValueFilters,
                                                PartitionValueFilter standalonePartitionValueFilter,
                                                BusinessObjectFormatKey businessObjectFormatKey,
                                                Integer businessObjectDataVersion,
                                                BusinessObjectDataStatusEntity businessObjectDataStatusEntity,
                                                List<StorageEntity> storageEntities,
                                                StoragePlatformEntity storagePlatformEntity,
                                                StoragePlatformEntity excludedStoragePlatformEntity,
                                                BusinessObjectFormatEntity businessObjectFormatEntity)

Build partition filters based on the specified partition value filters. This method also validates the partition value filters (including partition keys) against the business object format schema. When request contains multiple partition value filters, the system will check business object data availability for n-fold Cartesian product of the partition values specified, where n is a number of partition value filters (partition value sets).

Parameters:

partitionValueFilters - the list of partition value filters

standalonePartitionValueFilter - the standalone partition value filter

businessObjectFormatKey - the business object format key

businessObjectDataVersion - the optional business object data version, maybe null

businessObjectDataStatusEntity - the optional business object data status entity, maybe null. This parameter is ignored when the business object data version is specified

storageEntities - the optional list of storage entities

storagePlatformEntity - the optional storage platform entity, e.g. S3 for Hive DDL. It is ignored when the list of storage entities is not empty

excludedStoragePlatformEntity - the optional storage platform entity to be excluded from search. It is ignored when the list of storage entities is not empty or the storage platform entity is specified

businessObjectFormatEntity - the business object format entity

Returns:

the list of partition filters

createBusinessObjectData

public BusinessObjectData createBusinessObjectData(BusinessObjectDataCreateRequest request)

Creates a new business object data from the request information.

Parameters:

request - the request

Returns:

the newly created and persisted business object data

createBusinessObjectData

public BusinessObjectData createBusinessObjectData(BusinessObjectDataCreateRequest request,
                                                   boolean fileSizeRequired,
                                                   boolean useFullFilePath)

Creates a new business object data from the request information.

Parameters:

request - the request

fileSizeRequired - specifies if fileSizeBytes value is required or not

useFullFilePath - specifies if a full file path is used

Returns:

the newly created and persisted business object data

createStorageUnitEntity

public StorageUnitEntity createStorageUnitEntity(BusinessObjectDataEntity businessObjectDataEntity,
                                                 StorageEntity storageEntity,
                                                 StorageDirectory storageDirectory,
                                                 List<StorageFile> storageFiles,
                                                 Boolean isDiscoverStorageFiles,
                                                 Boolean isUseFullFilePath)

Creates a storage unit entity per specified parameters.

Parameters:

businessObjectDataEntity - the business object data entity

storageEntity - the storage entity

storageDirectory - the storage directory

storageFiles - the list of storage files

isDiscoverStorageFiles - specifies if we will discover storage files

isUseFullFilePath - specifies if we use the full file path

Returns:

the newly created storage unit entity

deleteBusinessObjectData

public BusinessObjectData deleteBusinessObjectData(BusinessObjectDataKey businessObjectDataKey,
                                                   Boolean deleteFiles)

Deletes an existing business object data.

Parameters:

businessObjectDataKey - the business object data key

deleteFiles - specifies if data files should be deleted or not

Returns:

the deleted business object data information

getBusinessObjectDataEntity

public BusinessObjectDataEntity getBusinessObjectDataEntity(BusinessObjectDataKey businessObjectDataKey)

Gets business object data based on the key information.

Parameters:

businessObjectDataKey - the business object data key.

Returns:

the business object data.

getBusinessObjectDataEntityByKeyAndStatus

public BusinessObjectDataEntity getBusinessObjectDataEntityByKeyAndStatus(BusinessObjectDataKey businessObjectDataKey,
                                                                          BusinessObjectDataStatusEntity businessObjectDataStatusEntity)

Retrieves business object data by it's key. If a format version isn't specified, the latest available format version (for this partition value) will be used. If a business object data version isn't specified, the latest data version based on the specified business object data status is returned. When both business object data version and business object data status are not specified, the latest data version for each set of partition values will be used regardless of the status.

Parameters:

businessObjectDataKey - the business object data key

businessObjectDataStatusEntity - the optional business object data status entity. This parameter is ignored when the business object data version is specified

Returns:

the business object data

getBusinessObjectStatusEntityForAvailableData

public BusinessObjectDataStatusEntity getBusinessObjectStatusEntityForAvailableData(String businessObjectDataStatus)

Returns business object data status entity that should be used for available business object data as per optionally specified business object data status value. If business object data status is specified, but it does not exist, the method throws ObjectNotFoundException. If business object data status is specified, but it is not VALID or one of the pre-registered statuses, the method throws IllegalArgumentException. If business object data status is not specified, the method returns business object data status entity for VALID business object data status.

Parameters:

businessObjectDataStatus - the business object data status value that is optionally specified to be used to select available business object data, maybe be null or empty

Returns:

the business object data status entity

getPartitionValues

public List<String> getPartitionValues(PartitionValueFilter partitionValueFilter,
                                       String partitionKey,
                                       int partitionColumnPosition,
                                       BusinessObjectFormatKey businessObjectFormatKey,
                                       Integer businessObjectDataVersion,
                                       BusinessObjectDataStatusEntity businessObjectDataStatusEntity,
                                       List<StorageEntity> storageEntities,
                                       StoragePlatformEntity storagePlatformEntity,
                                       StoragePlatformEntity excludedStoragePlatformEntity,
                                       BusinessObjectFormatEntity businessObjectFormatEntity)

Builds a list of partition values from the partition value filter. The partition range takes precedence over the list of partition values in the filter. If a range is specified the list of values will come from the expected partition values table for values within the specified range. If the list is specified, duplicates will be removed. In both cases, the list will be ordered ascending.

Parameters:

partitionValueFilter - the partition value filter that was validated to have exactly one partition value filter option

partitionKey - the partition key

partitionColumnPosition - the partition column position (one-based numbering)

businessObjectFormatKey - the business object format key

businessObjectDataVersion - the optional business object data version, maybe null

businessObjectDataStatusEntity - the optional business object data status entity, maybe null. This parameter is ignored when the business object data version is specified

storageEntities - the optional list of storage entities

storagePlatformEntity - the optional storage platform entity, e.g. S3 for Hive DDL. It is ignored when the list of storage names is not empty

excludedStoragePlatformEntity - the optional storage platform entity to be excluded from search. It is ignored when the list of storage names is not empty or the storage platform entity is specified

businessObjectFormatEntity - the business object format entity

Returns:

the unique and sorted partition value list

triggerNotificationsForCreateBusinessObjectData

public void triggerNotificationsForCreateBusinessObjectData(BusinessObjectData businessObjectData)

Trigger business object data and storage unit notification for business object data creation event.

Parameters:

businessObjectData - the business object data

triggerNotificationsForInvalidateUnregisteredBusinessObjectData

public void triggerNotificationsForInvalidateUnregisteredBusinessObjectData(BusinessObjectDataInvalidateUnregisteredResponse businessObjectDataInvalidateUnregisteredResponse)

Trigger business object data and storage unit notification for unregistered business object data invalidation event.

Parameters:

businessObjectDataInvalidateUnregisteredResponse - the business object data invalidate unregistered response

updateBusinessObjectDataStatus

public void updateBusinessObjectDataStatus(BusinessObjectDataEntity businessObjectDataEntity,
                                           String status)

Update the business object data status.

Parameters:

businessObjectDataEntity - the business object data entity

status - the status

validateBusinessObjectDataKeys

public void validateBusinessObjectDataKeys(List<BusinessObjectDataKey> keys)

Validates the business object data keys. This will validate, trim, and make lowercase appropriate fields.

Parameters:

keys - the business object data keys to validate