org.finra.herd.service.helper

Class StorageUnitHelper

java.lang.Object

org.finra.herd.service.helper.StorageUnitHelper

@Component
public class StorageUnitHelper
extends Object

A helper class for storage unit related code.

Constructor Summary

Constructors

Constructor and Description
StorageUnitHelper()

Method Summary

Modifier and Type	Method and Description
StorageUnitAlternateKeyDto	createStorageUnitKey(BusinessObjectDataKey businessObjectDataKey, String storageName) Creates a storage unit key from a business object data key and a storage name.
StorageUnitAlternateKeyDto	createStorageUnitKeyFromEntity(StorageUnitEntity storageUnitEntity) Creates a storage unit key from a storage unit entity.
List<StorageUnit>	createStorageUnitsFromEntities(Collection<StorageUnitEntity> storageUnitEntities) Creates a list of storage units from the list of storage unit entities.
List<StorageUnitEntity>	excludeBusinessObjectDataStatus(List<StorageUnitEntity> storageUnitEntities, String excludedBusinessObjectDataStatus) Excludes storage units from the list with the specified business object data status.
List<StorageUnitEntity>	excludePartitions(List<StorageUnitEntity> storageUnitEntities, List<List<String>> excludedPartitions) Excludes storage units from the list with primary and sub-partition values matching one of the excluded partitions.
Set<BusinessObjectDataEntity>	getBusinessObjectDataEntitiesSet(List<StorageUnitEntity> storageUnitEntities) Creates a set of business object data entities per specified list of storage unit entities.

Methods inherited from class java.lang.Object

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

Constructor Detail

StorageUnitHelper

public StorageUnitHelper()

Method Detail

createStorageUnitKey

public StorageUnitAlternateKeyDto createStorageUnitKey(BusinessObjectDataKey businessObjectDataKey,
                                                       String storageName)

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

Parameters:

businessObjectDataKey - the business object data key

storageName - the storage name

Returns:

the storage unit key

createStorageUnitKeyFromEntity

public StorageUnitAlternateKeyDto createStorageUnitKeyFromEntity(StorageUnitEntity storageUnitEntity)

Creates a storage unit key from a storage unit entity.

Parameters:

storageUnitEntity - the storage unit entity

Returns:

the storage unit key

createStorageUnitsFromEntities

public List<StorageUnit> createStorageUnitsFromEntities(Collection<StorageUnitEntity> storageUnitEntities)

Creates a list of storage units from the list of storage unit entities.

Parameters:

storageUnitEntities - the storage unit entities.

Returns:

the list of storage units.

excludeBusinessObjectDataStatus

public List<StorageUnitEntity> excludeBusinessObjectDataStatus(List<StorageUnitEntity> storageUnitEntities,
                                                               String excludedBusinessObjectDataStatus)

Excludes storage units from the list with the specified business object data status.

Parameters:

storageUnitEntities - the list of storage unit entities

excludedBusinessObjectDataStatus - the business object data status to be excluded

Returns:

the updated list of storage units

excludePartitions

public List<StorageUnitEntity> excludePartitions(List<StorageUnitEntity> storageUnitEntities,
                                                 List<List<String>> excludedPartitions)

Excludes storage units from the list with primary and sub-partition values matching one of the excluded partitions.

Parameters:

storageUnitEntities - the list of storage unit entities

excludedPartitions - list of excluded partitions, where each partition consists of primary and optional sub-partition values

Returns:

the updated list of storage units

getBusinessObjectDataEntitiesSet

public Set<BusinessObjectDataEntity> getBusinessObjectDataEntitiesSet(List<StorageUnitEntity> storageUnitEntities)

Creates a set of business object data entities per specified list of storage unit entities. The method ignores duplicate business object entities.

Parameters:

storageUnitEntities - the list of storage unit entities

Returns:

the set of business object data entities