org.finra.herd.dao.impl

Class AbstractHerdDao

java.lang.Object

org.finra.herd.dao.impl.BaseJpaDaoImpl

org.finra.herd.dao.impl.AbstractHerdDao

All Implemented Interfaces:

BaseJpaDao

Direct Known Subclasses:

AbstractNotificationRegistrationDao, AllowedAttributeValueDaoImpl, AttributeValueListDaoImpl, BusinessObjectDataAttributeDaoImpl, BusinessObjectDataDaoImpl, BusinessObjectDataStatusDaoImpl, BusinessObjectDefinitionColumnDaoImpl, BusinessObjectDefinitionDaoImpl, BusinessObjectDefinitionDescriptionSuggestionDaoImpl, BusinessObjectDefinitionDescriptionSuggestionStatusDaoImpl, BusinessObjectDefinitionSubjectMatterExpertDaoImpl, BusinessObjectDefinitionTagDaoImpl, BusinessObjectFormatDaoImpl, BusinessObjectFormatExternalInterfaceDaoImpl, ConfigurationDaoImpl, CustomDdlDaoImpl, DataProviderDaoImpl, Ec2OnDemandPricingDaoImpl, EmrClusterDefinitionDaoImpl, ExpectedPartitionValueDaoImpl, ExternalInterfaceDaoImpl, FileTypeDaoImpl, GlobalAttributeDefinitionDaoImpl, GlobalAttributeDefinitionLevelDaoImpl, HerdDaoImpl, IndexFunctionsDaoImpl, JobDefinitionDaoImpl, MessageTypeDaoImpl, NamespaceDaoImpl, NamespaceIamRoleAuthorizationDaoImpl, NotificationEventTypeDaoImpl, NotificationMessageDaoImpl, PartitionKeyGroupDaoImpl, RetentionTypeDaoImpl, SchemaColumnDaoImpl, SearchIndexDaoImpl, SearchIndexStatusDaoImpl, SearchIndexTypeDaoImpl, SecurityFunctionDaoImpl, SecurityRoleDaoImpl, SecurityRoleFunctionDaoImpl, StorageDaoImpl, StorageFileDaoImpl, StoragePlatformDaoImpl, StoragePolicyDaoImpl, StoragePolicyRuleTypeDaoImpl, StoragePolicyStatusDaoImpl, StoragePolicyTransitionTypeDaoImpl, StorageUnitDaoImpl, StorageUnitStatusDaoImpl, TagDaoImpl, TagTypeDaoImpl, TrustingAccountDaoImpl, UserDaoImpl, UserNamespaceAuthorizationDaoImpl

public abstract class AbstractHerdDao
extends BaseJpaDaoImpl

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AbstractHerdDao.AggregateFunction Represents aggregate function.

Field Summary

Fields

Modifier and Type	Field and Description
protected static List<javax.persistence.metamodel.SingularAttribute<BusinessObjectDataEntity,String>>	BUSINESS_OBJECT_DATA_PARTITIONS
protected static List<javax.persistence.metamodel.SingularAttribute<BusinessObjectDataEntity,String>>	BUSINESS_OBJECT_DATA_SUBPARTITIONS
protected ConfigurationHelper	configurationHelper
static String	DEFAULT_SINGLE_DAY_DATE_MASK A default date mask for a single day formatted as yyyy-MM-dd.
static int	MAX_PARTITION_FILTERS_PER_REQUEST

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

entityManager

Constructor Summary

Constructors

Constructor and Description
AbstractHerdDao()

Method Summary

Modifier and Type	Method and Description
protected javax.persistence.criteria.Subquery<Integer>	getMaximumBusinessObjectDataVersionSubQuery(javax.persistence.criteria.CriteriaBuilder builder, javax.persistence.criteria.CriteriaQuery<?> criteria, javax.persistence.criteria.From<?,BusinessObjectDataEntity> businessObjectDataEntity, javax.persistence.criteria.From<?,BusinessObjectFormatEntity> businessObjectFormatEntity, String businessObjectDataStatus, List<String> storageNames, String storagePlatformType, String excludedStoragePlatformType, boolean selectOnlyAvailableStorageUnits) TODO This method may be bdata specific.
protected javax.persistence.criteria.Predicate	getQueryRestriction(javax.persistence.criteria.CriteriaBuilder builder, javax.persistence.criteria.From<?,BusinessObjectDataEntity> businessObjectDataEntity, javax.persistence.criteria.From<?,BusinessObjectFormatEntity> businessObjectFormatEntity, javax.persistence.criteria.From<?,FileTypeEntity> fileTypeEntity, javax.persistence.criteria.From<?,BusinessObjectDefinitionEntity> businessObjectDefinitionEntity, BusinessObjectDataKey businessObjectDataKey) TODO This method may be bdata specific.
protected javax.persistence.criteria.Predicate	getQueryRestriction(javax.persistence.criteria.CriteriaBuilder builder, javax.persistence.criteria.From<?,BusinessObjectFormatEntity> businessObjectFormatEntity, javax.persistence.criteria.From<?,FileTypeEntity> fileTypeEntity, javax.persistence.criteria.From<?,BusinessObjectDefinitionEntity> businessObjectDefinitionEntity, BusinessObjectFormatKey businessObjectFormatKey, boolean ignoreBusinessObjectFormatVersion) TODO This method may be bformat specific.
protected javax.persistence.criteria.Predicate	getQueryRestriction(javax.persistence.criteria.CriteriaBuilder builder, javax.persistence.criteria.From<?,BusinessObjectFormatEntity> businessObjectFormatEntity, javax.persistence.criteria.From<?,FileTypeEntity> fileTypeEntity, javax.persistence.criteria.From<?,BusinessObjectDefinitionEntity> businessObjectDefinitionEntity, javax.persistence.criteria.From<?,NamespaceEntity> namespaceEntity, BusinessObjectFormatKey businessObjectFormatKey, boolean ignoreBusinessObjectFormatVersion) Builds a query restriction predicate for the specified business object format entity as per business object format key values.
protected javax.persistence.criteria.Predicate	getQueryRestrictionOnBusinessObjectDataVersionAndStatus(javax.persistence.criteria.CriteriaBuilder builder, javax.persistence.criteria.From<?,BusinessObjectDataEntity> businessObjectDataEntity, javax.persistence.criteria.From<?,BusinessObjectDataStatusEntity> businessObjectDataStatusEntity, Integer businessObjectDataVersion, String businessObjectDataStatus) TODO This method may be bdata specific.
protected javax.persistence.criteria.Predicate	getQueryRestrictionOnPartitionValues(javax.persistence.criteria.CriteriaBuilder builder, javax.persistence.criteria.From<?,BusinessObjectDataEntity> businessObjectDataEntity, BusinessObjectDataKey businessObjectDataKey) TODO This method may be bdata specific.
protected javax.persistence.criteria.Predicate	getQueryRestrictionOnPartitionValues(javax.persistence.criteria.CriteriaBuilder builder, javax.persistence.criteria.From<?,BusinessObjectDataEntity> subBusinessObjectDataEntity, javax.persistence.criteria.From<?,BusinessObjectDataEntity> mainBusinessObjectDataEntity) TODO This method may be bdata specific.
protected javax.persistence.criteria.Predicate	getQueryRestrictionOnPartitionValues(javax.persistence.criteria.CriteriaBuilder builder, javax.persistence.criteria.From<?,BusinessObjectDataEntity> businessObjectDataEntity, List<List<String>> partitionFilters) TODO This method may be bdata specific.
protected javax.persistence.criteria.Predicate	getQueryRestrictionOnPartitionValues(javax.persistence.criteria.CriteriaBuilder builder, javax.persistence.criteria.From<?,BusinessObjectDataEntity> businessObjectDataEntity, String primaryPartitionValue, List<String> subPartitionValues) TODO This method may be bdata specific.
protected javax.persistence.criteria.Predicate	getQueryRestrictionOnStorage(javax.persistence.criteria.CriteriaBuilder builder, javax.persistence.criteria.From<?,StorageEntity> storageEntity, javax.persistence.criteria.From<?,StoragePlatformEntity> storagePlatformEntity, List<String> storageNames, String storagePlatformType, String excludedStoragePlatformType) Builds a query restriction predicate for the storage.
<T> T	save(T entity) Saves an entity.

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

Field Detail

DEFAULT_SINGLE_DAY_DATE_MASK

public static final String DEFAULT_SINGLE_DAY_DATE_MASK

A default date mask for a single day formatted as yyyy-MM-dd.

See Also:

Constant Field Values

MAX_PARTITION_FILTERS_PER_REQUEST

public static final int MAX_PARTITION_FILTERS_PER_REQUEST

See Also:

Constant Field Values

BUSINESS_OBJECT_DATA_PARTITIONS

protected static final List<javax.persistence.metamodel.SingularAttribute<BusinessObjectDataEntity,String>> BUSINESS_OBJECT_DATA_PARTITIONS

BUSINESS_OBJECT_DATA_SUBPARTITIONS

protected static final List<javax.persistence.metamodel.SingularAttribute<BusinessObjectDataEntity,String>> BUSINESS_OBJECT_DATA_SUBPARTITIONS

configurationHelper

@Autowired
protected ConfigurationHelper configurationHelper

Constructor Detail

AbstractHerdDao

public AbstractHerdDao()

Method Detail

getQueryRestriction

protected javax.persistence.criteria.Predicate getQueryRestriction(javax.persistence.criteria.CriteriaBuilder builder,
                                                                   javax.persistence.criteria.From<?,BusinessObjectDataEntity> businessObjectDataEntity,
                                                                   javax.persistence.criteria.From<?,BusinessObjectFormatEntity> businessObjectFormatEntity,
                                                                   javax.persistence.criteria.From<?,FileTypeEntity> fileTypeEntity,
                                                                   javax.persistence.criteria.From<?,BusinessObjectDefinitionEntity> businessObjectDefinitionEntity,
                                                                   BusinessObjectDataKey businessObjectDataKey)

TODO This method may be bdata specific. Consider creating new abstract class to group all bdata related DAO. Builds a query restriction predicate for the specified entities as per business object data key values.

Parameters:

builder - the criteria builder

businessObjectDataEntity - the business object data entity that appears in the from clause

businessObjectFormatEntity - the business object format entity that appears in the from clause

fileTypeEntity - the file type entity that appears in the from clause

businessObjectDefinitionEntity - the business object definition entity that appears in the from clause

businessObjectDataKey - the business object data key

Returns:

the query restriction predicate

getQueryRestrictionOnPartitionValues

protected javax.persistence.criteria.Predicate getQueryRestrictionOnPartitionValues(javax.persistence.criteria.CriteriaBuilder builder,
                                                                                    javax.persistence.criteria.From<?,BusinessObjectDataEntity> businessObjectDataEntity,
                                                                                    BusinessObjectDataKey businessObjectDataKey)

TODO This method may be bdata specific. Consider creating new abstract class to group all bdata related DAO. Builds a query restriction predicate for the specified business object data entity as per primary and sub-partition values in the business object data key.

Parameters:

builder - the criteria builder

businessObjectDataEntity - the business object data entity that appears in the from clause

businessObjectDataKey - the business object data key

Returns:

the query restriction predicate

getQueryRestrictionOnPartitionValues

protected javax.persistence.criteria.Predicate getQueryRestrictionOnPartitionValues(javax.persistence.criteria.CriteriaBuilder builder,
                                                                                    javax.persistence.criteria.From<?,BusinessObjectDataEntity> businessObjectDataEntity,
                                                                                    String primaryPartitionValue,
                                                                                    List<String> subPartitionValues)

TODO This method may be bdata specific. Consider creating new abstract class to group all bdata related DAO. Builds a query restriction predicate for the specified business object data entity as per primary and sub-partition values in the business object data key.

Parameters:

builder - the criteria builder

businessObjectDataEntity - the business object data entity that appears in the from clause

primaryPartitionValue - the primary partition value of the business object data

subPartitionValues - the list of sub-partition values for the business object data

Returns:

the query restriction predicate

getQueryRestriction

protected javax.persistence.criteria.Predicate getQueryRestriction(javax.persistence.criteria.CriteriaBuilder builder,
                                                                   javax.persistence.criteria.From<?,BusinessObjectFormatEntity> businessObjectFormatEntity,
                                                                   javax.persistence.criteria.From<?,FileTypeEntity> fileTypeEntity,
                                                                   javax.persistence.criteria.From<?,BusinessObjectDefinitionEntity> businessObjectDefinitionEntity,
                                                                   BusinessObjectFormatKey businessObjectFormatKey,
                                                                   boolean ignoreBusinessObjectFormatVersion)

TODO This method may be bformat specific. Consider creating new abstract class to group all bformat related DAO. Builds a query restriction predicate for the specified business object format entity as per business object format key values.

Parameters:

builder - the criteria builder

businessObjectFormatEntity - the business object format entity that appears in the from clause

fileTypeEntity - the file type entity that appears in the from clause

businessObjectDefinitionEntity - the business object definition entity that appears in the from clause

businessObjectFormatKey - the business object format key

ignoreBusinessObjectFormatVersion - specifies whether to ignore the business object format version when building the predicate

Returns:

the query restriction predicate

getQueryRestriction

protected javax.persistence.criteria.Predicate getQueryRestriction(javax.persistence.criteria.CriteriaBuilder builder,
                                                                   javax.persistence.criteria.From<?,BusinessObjectFormatEntity> businessObjectFormatEntity,
                                                                   javax.persistence.criteria.From<?,FileTypeEntity> fileTypeEntity,
                                                                   javax.persistence.criteria.From<?,BusinessObjectDefinitionEntity> businessObjectDefinitionEntity,
                                                                   javax.persistence.criteria.From<?,NamespaceEntity> namespaceEntity,
                                                                   BusinessObjectFormatKey businessObjectFormatKey,
                                                                   boolean ignoreBusinessObjectFormatVersion)

Builds a query restriction predicate for the specified business object format entity as per business object format key values.

Parameters:

builder - the criteria builder

businessObjectFormatEntity - the business object format entity that appears in the from clause

fileTypeEntity - the file type entity that appears in the from clause

businessObjectDefinitionEntity - the business object definition entity that appears in the from clause

namespaceEntity - the namespace entity that appears in the from clause

businessObjectFormatKey - the business object format key

ignoreBusinessObjectFormatVersion - specifies whether to ignore the business object format version when building the predicate

Returns:

the query restriction predicate

getQueryRestrictionOnPartitionValues

protected javax.persistence.criteria.Predicate getQueryRestrictionOnPartitionValues(javax.persistence.criteria.CriteriaBuilder builder,
                                                                                    javax.persistence.criteria.From<?,BusinessObjectDataEntity> businessObjectDataEntity,
                                                                                    List<List<String>> partitionFilters)

TODO This method may be bdata specific. Consider creating new abstract class to group all bdata related DAO. Builds a query restriction predicate for the sub-query business object data entity as per partition values from the specified main query business object data entity.

Parameters:

builder - the criteria builder

businessObjectDataEntity - the business object data entity that appears in the from clause

partitionFilters - the list of partition filter to be used to select business object data instances. Each partition filter contains a list of primary and sub-partition values in the right order up to the maximum partition levels allowed by business object data registration - with partition values for the relative partitions not to be used for selection passed as nulls.

Returns:

the query restriction predicate

getQueryRestrictionOnPartitionValues

protected javax.persistence.criteria.Predicate getQueryRestrictionOnPartitionValues(javax.persistence.criteria.CriteriaBuilder builder,
                                                                                    javax.persistence.criteria.From<?,BusinessObjectDataEntity> subBusinessObjectDataEntity,
                                                                                    javax.persistence.criteria.From<?,BusinessObjectDataEntity> mainBusinessObjectDataEntity)

TODO This method may be bdata specific. Consider creating new abstract class to group all bdata related DAO. Builds a query restriction predicate for the sub-query business object data entity as per partition values from the specified main query business object data entity.

Parameters:

builder - the criteria builder

subBusinessObjectDataEntity - the sub-query business object data entity that appears in the from clause

mainBusinessObjectDataEntity - the main query business object data entity that appears in the from clause

Returns:

the query restriction predicate

getQueryRestrictionOnBusinessObjectDataVersionAndStatus

protected javax.persistence.criteria.Predicate getQueryRestrictionOnBusinessObjectDataVersionAndStatus(javax.persistence.criteria.CriteriaBuilder builder,
                                                                                                       javax.persistence.criteria.From<?,BusinessObjectDataEntity> businessObjectDataEntity,
                                                                                                       javax.persistence.criteria.From<?,BusinessObjectDataStatusEntity> businessObjectDataStatusEntity,
                                                                                                       Integer businessObjectDataVersion,
                                                                                                       String businessObjectDataStatus)

TODO This method may be bdata specific. Consider creating new abstract class to group all bdata related DAO. Builds query restriction predicates and adds them to the query restriction as per specified business object data version and status. If a business object data version is specified, the business object data status is ignored. When both business object data version and business object data status are not specified, the sub-query restriction is not getting updated.

Parameters:

builder - the criteria builder

businessObjectDataEntity - the business object data entity that appears in the from clause

businessObjectDataStatusEntity - the business object data status entity that appears in the from clause

businessObjectDataVersion - the business object data version

businessObjectDataStatus - the business object data status. This parameter is ignored when the business object data version is specified.

Returns:

the query restriction predicate or null if both business object data version and business object data status are not specified

getQueryRestrictionOnStorage

protected javax.persistence.criteria.Predicate getQueryRestrictionOnStorage(javax.persistence.criteria.CriteriaBuilder builder,
                                                                            javax.persistence.criteria.From<?,StorageEntity> storageEntity,
                                                                            javax.persistence.criteria.From<?,StoragePlatformEntity> storagePlatformEntity,
                                                                            List<String> storageNames,
                                                                            String storagePlatformType,
                                                                            String excludedStoragePlatformType)

Builds a query restriction predicate for the storage.

Parameters:

builder - the criteria builder

storageEntity - the storage entity that appears in the from clause

storagePlatformEntity - the storage platform entity that appears in the from clause

storageNames - the list of storage names where the business object data storage units should be looked for (case-insensitive)

storagePlatformType - the optional storage platform type, e.g. S3 for Hive DDL. It is ignored when the list of storages is not empty

excludedStoragePlatformType - the optional storage platform type to be excluded from search. It is ignored when the list of storages is not empty or the storage platform type is specified

Returns:

the query restriction predicate

getMaximumBusinessObjectDataVersionSubQuery

protected javax.persistence.criteria.Subquery<Integer> getMaximumBusinessObjectDataVersionSubQuery(javax.persistence.criteria.CriteriaBuilder builder,
                                                                                                   javax.persistence.criteria.CriteriaQuery<?> criteria,
                                                                                                   javax.persistence.criteria.From<?,BusinessObjectDataEntity> businessObjectDataEntity,
                                                                                                   javax.persistence.criteria.From<?,BusinessObjectFormatEntity> businessObjectFormatEntity,
                                                                                                   String businessObjectDataStatus,
                                                                                                   List<String> storageNames,
                                                                                                   String storagePlatformType,
                                                                                                   String excludedStoragePlatformType,
                                                                                                   boolean selectOnlyAvailableStorageUnits)

TODO This method may be bdata specific. Consider creating new abstract class to group all bdata related DAO. Builds a sub-query to select the maximum business object data version.

Parameters:

builder - the criteria builder

criteria - the criteria query

businessObjectDataEntity - the business object data entity that appears in the from clause of the main query

businessObjectFormatEntity - the business object format entity that appears in the from clause of the main query

businessObjectDataStatus - the business object data status

storageNames - the list of storage names where the business object data storage units should be looked for (case-insensitive)

storagePlatformType - the optional storage platform type, e.g. S3 for Hive DDL. It is ignored when the list of storages is not empty

excludedStoragePlatformType - the optional storage platform type to be excluded from search. It is ignored when the list of storages is not empty or the storage platform type is specified

selectOnlyAvailableStorageUnits - specifies if only available storage units will be selected or any storage units regardless of their status

Returns:

the sub-query to select the maximum business object data version

save

public <T> T save(T entity)

Saves an entity.

This method overwrites the base class method by first updating an entity's audit fields if the entity is of type AuditableEntity.

Specified by:

save in interface BaseJpaDao

Overrides:

save in class BaseJpaDaoImpl

Type Parameters:

T - the type of entity.

Parameters:

entity - the entity to save.

Returns:

the saved entity.