org.finra.herd.service.helper

Class BusinessObjectDataHelper

java.lang.Object

org.finra.herd.service.helper.BusinessObjectDataHelper

@Component
public class BusinessObjectDataHelper
extends Object

A helper class for BusinessObjectDataService related code.

Constructor Summary

Constructors

Constructor and Description
BusinessObjectDataHelper()

Method Summary

Modifier and Type	Method and Description
void	assertBusinessObjectDataStatusEquals(String expectedBusinessObjectDataStatusCode, BusinessObjectDataEntity businessObjectDataEntity) Asserts that the status of the given data is equal to the given expected value.
String	businessObjectDataEntityAltKeyToString(BusinessObjectDataEntity businessObjectDataEntity) Returns a string representation of the alternate key values for the business object data entity.
String	businessObjectDataKeyToString(BusinessObjectDataKey businessObjectDataKey) Returns a string representation of the business object data key.
String	businessObjectDataKeyToString(String namespace, String businessObjectDefinitionName, String businessObjectFormatUsage, String businessObjectFormatFileType, int businessObjectFormatVersion, String businessObjectDataPartitionValue, List<String> businessObjectDataSubPartitionValues, int businessObjectDataVersion) Returns a string representation of the business object data key.
BusinessObjectDataCreateRequest	createBusinessObjectDataCreateRequest(BusinessObjectFormatEntity businessObjectFormatEntity, String uuid, String businessObjectDataStatus, List<Attribute> attributes, StorageEntity storageEntity, String storageDirectoryPath, String storageFilePath, Long storageFileSizeBytes, Long storageFileRowCount) Validates the upload single initiation request.
BusinessObjectData	createBusinessObjectDataFromEntity(BusinessObjectDataEntity businessObjectDataEntity) Creates the business object data from the persisted entity.
BusinessObjectData	createBusinessObjectDataFromEntity(BusinessObjectDataEntity businessObjectDataEntity, Boolean includeBusinessObjectDataStatusHistory, Boolean includeStorageUnitStatusHistory, Boolean excludeBusinessObjectDataStorageFiles) Creates the business object data from the persisted entity.
BusinessObjectDataKey	createBusinessObjectDataKey(BusinessObjectData businessObjectData) Creates a business object data key from a business object data DTO.
BusinessObjectDataKey	createBusinessObjectDataKeyFromEntity(BusinessObjectDataEntity businessObjectDataEntity) Creates a business object data key from a business object data entity.
BusinessObjectDataKey	createBusinessObjectDataKeyFromStorageUnitKey(BusinessObjectDataStorageUnitKey storageUnitKey) Creates a business object data key from a storage unit key.
BusinessObjectDataKey	getBusinessObjectDataKey(BusinessObjectData businessObjectData) Returns a business object data key for the business object data.
BusinessObjectDataKey	getBusinessObjectDataKey(BusinessObjectDataEntity businessObjectDataEntity) Returns a business object data key for the business object data entity.
Date	getDateFromString(String dateString) Gets a date in a date format from a string format or null if one wasn't specified.
Set<BusinessObjectDataEntity>	getLatestValidBusinessObjectDataEntities(List<BusinessObjectDataEntity> businessObjectDataEntities) Select all latest valid business object data from the specified list of business object data entities.
List<String>	getPartitionFilter(BusinessObjectDataKey businessObjectDataKey, List<String> samplePartitionFilter) Returns a partition filter that the specified business object data key would match to.
String	getPartitionValue(BusinessObjectDataEntity businessObjectDataEntity, int partitionColumnPosition) Returns primary partition or subpartition value specified by the partition column position.
List<String>	getPrimaryAndSubPartitionValues(BusinessObjectData businessObjectData) Returns a list of primary and sub-partition values per specified business object data.
List<String>	getPrimaryAndSubPartitionValues(BusinessObjectDataEntity businessObjectDataEntity) Returns a list of primary and sub-partition values per specified business object data entity.
List<String>	getPrimaryAndSubPartitionValues(BusinessObjectDataKey businessObjectDataKey) Returns a list of primary and sub-partition values per specified business object data.
StorageUnit	getStorageUnitByStorageName(BusinessObjectData businessObjectData, String storageName) Gets a storage unit by storage name (case insensitive).
List<String>	getSubPartitionValues(BusinessObjectDataEntity businessObjectDataEntity) Gets the sub-partition values for the specified business object data entity.
void	validateBusinessObjectDataKey(BusinessObjectDataKey key, boolean businessObjectFormatVersionRequired, boolean businessObjectDataVersionRequired) Validates the business object data key.
void	validatePartitionValueFilters(List<PartitionValueFilter> partitionValueFilters, PartitionValueFilter standalonePartitionValueFilter, boolean allowPartitionValueTokens) Validates a list of partition value filters or a standalone partition filter.

Methods inherited from class java.lang.Object

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

Constructor Detail

BusinessObjectDataHelper

public BusinessObjectDataHelper()

Method Detail

assertBusinessObjectDataStatusEquals

public void assertBusinessObjectDataStatusEquals(String expectedBusinessObjectDataStatusCode,
                                                 BusinessObjectDataEntity businessObjectDataEntity)
                                          throws IllegalArgumentException

Asserts that the status of the given data is equal to the given expected value.

Parameters:

expectedBusinessObjectDataStatusCode - - the expected status

businessObjectDataEntity - - the data entity

Throws:

IllegalArgumentException - when status does not equal

businessObjectDataEntityAltKeyToString

public String businessObjectDataEntityAltKeyToString(BusinessObjectDataEntity businessObjectDataEntity)

Returns a string representation of the alternate key values for the business object data entity.

Parameters:

businessObjectDataEntity - the business object data entity

Returns:

the string representation of the alternate key values for the business object data entity

businessObjectDataKeyToString

public String businessObjectDataKeyToString(BusinessObjectDataKey businessObjectDataKey)

Returns a string representation of the business object data key.

Parameters:

businessObjectDataKey - the business object data key

Returns:

the string representation of the business object data key

businessObjectDataKeyToString

public String businessObjectDataKeyToString(String namespace,
                                            String businessObjectDefinitionName,
                                            String businessObjectFormatUsage,
                                            String businessObjectFormatFileType,
                                            int businessObjectFormatVersion,
                                            String businessObjectDataPartitionValue,
                                            List<String> businessObjectDataSubPartitionValues,
                                            int businessObjectDataVersion)

Returns a string representation of the business object data key.

Parameters:

namespace - the namespace

businessObjectDefinitionName - the business object definition name.

businessObjectFormatUsage - the business object format usage.

businessObjectFormatFileType - the business object format file type.

businessObjectFormatVersion - the business object formation version.

businessObjectDataPartitionValue - the business object data partition value.

businessObjectDataSubPartitionValues - the business object data subpartition values.

businessObjectDataVersion - the business object data version.

Returns:

the string representation of the business object data key.

createBusinessObjectDataCreateRequest

public BusinessObjectDataCreateRequest createBusinessObjectDataCreateRequest(BusinessObjectFormatEntity businessObjectFormatEntity,
                                                                             String uuid,
                                                                             String businessObjectDataStatus,
                                                                             List<Attribute> attributes,
                                                                             StorageEntity storageEntity,
                                                                             String storageDirectoryPath,
                                                                             String storageFilePath,
                                                                             Long storageFileSizeBytes,
                                                                             Long storageFileRowCount)

Validates the upload single initiation request. This method also trims the request parameters.

Parameters:

businessObjectFormatEntity - the business object format entity

uuid - the UUID

businessObjectDataStatus - the status of the business object data

attributes - the list of attributes

storageEntity - the storage entity

storageDirectoryPath - the storage directory path

storageFilePath - the storage file path

storageFileSizeBytes - the storage file size in bytes

storageFileRowCount - the storage file row count

Returns:

the business object data create request.

createBusinessObjectDataFromEntity

public BusinessObjectData createBusinessObjectDataFromEntity(BusinessObjectDataEntity businessObjectDataEntity)

Creates the business object data from the persisted entity.

Parameters:

businessObjectDataEntity - the newly persisted business object data entity.

Returns:

the business object data.

createBusinessObjectDataFromEntity

public BusinessObjectData createBusinessObjectDataFromEntity(BusinessObjectDataEntity businessObjectDataEntity,
                                                             Boolean includeBusinessObjectDataStatusHistory,
                                                             Boolean includeStorageUnitStatusHistory,
                                                             Boolean excludeBusinessObjectDataStorageFiles)

Creates the business object data from the persisted entity.

Parameters:

businessObjectDataEntity - the newly persisted business object data entity.

includeBusinessObjectDataStatusHistory - specifies to include business object data status history in the response

includeStorageUnitStatusHistory - specifies to include storage unit status history for each storage unit in the response

excludeBusinessObjectDataStorageFiles - specifies to exclude storage files in the response

Returns:

the business object data.

createBusinessObjectDataKey

public BusinessObjectDataKey createBusinessObjectDataKey(BusinessObjectData businessObjectData)

Creates a business object data key from a business object data DTO.

Parameters:

businessObjectData - the business object data DTO.

Returns:

the business object data key.

createBusinessObjectDataKeyFromEntity

public BusinessObjectDataKey createBusinessObjectDataKeyFromEntity(BusinessObjectDataEntity businessObjectDataEntity)

Creates a business object data key from a business object data entity.

Parameters:

businessObjectDataEntity - the business object data entity.

Returns:

the business object data key.

createBusinessObjectDataKeyFromStorageUnitKey

public BusinessObjectDataKey createBusinessObjectDataKeyFromStorageUnitKey(BusinessObjectDataStorageUnitKey storageUnitKey)

Creates a business object data key from a storage unit key.

Parameters:

storageUnitKey - the storage unit key

Returns:

the business object data key.

getBusinessObjectDataKey

public BusinessObjectDataKey getBusinessObjectDataKey(BusinessObjectDataEntity businessObjectDataEntity)

Returns a business object data key for the business object data entity.

Parameters:

businessObjectDataEntity - the business object data entity

Returns:

the business object data key for the business object data entity

getBusinessObjectDataKey

public BusinessObjectDataKey getBusinessObjectDataKey(BusinessObjectData businessObjectData)

Returns a business object data key for the business object data.

Parameters:

businessObjectData - the business object data

Returns:

the business object data key for the business object data

getDateFromString

public Date getDateFromString(String dateString)

Gets a date in a date format from a string format or null if one wasn't specified. The format of the date should match HerdDao.DEFAULT_SINGLE_DAY_DATE_MASK.

Parameters:

dateString - the date as a string

Returns:

the date as a date or null if one wasn't specified or the conversion fails

getLatestValidBusinessObjectDataEntities

public Set<BusinessObjectDataEntity> getLatestValidBusinessObjectDataEntities(List<BusinessObjectDataEntity> businessObjectDataEntities)

Select all latest valid business object data from the specified list of business object data entities. This method does not look at entities outside of the specified list.

Parameters:

businessObjectDataEntities - the list of business object data entities

Returns:

the set of latest valid business object data entities selected from the specified list of entities

getPartitionFilter

public List<String> getPartitionFilter(BusinessObjectDataKey businessObjectDataKey,
                                       List<String> samplePartitionFilter)

Returns a partition filter that the specified business object data key would match to. The filter is build as per specified sample partition filter.

Parameters:

businessObjectDataKey - the business object data key

samplePartitionFilter - the sample partition filter

Returns:

the partition filter

getPartitionValue

public String getPartitionValue(BusinessObjectDataEntity businessObjectDataEntity,
                                int partitionColumnPosition)

Returns primary partition or subpartition value specified by the partition column position.

Parameters:

businessObjectDataEntity - the business object data entity

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

Returns:

the value of the partition identified by the partition column position

getPrimaryAndSubPartitionValues

public List<String> getPrimaryAndSubPartitionValues(BusinessObjectDataKey businessObjectDataKey)

Returns a list of primary and sub-partition values per specified business object data.

Parameters:

businessObjectDataKey - the business object data key

Returns:

the list of primary and sub-partition values

getPrimaryAndSubPartitionValues

public List<String> getPrimaryAndSubPartitionValues(BusinessObjectData businessObjectData)

Returns a list of primary and sub-partition values per specified business object data.

Parameters:

businessObjectData - the business object data

Returns:

the list of primary and sub-partition values

getPrimaryAndSubPartitionValues

public List<String> getPrimaryAndSubPartitionValues(BusinessObjectDataEntity businessObjectDataEntity)

Returns a list of primary and sub-partition values per specified business object data entity.

Parameters:

businessObjectDataEntity - the business object data entity

Returns:

the list of primary and sub-partition values

getStorageUnitByStorageName

public StorageUnit getStorageUnitByStorageName(BusinessObjectData businessObjectData,
                                               String storageName)
                                        throws IllegalStateException

Gets a storage unit by storage name (case insensitive).

Parameters:

businessObjectData - the business object data

storageName - the storage name

Returns:

the storage unit

Throws:

IllegalStateException - if business object data has no storage unit with the specified storage name

getSubPartitionValues

public List<String> getSubPartitionValues(BusinessObjectDataEntity businessObjectDataEntity)

Gets the sub-partition values for the specified business object data entity.

Parameters:

businessObjectDataEntity - the business object data entity.

Returns:

the list of sub-partition values.

validateBusinessObjectDataKey

public void validateBusinessObjectDataKey(BusinessObjectDataKey key,
                                          boolean businessObjectFormatVersionRequired,
                                          boolean businessObjectDataVersionRequired)
                                   throws IllegalArgumentException

Validates the business object data key. This method also trims the key parameters.

Parameters:

key - the business object data key

businessObjectFormatVersionRequired - specifies if the business object format version is required or not

businessObjectDataVersionRequired - specifies if the business object data version is required or not

Throws:

IllegalArgumentException - if any validation errors were found

validatePartitionValueFilters

public void validatePartitionValueFilters(List<PartitionValueFilter> partitionValueFilters,
                                          PartitionValueFilter standalonePartitionValueFilter,
                                          boolean allowPartitionValueTokens)

Validates a list of partition value filters or a standalone partition filter. This method makes sure that a partition value filter contains exactly one partition value range or a non-empty partition value list. This method also makes sure that there is no more than one partition value range specified across all partition value filters.

Parameters:

partitionValueFilters - the list of partition value filters to validate

standalonePartitionValueFilter - the standalone partition value filter to validate

allowPartitionValueTokens - specifies whether the partition value filter is allowed to contain partition value tokens