org.finra.herd.dao.impl

Class BusinessObjectFormatDaoImpl

java.lang.Object

org.finra.herd.dao.impl.BaseJpaDaoImpl

org.finra.herd.dao.impl.AbstractHerdDao

org.finra.herd.dao.impl.BusinessObjectFormatDaoImpl

All Implemented Interfaces:

BaseJpaDao, BusinessObjectFormatDao

@Repository
public class BusinessObjectFormatDaoImpl
extends AbstractHerdDao
implements BusinessObjectFormatDao

Nested Class Summary

Nested classes/interfaces inherited from class org.finra.herd.dao.impl.AbstractHerdDao

AbstractHerdDao.AggregateFunction

Field Summary

Fields inherited from class org.finra.herd.dao.impl.AbstractHerdDao

BUSINESS_OBJECT_DATA_PARTITIONS, BUSINESS_OBJECT_DATA_SUBPARTITIONS, configurationHelper, DEFAULT_SINGLE_DAY_DATE_MASK, MAX_PARTITION_FILTERS_PER_REQUEST

Fields inherited from class org.finra.herd.dao.impl.BaseJpaDaoImpl

entityManager

Constructor Summary

Constructors

Constructor and Description
BusinessObjectFormatDaoImpl()

Method Summary

Modifier and Type	Method and Description
BusinessObjectFormatEntity	getBusinessObjectFormatByAltKey(BusinessObjectFormatKey businessObjectFormatKey) Gets a business object format based on it's key.
Long	getBusinessObjectFormatCountByPartitionKeyGroup(PartitionKeyGroupEntity partitionKeyGroupEntity) Returns a number of business object format instances that reference a specified partition key group.
Long	getBusinessObjectFormatCountByPartitionKeys(String namespace, String businessObjectDefinitionName, String businessObjectFormatUsage, String businessObjectFormatFileType, Integer businessObjectFormatVersion, List<String> partitionKeys) Retrieves business object format record count per specified parameters including an optional list of partition keys.
List<Long>	getBusinessObjectFormatIdsByBusinessObjectDefinition(BusinessObjectDefinitionEntity businessObjectDefinitionEntity) Gets a list of ids for all business object formats registered under the specified business object definition.
Integer	getBusinessObjectFormatMaxVersion(BusinessObjectFormatKey businessObjectFormatKey) Gets the maximum available version of the specified business object format.
List<BusinessObjectFormatKey>	getBusinessObjectFormats(BusinessObjectDefinitionKey businessObjectDefinitionKey, boolean latestBusinessObjectFormatVersion) Gets a list of business object format keys for the specified business object definition key.
List<BusinessObjectFormatKey>	getBusinessObjectFormatsWithFilters(BusinessObjectDefinitionKey businessObjectDefinitionKey, String businessObjectFormatUsage, boolean latestBusinessObjectFormatVersion) Gets a list of business object format keys for the specified business object definition key and business object format usage.
List<BusinessObjectFormatEntity>	getLatestVersionBusinessObjectFormatsByBusinessObjectDefinition(BusinessObjectDefinitionEntity businessObjectDefinitionEntity) Gets a list of latest version business object format entities for the specified business object definition entity.

Methods inherited from class org.finra.herd.dao.impl.AbstractHerdDao

getQueryRestriction, getQueryRestriction, getQueryRestriction, getQueryRestriction, getQueryRestrictionOnBusinessObjectDataVersionAndStatus, getQueryRestrictionOnPartitionValues, getQueryRestrictionOnPartitionValues, getQueryRestrictionOnPartitionValues, getQueryRestrictionOnPartitionValues, getQueryRestrictionOnStorage, save

Methods inherited from class org.finra.herd.dao.impl.BaseJpaDaoImpl

delete, detach, executeSingleResultQuery, findAll, findById, findByNamedProperties, findUniqueByNamedProperties, getCurrentTimestamp, getEntityManager, getPredicateForInClause, query, queryByNamedParams, saveAndRefresh

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.finra.herd.dao.BaseJpaDao

delete, detach, findAll, findById, findByNamedProperties, findUniqueByNamedProperties, getCurrentTimestamp, getEntityManager, query, queryByNamedParams, save, saveAndRefresh

Constructor Detail

BusinessObjectFormatDaoImpl

public BusinessObjectFormatDaoImpl()

Method Detail

getBusinessObjectFormatByAltKey

public BusinessObjectFormatEntity getBusinessObjectFormatByAltKey(BusinessObjectFormatKey businessObjectFormatKey)

Description copied from interface: BusinessObjectFormatDao

Gets a business object format based on it's key. If a format version isn't specified, the latest available format version will be used.

Specified by:

getBusinessObjectFormatByAltKey in interface BusinessObjectFormatDao

Parameters:

businessObjectFormatKey - the business object format key (case-insensitive)

Returns:

the business object format

getBusinessObjectFormatCountByPartitionKeyGroup

public Long getBusinessObjectFormatCountByPartitionKeyGroup(PartitionKeyGroupEntity partitionKeyGroupEntity)

Description copied from interface: BusinessObjectFormatDao

Returns a number of business object format instances that reference a specified partition key group.

Specified by:

getBusinessObjectFormatCountByPartitionKeyGroup in interface BusinessObjectFormatDao

Parameters:

partitionKeyGroupEntity - the partition key group entity

Returns:

the number of business object format instances that reference this partition key group

getBusinessObjectFormatCountByPartitionKeys

public Long getBusinessObjectFormatCountByPartitionKeys(String namespace,
                                                        String businessObjectDefinitionName,
                                                        String businessObjectFormatUsage,
                                                        String businessObjectFormatFileType,
                                                        Integer businessObjectFormatVersion,
                                                        List<String> partitionKeys)

Description copied from interface: BusinessObjectFormatDao

Retrieves business object format record count per specified parameters including an optional list of partition keys.

Specified by:

getBusinessObjectFormatCountByPartitionKeys in interface BusinessObjectFormatDao

Parameters:

namespace - the namespace

businessObjectDefinitionName - the business object definition name

businessObjectFormatUsage - the usage of the business object format, maybe null

businessObjectFormatFileType - the file type of the business object format, maybe null

businessObjectFormatVersion - the version of the business object format, maybe null

partitionKeys - the list of partition keys, maybe null or empty

Returns:

the record count of business object formats

getBusinessObjectFormatIdsByBusinessObjectDefinition

public List<Long> getBusinessObjectFormatIdsByBusinessObjectDefinition(BusinessObjectDefinitionEntity businessObjectDefinitionEntity)

Description copied from interface: BusinessObjectFormatDao

Gets a list of ids for all business object formats registered under the specified business object definition. The list of business object format ids returned by this method is sorted by business object format usage ascending, file type ascending, and business object format version descending.

Specified by:

getBusinessObjectFormatIdsByBusinessObjectDefinition in interface BusinessObjectFormatDao

Parameters:

businessObjectDefinitionEntity - the business object definition

Returns:

the list of business object format ids

getBusinessObjectFormatMaxVersion

public Integer getBusinessObjectFormatMaxVersion(BusinessObjectFormatKey businessObjectFormatKey)

Description copied from interface: BusinessObjectFormatDao

Gets the maximum available version of the specified business object format.

Specified by:

getBusinessObjectFormatMaxVersion in interface BusinessObjectFormatDao

Parameters:

businessObjectFormatKey - the business object format key (case-insensitive)

Returns:

the maximum available version of the specified business object format

getBusinessObjectFormats

public List<BusinessObjectFormatKey> getBusinessObjectFormats(BusinessObjectDefinitionKey businessObjectDefinitionKey,
                                                              boolean latestBusinessObjectFormatVersion)

Description copied from interface: BusinessObjectFormatDao

Gets a list of business object format keys for the specified business object definition key.

Specified by:

getBusinessObjectFormats in interface BusinessObjectFormatDao

Parameters:

businessObjectDefinitionKey - the business object definition key

latestBusinessObjectFormatVersion - specifies if only the latest (maximum) versions of the relative business object formats are returned

Returns:

the list of business object format keys

getBusinessObjectFormatsWithFilters

public List<BusinessObjectFormatKey> getBusinessObjectFormatsWithFilters(BusinessObjectDefinitionKey businessObjectDefinitionKey,
                                                                         String businessObjectFormatUsage,
                                                                         boolean latestBusinessObjectFormatVersion)

Description copied from interface: BusinessObjectFormatDao

Gets a list of business object format keys for the specified business object definition key and business object format usage.

Specified by:

getBusinessObjectFormatsWithFilters in interface BusinessObjectFormatDao

Parameters:

businessObjectDefinitionKey - the business object definition key

businessObjectFormatUsage - the business object format usage

latestBusinessObjectFormatVersion - specifies if only the latest (maximum) versions of the relative business object formats are returned

Returns:

the list of business object format keys

getLatestVersionBusinessObjectFormatsByBusinessObjectDefinition

public List<BusinessObjectFormatEntity> getLatestVersionBusinessObjectFormatsByBusinessObjectDefinition(BusinessObjectDefinitionEntity businessObjectDefinitionEntity)

Description copied from interface: BusinessObjectFormatDao

Gets a list of latest version business object format entities for the specified business object definition entity.

Specified by:

getLatestVersionBusinessObjectFormatsByBusinessObjectDefinition in interface BusinessObjectFormatDao

Parameters:

businessObjectDefinitionEntity - the business object definition entity

Returns:

the list of business object format entities