Package de.hybris.platform.ruleengine.dao.impl

Class DefaultEngineRuleDao

java.lang.Object

de.hybris.platform.servicelayer.internal.dao.AbstractItemDao

de.hybris.platform.ruleengine.dao.impl.DefaultEngineRuleDao

All Implemented Interfaces:

EngineRuleDao, Dao

public class DefaultEngineRuleDao
extends AbstractItemDao
implements EngineRuleDao

The default implementation of the Engine Rule Dao.

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	FROM_ALL_WITH_MODULE_NAME
protected static final String	GET_ALL_AVAILABLE_KIE_MODULES
protected static final String	GET_ALL_RULES_FOR_MODULE_QUERY
protected static final String	GET_ALL_RULES_FOR_VERSION
protected static final String	GET_ALL_RULES_QUERY
protected static final String	GET_MAX_VERSION_FOR_CODE
protected static final String	GET_MAX_VERSION_WITH_MODULE
protected static final String	GET_RULE_BY_CODE_AND_MODULE
protected static final String	GET_RULE_BY_UUID
protected static final String	GET_RULES_BETWEEN_VERSIONS
protected static final String	GET_RULES_BY_CODE
protected static final String	GET_RULES_BY_MULTIPLE_UUID
protected static final String	MODULE_NAME
protected static final String	RULES_MODULE

Fields inherited from class de.hybris.platform.servicelayer.internal.dao.AbstractItemDao

flexibleSearchService, modelService

Constructor Summary

Constructors

Constructor	Description
DefaultEngineRuleDao()

Method Summary

Modifier and Type	Method	Description
List<AbstractRuleEngineRuleModel>	findRulesByCode(String code)	Finds AbstractRuleEngineRuleModels by their common code.
AbstractRuleEngineRuleModel	getActiveRuleByCodeAndMaxVersion(String code, String moduleName, long version)	Finds active AbstractRuleEngineRuleModel by its code and maximum version.
List<AbstractRuleEngineRuleModel>	getActiveRules(AbstractRulesModuleModel ruleModule)	Finds all currently active AbstractRuleEngineRuleModels for a given rule module.
List<AbstractRuleEngineRuleModel>	getActiveRules(String moduleName)	Finds all currently active AbstractRuleEngineRuleModel for a given rules module.
<T extends AbstractRuleEngineRuleModel> List<T>	getActiveRulesForVersion(String moduleName, long version)	Finds currently active rules for the rule module and a given version of knowledge base
Long	getCurrentRulesSnapshotVersion(AbstractRulesModuleModel ruleModule)	Returns the current rules snapshot version number for a given module
protected Date	getRoundedTimestamp()
AbstractRuleEngineRuleModel	getRuleByCode(String code, String moduleName)	Finds AbstractRuleEngineRuleModel by its code and module.
AbstractRuleEngineRuleModel	getRuleByCodeAndMaxVersion(String code, String moduleName, long version)	Finds AbstractRuleEngineRuleModel by its code and maximum version.
AbstractRuleEngineRuleModel	getRuleByUuid(String uuid)	retrieve the instance of < T extends AbstractRuleEngineRuleModel > by UUID
<T extends AbstractRuleEngineRuleModel> List<T>	getRulesBetweenVersions(String moduleName, long startVersion, long deployedVersion)	Finds all rules for the rule module and between a given start version and old version of knowledge base
<T extends AbstractRuleEngineRuleModel> Collection<T>	getRulesByUuids(Collection<String> ruleUuids)
<T extends AbstractRuleEngineRuleModel> List<T>	getRulesForVersion(String moduleName, long version)	Finds all rules for the rule module and a given version of knowledge base
protected <T extends AbstractRuleEngineRuleModel> List<T>	getRulesForVersion(String query, Map<String,Object> queryParams, long version)
protected AbstractRulesModuleModel	getRulesModuleIfOneAvailable()
Long	getRuleVersion(String code, String moduleName)	Return the last version of a rule with a given code and given module
protected TimeService	getTimeService()
protected AbstractRuleEngineRuleModel	getWithMaximumVersion(FlexibleSearchQuery query, long version)
void	setTimeService(TimeService timeService)

Methods inherited from class de.hybris.platform.servicelayer.internal.dao.AbstractItemDao

getAllSources, getFlexibleSearchService, getModelService, getSource, load, loadAll, search, search, searchUnique, setFlexibleSearchService, setModelService

Methods inherited from class java.lang.Object

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

Field Details

MODULE_NAME

protected static final String MODULE_NAME

See Also:

• Constant Field Values

RULES_MODULE

protected static final String RULES_MODULE

See Also:

• Constant Field Values

FROM_ALL_WITH_MODULE_NAME

protected static final String FROM_ALL_WITH_MODULE_NAME

See Also:

• Constant Field Values

GET_ALL_RULES_QUERY

protected static final String GET_ALL_RULES_QUERY

See Also:

• Constant Field Values

GET_ALL_RULES_FOR_MODULE_QUERY

protected static final String GET_ALL_RULES_FOR_MODULE_QUERY

See Also:

• Constant Field Values

GET_RULE_BY_UUID

protected static final String GET_RULE_BY_UUID

See Also:

• Constant Field Values

GET_RULES_BY_MULTIPLE_UUID

protected static final String GET_RULES_BY_MULTIPLE_UUID

See Also:

• Constant Field Values

GET_RULES_BY_CODE

protected static final String GET_RULES_BY_CODE

See Also:

• Constant Field Values

GET_RULE_BY_CODE_AND_MODULE

protected static final String GET_RULE_BY_CODE_AND_MODULE

See Also:

• Constant Field Values

GET_MAX_VERSION_FOR_CODE

protected static final String GET_MAX_VERSION_FOR_CODE

See Also:

• Constant Field Values

GET_MAX_VERSION_WITH_MODULE

protected static final String GET_MAX_VERSION_WITH_MODULE

See Also:

• Constant Field Values

GET_ALL_RULES_FOR_VERSION

protected static final String GET_ALL_RULES_FOR_VERSION

See Also:

• Constant Field Values

GET_RULES_BETWEEN_VERSIONS

protected static final String GET_RULES_BETWEEN_VERSIONS

See Also:

• Constant Field Values

GET_ALL_AVAILABLE_KIE_MODULES

protected static final String GET_ALL_AVAILABLE_KIE_MODULES

See Also:

• Constant Field Values

Constructor Details

DefaultEngineRuleDao

public DefaultEngineRuleDao()

Method Details

getRuleByUuid

public AbstractRuleEngineRuleModel getRuleByUuid(String uuid)

Description copied from interface: EngineRuleDao

retrieve the instance of < T extends AbstractRuleEngineRuleModel > by UUID

Specified by:

getRuleByUuid in interface EngineRuleDao

Parameters:

uuid - the rule uuid

Returns:

AbstractRuleEngineRuleModel by its uuid. Finds AbstractRuleEngineRuleModel by its uuid.

getRulesByUuids

public <T extends AbstractRuleEngineRuleModel>
Collection<T> getRulesByUuids(Collection<String> ruleUuids)

Specified by:

getRulesByUuids in interface EngineRuleDao

Type Parameters:

T - type of the expected engine rule instance

Parameters:

ruleUuids - a collection of UUIDs to get the rules for

Returns:

a Collection if rule models

findRulesByCode

public List<AbstractRuleEngineRuleModel> findRulesByCode(String code)

Description copied from interface: EngineRuleDao

Finds AbstractRuleEngineRuleModels by their common code.

Specified by:

findRulesByCode in interface EngineRuleDao

Parameters:

code - the rule code

Returns:

list of AbstractRuleEngineRuleModel by its code.

getRuleByCode

public AbstractRuleEngineRuleModel getRuleByCode(String code,
 String moduleName)

Description copied from interface: EngineRuleDao

Finds AbstractRuleEngineRuleModel by its code and module.

Specified by:

getRuleByCode in interface EngineRuleDao

Parameters:

code - the rule code

moduleName - name of the module

Returns:

AbstractRuleEngineRuleModel by its code.

getRuleByCodeAndMaxVersion

public AbstractRuleEngineRuleModel getRuleByCodeAndMaxVersion(String code,
 String moduleName,
 long version)

Description copied from interface: EngineRuleDao

Finds AbstractRuleEngineRuleModel by its code and maximum version.

Specified by:

getRuleByCodeAndMaxVersion in interface EngineRuleDao

Parameters:

code - the rule code

moduleName - the name of the rules module

version - the maximum version of the rule

Returns:

AbstractRuleEngineRuleModel by its code and maximum version.

getActiveRuleByCodeAndMaxVersion

public AbstractRuleEngineRuleModel getActiveRuleByCodeAndMaxVersion(String code,
 String moduleName,
 long version)

Description copied from interface: EngineRuleDao

Finds active AbstractRuleEngineRuleModel by its code and maximum version.

Specified by:

getActiveRuleByCodeAndMaxVersion in interface EngineRuleDao

Parameters:

code - the rule code

moduleName - the rules module name

version - the maximum version of the rule

Returns:

AbstractRuleEngineRuleModel with active=true by its code and maximum version.

getActiveRules

public List<AbstractRuleEngineRuleModel> getActiveRules(String moduleName)

Description copied from interface: EngineRuleDao

Finds all currently active AbstractRuleEngineRuleModel for a given rules module.

Specified by:

getActiveRules in interface EngineRuleDao

Parameters:

moduleName - the name of the rules module

Returns:

list of currently active AbstractRuleEngineRuleModel

getActiveRules

public List<AbstractRuleEngineRuleModel> getActiveRules(AbstractRulesModuleModel ruleModule)

Description copied from interface: EngineRuleDao

Finds all currently active AbstractRuleEngineRuleModels for a given rule module.

Specified by:

getActiveRules in interface EngineRuleDao

Parameters:

ruleModule - the rule module

Returns:

list of currently active AbstractRuleEngineRuleModel

getCurrentRulesSnapshotVersion

public Long getCurrentRulesSnapshotVersion(AbstractRulesModuleModel ruleModule)

Description copied from interface: EngineRuleDao

Returns the current rules snapshot version number for a given module

Specified by:

getCurrentRulesSnapshotVersion in interface EngineRuleDao

Parameters:

ruleModule - the rule module

Returns:

maximum version number

getRuleVersion

public Long getRuleVersion(String code,
 String moduleName)

Description copied from interface: EngineRuleDao

Return the last version of a rule with a given code and given module

Specified by:

getRuleVersion in interface EngineRuleDao

Parameters:

code - the Rule code

moduleName - the rules module name

Returns:

last version number of a rule. Null if not found

getRulesForVersion

public <T extends AbstractRuleEngineRuleModel>
List<T> getRulesForVersion(String moduleName,
 long version)

Description copied from interface: EngineRuleDao

Finds all rules for the rule module and a given version of knowledge base

Specified by:

getRulesForVersion in interface EngineRuleDao

Parameters:

moduleName - the rules module name

version - the KieBase version

Returns:

list of rules, valid for a given KieBase version

getRulesBetweenVersions

public <T extends AbstractRuleEngineRuleModel>
List<T> getRulesBetweenVersions(String moduleName,
 long startVersion,
 long deployedVersion)

Description copied from interface: EngineRuleDao

Finds all rules for the rule module and between a given start version and old version of knowledge base

Specified by:

getRulesBetweenVersions in interface EngineRuleDao

Parameters:

moduleName - the rules module name

startVersion - the start KieBase version

deployedVersion - the deployed KieBase version

Returns:

list of rules, valid for between a start and deployed KieBase version

getActiveRulesForVersion

public <T extends AbstractRuleEngineRuleModel>
List<T> getActiveRulesForVersion(String moduleName,
 long version)

Description copied from interface: EngineRuleDao

Finds currently active rules for the rule module and a given version of knowledge base

Specified by:

getActiveRulesForVersion in interface EngineRuleDao

Parameters:

moduleName - the rules module name

version - the KieBase version

Returns:

list of rules, valid for a given KieBase version

getRulesForVersion

protected <T extends AbstractRuleEngineRuleModel>
List<T> getRulesForVersion(String query,
 Map<String,Object> queryParams,
 long version)

getWithMaximumVersion

protected AbstractRuleEngineRuleModel getWithMaximumVersion(FlexibleSearchQuery query,
 long version)

getRoundedTimestamp

protected Date getRoundedTimestamp()

Returns:

the current time, but with seconds set to zero (for FlexibleSearchQuery caching benefits to the minute).

getRulesModuleIfOneAvailable

protected AbstractRulesModuleModel getRulesModuleIfOneAvailable()

getTimeService

protected TimeService getTimeService()

setTimeService

public void setTimeService(TimeService timeService)