org.kuali.rice.krms.service.impl

Class RuleViewHelperServiceImpl

java.lang.Object

org.kuali.rice.krad.uif.service.impl.ViewHelperServiceImpl

org.kuali.student.common.uif.service.impl.KSViewHelperServiceImpl

org.kuali.rice.krms.service.impl.RuleViewHelperServiceImpl

All Implemented Interfaces:

Serializable, ViewHelperService, RuleViewHelperService, KSViewHelperService

Direct Known Subclasses:

LURuleViewHelperServiceImpl

public class RuleViewHelperServiceImpl
extends KSViewHelperServiceImpl
implements RuleViewHelperService

Helpers Service for the Rule Pages.

Author:

Kuali Student Team

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
RuleViewHelperServiceImpl()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addCustomContainerComponents(View view, Object model, Container container)
void	buildActions(RuleEditor ruleEditor)
Tree<CompareTreeNode,String>	buildCompareTree(RuleEditor original, RuleEditor compare)
Tree<CompareTreeNode,String>	buildMultiViewTree(RuleEditor original, RuleEditor compare)
Boolean	compareCompoundProposition(List<PropositionEditor> original, List<PropositionEditor> compare) Recursively compare child propositions.
Boolean	compareProposition(PropositionEditor original, PropositionEditor compare) Method to handle the proposition comparison recursively.
Boolean	compareRules(RuleEditor original) Compare all the propositions in a rule tree with a parent rule tree.
Boolean	compareTerm(List<TermParameterEditor> original, List<TermParameterEditor> compare) Compare all the keys and values of the term parameter.
void	configurePropositionForType(PropositionEditor proposition)
PropositionEditor	copyProposition(PropositionEditor oldProposition) Make a new copy of the current proposition including the compounds.
protected PropositionEditor	copyPropositionEditor(PropositionEditor oldProposition) Used when the user clicked the copy button.
PropositionEditor	createCompoundPropositionBoStub(PropositionEditor existing, boolean addNewChild)
PropositionEditor	createSimplePropositionBoStub(PropositionEditor sibling) Creates a new instance of a simple proposition.
void	finPropositionEditor(PropositionEditor propositionEditor) Finalizes the proposition, setting the type and terms.
protected RuleCompareTreeBuilder	getCompareTreeBuilder()
protected RuleEditTreeBuilder	getEditTreeBuilder()
protected KrmsTypeRepositoryService	getKrmsTypeRepositoryService()
protected NaturalLanguageHelper	getNaturalLanguageHelper()
protected RulePreviewTreeBuilder	getPreviewTreeBuilder()
Class<? extends PropositionEditor>	getPropositionEditorClass() Override this method to return a different class type if you need to use a different propositoin editor class.
protected RuleEditor	getRuleEditor(Object model)
protected RuleManagementService	getRuleManagementService()
TemplateInfo	getTemplateForType(String type)
protected TemplateRegistry	getTemplateRegistry()
Map<String,String>	getTermParameters(PropositionEditor proposition) Create TermEditor from the TermDefinition objects to be used in the ui and return a map of the key and values of the term parameters.
TermRepositoryService	getTermRepositoryService()
protected RuleViewTreeBuilder	getViewTreeBuilder()
void	initPropositionEditor(PropositionEditor propositionEditor) Initializes the proposition, populating the type and terms.
void	refreshInitTrees(RuleEditor rule)
void	refreshViewTree(RuleEditor rule) Rebuild the tree used for the view only trees.
void	resetDescription(PropositionEditor prop) Clear the description and natural language on proposition editors.
void	setTypeForCompoundOpCode(PropositionEditor proposition, String compoundOpCode)
Boolean	validateProposition(PropositionEditor proposition) Validate the proposition.
Boolean	validateRule(RuleEditor rule) Validate the rule.

Methods inherited from class org.kuali.student.common.uif.service.impl.KSViewHelperServiceImpl

convertServiceExceptionsToUI, createContextInfo, getHelper, getStateInfo, getStateService, getTypeInfo, getTypeService, setHelperClasses

Methods inherited from class org.kuali.rice.krad.uif.service.impl.ViewHelperServiceImpl

addLine, adjustIdIfNecessary, applyAuthorizationAndPresentationLogic, applyDefaultValues, applyDefaultValuesForCollectionLine, buildClientSideStateScript, buildExportTableData, buildExportTableRow, buildGrowlScript, buildInquiryLink, cleanViewAfterRender, findNestedDictionaryAttribute, getBusinessObjectService, getCommonContext, getConfigurationService, getDataDictionaryService, getExportTableFormatOptions, getExpressionEvaluator, getPersistenceService, getPersistenceStructureService, getPreModelContext, getViewDictionaryService, initializeDataFieldFromDataDictionary, invokeMethodFinalizer, logAndThrowRuntime, performAddLineValidation, performApplyModel, performComponentApplyModel, performComponentFinalize, performComponentInitialization, performComponentLifecycle, performCustomApplyModel, performCustomFinalize, performCustomInitialization, performDeleteLineValidation, performFinalize, performInitialization, populateDefaultValueForField, populateViewFromRequestParameters, processAfterAddLine, processAfterDeleteLine, processAfterSaveLine, processAnyRemoteFieldsHolder, processBeforeAddLine, processBeforeSaveLine, processCollectionAddBlankLine, processCollectionAddLine, processCollectionDeleteLine, processCollectionSaveLine, processMultipleValueLookupResults, refreshReferences, retrieveEditModesAndActionFlags, runComponentModifiers, setBusinessObjectService, setConfigurationService, setDataDictionaryService, setExpressionEvaluator, setPersistenceService, setPersistenceStructureService, setViewContext, setViewDictionaryService, spawnSubLifecyle, syncClientSideStateForComponent

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.kuali.rice.krad.uif.service.ViewHelperService

applyDefaultValuesForCollectionLine, buildExportTableData, buildInquiryLink, cleanViewAfterRender, getCommonContext, getExpressionEvaluator, performApplyModel, performComponentInitialization, performComponentLifecycle, performFinalize, performInitialization, populateViewFromRequestParameters, processCollectionAddBlankLine, processCollectionAddLine, processCollectionDeleteLine, processCollectionSaveLine, processMultipleValueLookupResults, refreshReferences, spawnSubLifecyle

Constructor Detail

RuleViewHelperServiceImpl

public RuleViewHelperServiceImpl()

Method Detail

getRuleEditor

protected RuleEditor getRuleEditor(Object model)

getTemplateForType

public TemplateInfo getTemplateForType(String type)

Specified by:

getTemplateForType in interface RuleViewHelperService

addCustomContainerComponents

protected void addCustomContainerComponents(View view,
                                Object model,
                                Container container)

Overrides:

addCustomContainerComponents in class ViewHelperServiceImpl

validateRule

public Boolean validateRule(RuleEditor rule)

Validate the rule.

Specified by:

validateRule in interface RuleViewHelperService

Parameters:

rule -

Returns:

True if valid, false if not.

validateProposition

public Boolean validateProposition(PropositionEditor proposition)

Validate the proposition.

Specified by:

validateProposition in interface RuleViewHelperService

Parameters:

proposition -

Returns:

True if valid, false if not.

initPropositionEditor

public void initPropositionEditor(PropositionEditor propositionEditor)

Initializes the proposition, populating the type and terms.

Specified by:

initPropositionEditor in interface RuleViewHelperService

Parameters:

propositionEditor -

finPropositionEditor

public void finPropositionEditor(PropositionEditor propositionEditor)

Finalizes the proposition, setting the type and terms.

Specified by:

finPropositionEditor in interface RuleViewHelperService

Parameters:

propositionEditor -

getTermParameters

public Map<String,String> getTermParameters(PropositionEditor proposition)

Create TermEditor from the TermDefinition objects to be used in the ui and return a map of the key and values of the term parameters.

Specified by:

getTermParameters in interface RuleViewHelperService

Parameters:

proposition -

Returns:

resetDescription

public void resetDescription(PropositionEditor prop)

Clear the description and natural language on proposition editors.

Specified by:

resetDescription in interface RuleViewHelperService

Parameters:

prop -

buildActions

public void buildActions(RuleEditor ruleEditor)

Specified by:

buildActions in interface RuleViewHelperService

configurePropositionForType

public void configurePropositionForType(PropositionEditor proposition)

Specified by:

configurePropositionForType in interface RuleViewHelperService

refreshInitTrees

public void refreshInitTrees(RuleEditor rule)

Specified by:

refreshInitTrees in interface RuleViewHelperService

refreshViewTree

public void refreshViewTree(RuleEditor rule)

Rebuild the tree used for the view only trees.

Specified by:

refreshViewTree in interface RuleViewHelperService

Parameters:

rule -

buildCompareTree

public Tree<CompareTreeNode,String> buildCompareTree(RuleEditor original,
                                            RuleEditor compare)

Specified by:

buildCompareTree in interface RuleViewHelperService

buildMultiViewTree

public Tree<CompareTreeNode,String> buildMultiViewTree(RuleEditor original,
                                              RuleEditor compare)

Specified by:

buildMultiViewTree in interface RuleViewHelperService

compareRules

public Boolean compareRules(RuleEditor original)

Compare all the propositions in a rule tree with a parent rule tree. Returns false if any proposition's type or term parameters are not the same.

Apart from the type and termparameters, all other detail is derived from the typeid and therefore not included in the comparison. *

Specified by:

compareRules in interface RuleViewHelperService

Parameters:

original -

Returns:

boolean

Throws:

Exception

compareProposition

public Boolean compareProposition(PropositionEditor original,
                         PropositionEditor compare)

Method to handle the proposition comparison recursively.

Specified by:

compareProposition in interface RuleViewHelperService

Parameters:

original -

compare -

Returns:

true if proposition are the same.

compareTerm

public Boolean compareTerm(List<TermParameterEditor> original,
                  List<TermParameterEditor> compare)

Compare all the keys and values of the term parameter. Returns false if any of the keys (names) or values of the term paramters is not the same.

Specified by:

compareTerm in interface RuleViewHelperService

Parameters:

original - list of term parameters for current term

compare - list of term paramters to compare with.

Returns:

true if all names and values are the same.

compareCompoundProposition

public Boolean compareCompoundProposition(List<PropositionEditor> original,
                                 List<PropositionEditor> compare)

Recursively compare child propositions.

Specified by:

compareCompoundProposition in interface RuleViewHelperService

Parameters:

original -

compare -

Returns:

copyProposition

public PropositionEditor copyProposition(PropositionEditor oldProposition)

Make a new copy of the current proposition including the compounds.

The deepcopy is done to make sure that create a full copy and does not only copy the references.

Specified by:

copyProposition in interface RuleViewHelperService

Parameters:

oldProposition -

Returns:

copyPropositionEditor

protected PropositionEditor copyPropositionEditor(PropositionEditor oldProposition)

Used when the user clicked the copy button. It creates a new copy of the proposition with all the related compound propositions.

The compound propositions is handled recursively.

Parameters:

oldProposition -

Returns:

createCompoundPropositionBoStub

public PropositionEditor createCompoundPropositionBoStub(PropositionEditor existing,
                                                boolean addNewChild)

Specified by:

createCompoundPropositionBoStub in interface RuleViewHelperService

setTypeForCompoundOpCode

public void setTypeForCompoundOpCode(PropositionEditor proposition,
                            String compoundOpCode)

Specified by:

setTypeForCompoundOpCode in interface RuleViewHelperService

createSimplePropositionBoStub

public PropositionEditor createSimplePropositionBoStub(PropositionEditor sibling)

Creates a new instance of a simple proposition.

Specified by:

createSimplePropositionBoStub in interface RuleViewHelperService

Parameters:

sibling -

Returns:

getPropositionEditorClass

public Class<? extends PropositionEditor> getPropositionEditorClass()

Override this method to return a different class type if you need to use a different propositoin editor class.

Returns:

getRuleManagementService

protected RuleManagementService getRuleManagementService()

getCompareTreeBuilder

protected RuleCompareTreeBuilder getCompareTreeBuilder()

getEditTreeBuilder

protected RuleEditTreeBuilder getEditTreeBuilder()

getPreviewTreeBuilder

protected RulePreviewTreeBuilder getPreviewTreeBuilder()

getViewTreeBuilder

protected RuleViewTreeBuilder getViewTreeBuilder()

getNaturalLanguageHelper

protected NaturalLanguageHelper getNaturalLanguageHelper()

getTemplateRegistry

protected TemplateRegistry getTemplateRegistry()

getKrmsTypeRepositoryService

protected KrmsTypeRepositoryService getKrmsTypeRepositoryService()

getTermRepositoryService

public TermRepositoryService getTermRepositoryService()