org.kuali.rice.kew.xml
Class RuleTemplateXmlParser

java.lang.Object
  org.kuali.rice.kew.xml.RuleTemplateXmlParser

All Implemented Interfaces:

XmlConstants

public class RuleTemplateXmlParser
extends java.lang.Object
implements XmlConstants

Parses RuleTemplates from XML.

Author:

Kuali Rice Team (rice.collab@kuali.org)

See Also:

RuleTemplate

Field Summary

Fields inherited from interface org.kuali.rice.kew.xml.XmlConstants

ACTION_REQUESTED, ACTIVATION_TYPE, ACTIVE, APP_DOC_STATUSES, APPROVE_POLICY, ATTRIBUTE, ATTRIBUTE_CLASS_NAME, ATTRIBUTES, BLANKET_APPROVE_GROUP_NAME, BLANKET_APPROVE_POLICY, BLANKET_APPROVE_WORKGROUP_NAME, BRANCH, CLASS_NAME, CUSTOM_EMAIL_STYLESHEET, DATA, DATA_ELEMENT, DEFAULT_ACTION_REQUESTED, DEFAULT_EXCEPTION_GROUP_NAME, DEFAULT_EXCEPTION_WORKGROUP_NAME, DELEGATION_TEMPLATE, DELEGATION_TYPE, DELEGATIONS, DESCRIPTION, DOC_HANDLER, DOC_SEARCH_HELP_URL, DOCUMENT_TYPE, DOCUMENT_TYPE_NAMESPACE, DOCUMENT_TYPE_OVERWRITE_MODE, DOCUMENT_TYPE_SCHEMA_LOCATION, DOCUMENT_TYPES, EDL_ACTIVE, EDL_ASSOCIATION, EDL_DEFINITION, EDL_DOC_TYPE, EDL_EDOCLITE, EDL_NAMESPACE, EDL_SCHEMA_LOCATION, EDL_STYLE, EXCEPTION_GROUP_NAME, EXCEPTION_WORKGROUP, EXCEPTION_WORKGROUP_NAME, EXPRESSION, EXTENSION, EXTENSIONS, FINAL_APPROVAL, FORCE_ACTION, FROM_DATE, GROUP, GROUP_ID, GROUP_NAME, GROUP_NAMESPACE, GROUP_SCHEMA_LOCATION, GROUPS, HELP_DEFINITION_URL, HELP_ENTRIES, HELP_ENTRY, HELP_KEY, HELP_NAME, HELP_NAMESPACE, HELP_SCHEMA_LOCATION, HELP_TEXT, ID, INITIAL_NODE, IS_MEMBER_OF_GROUP, IS_MEMBER_OF_WORKGROUP, KEY, LABEL, MANDATORY_ROUTE, MEMBERS, NAME, NAMESPACE, NEXT_NODE, NOTIFICATION_FROM_ADDRESS, PARENT, PARENT_RESPONSIBILITY, PARENT_RULE_NAME, POLICIES, POLICY, POST_PROCESSOR_NAME, PRINCIPAL_ID, PRINCIPAL_NAME, PRIORITY, PROCESS_NAME, REPORTING_GROUP_NAME, REPORTING_WORKGROUP_NAME, REQUIRED, RESOLVER_CONFIG, RESPONSIBILITIES, RESPONSIBILITY, RESPONSIBILITY_ID, ROLE, ROLE_NAME, ROUTE_MODULE, ROUTE_NODES, ROUTE_PATH, ROUTE_PATHS, ROUTING_CONFIG, ROUTING_VERSION, RULE, RULE_ATTRIBUTE, RULE_ATTRIBUTE_NAMESPACE, RULE_ATTRIBUTE_SCHEMA_LOCATION, RULE_ATTRIBUTES, RULE_DEFAULTS, RULE_DELEGATION, RULE_DELEGATIONS, RULE_EXPRESSION, RULE_EXTENSION, RULE_EXTENSION_VALUE, RULE_EXTENSION_VALUES, RULE_EXTENSIONS, RULE_NAMESPACE, RULE_SCHEMA_LOCATION, RULE_TEMPLATE, RULE_TEMPLATE_NAMESPACE, RULE_TEMPLATE_SCHEMA_LOCATION, RULE_TEMPLATES, RULES, SCHEMA_LOCATION_ATTR, SCHEMA_NAMESPACE, SEARCH_RESULT_CONFIG, SEARCHING_CONFIG, SECURITY, SERVICE_NAMESPACE, SHORT_LABEL, STATUS, STYLE_NAMESPACE, STYLE_SCHEMA_LOCATION, STYLE_STYLE, STYLE_STYLES, SUMMARY, SUPER_USER_GROUP_NAME, SUPER_USER_WORKGROUP_NAME, SUPPORTS_ACKNOWLEDGE, SUPPORTS_APPROVE, SUPPORTS_COMPLETE, SUPPORTS_FYI, TO_DATE, TYPE, USER, VALUE, WORKFLOW_NAMESPACE, WORKFLOW_SCHEMA_LOCATION, WORKGROUP, WORKGROUPS

Constructor Summary

RuleTemplateXmlParser()

Method Summary

java.sql.Timestamp	formatDate(java.lang.String dateLabel, java.lang.String dateString)
java.util.List<RuleTemplate>	parseRuleTemplates(org.jdom.Element element)
java.util.List<RuleTemplate>	parseRuleTemplates(java.io.InputStream input)
protected void	updateDelegationTemplate(org.jdom.Element ruleTemplateElement, RuleTemplate updatedRuleTemplate, java.util.List<RuleTemplate> parsedRuleTemplates) Updates the rule template delegation template with the one specified in the XML (if any)
protected void	updateOrDeleteRuleTemplateOption(RuleTemplate updatedRuleTemplate, java.lang.String key, java.lang.Object value) Updates or deletes a specified rule template option on the rule template
protected boolean	updateRuleDefaults(org.jdom.Element defaultsElement, RuleTemplate updatedRuleTemplate) Updates the default/template rule options with those in the defaults element
protected void	updateRuleTemplateAttributes(org.jdom.Element ruleTemplateElement, RuleTemplate updatedRuleTemplate) Updates the attributes set on the RuleTemplate
protected void	updateRuleTemplateDefaultOptions(org.jdom.Element ruleTemplateElement, RuleTemplate updatedRuleTemplate) Updates the rule template default options.
protected void	updateRuleTemplateOptions(org.jdom.Element defaultsElement, RuleTemplate updatedRuleTemplate, boolean isDelegation) Updates the rule template defaults options with those in the defaults element

Methods inherited from class java.lang.Object

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

Constructor Detail

RuleTemplateXmlParser

public RuleTemplateXmlParser()

Method Detail

parseRuleTemplates

public java.util.List<RuleTemplate> parseRuleTemplates(java.io.InputStream input)
                                                throws java.io.IOException,
                                                       org.kuali.rice.kew.exception.InvalidXmlException

Throws:

java.io.IOException

org.kuali.rice.kew.exception.InvalidXmlException

parseRuleTemplates

public java.util.List<RuleTemplate> parseRuleTemplates(org.jdom.Element element)
                                                throws org.kuali.rice.kew.exception.InvalidXmlException

Throws:

org.kuali.rice.kew.exception.InvalidXmlException

updateRuleTemplateDefaultOptions

protected void updateRuleTemplateDefaultOptions(org.jdom.Element ruleTemplateElement,
                                                RuleTemplate updatedRuleTemplate)
                                         throws org.kuali.rice.kew.exception.InvalidXmlException

Updates the rule template default options. Updates any existing options, removes any omitted ones.

Parameters:

ruleTemplateElement - the rule template XML element

updatedRuleTemplate - the RuleTemplate being updated

Throws:

org.kuali.rice.kew.exception.InvalidXmlException

updateRuleTemplateOptions

protected void updateRuleTemplateOptions(org.jdom.Element defaultsElement,
                                         RuleTemplate updatedRuleTemplate,
                                         boolean isDelegation)
                                  throws org.kuali.rice.kew.exception.InvalidXmlException

Updates the rule template defaults options with those in the defaults element

Parameters:

defaultsElement - the ruleDefaults element

updatedRuleTemplate - the Rule Template being updated

Throws:

org.kuali.rice.kew.exception.InvalidXmlException

updateRuleDefaults

protected boolean updateRuleDefaults(org.jdom.Element defaultsElement,
                                     RuleTemplate updatedRuleTemplate)
                              throws org.kuali.rice.kew.exception.InvalidXmlException

Updates the default/template rule options with those in the defaults element

Parameters:

defaultsElement - the ruleDefaults element

updatedRuleTemplate - the Rule Template being updated

Returns:

whether this is a delegation rule template

Throws:

org.kuali.rice.kew.exception.InvalidXmlException

updateOrDeleteRuleTemplateOption

protected void updateOrDeleteRuleTemplateOption(RuleTemplate updatedRuleTemplate,
                                                java.lang.String key,
                                                java.lang.Object value)

Updates or deletes a specified rule template option on the rule template

Parameters:

updatedRuleTemplate - the RuleTemplate being updated

key - the option key

value - the option value

updateDelegationTemplate

protected void updateDelegationTemplate(org.jdom.Element ruleTemplateElement,
                                        RuleTemplate updatedRuleTemplate,
                                        java.util.List<RuleTemplate> parsedRuleTemplates)
                                 throws org.kuali.rice.kew.exception.InvalidXmlException

Updates the rule template delegation template with the one specified in the XML (if any)

Parameters:

ruleTemplateElement - the XML ruleTemplate element

updatedRuleTemplate - the rule template to update

parsedRuleTemplates - the rule templates parsed in this parsing run

Throws:

org.kuali.rice.kew.exception.InvalidXmlException - if a delegation template was specified but could not be found

updateRuleTemplateAttributes

protected void updateRuleTemplateAttributes(org.jdom.Element ruleTemplateElement,
                                            RuleTemplate updatedRuleTemplate)
                                     throws org.kuali.rice.kew.exception.InvalidXmlException

Updates the attributes set on the RuleTemplate

Parameters:

ruleTemplateElement - the XML ruleTemplate element

updatedRuleTemplate - the RuleTemplate being updated

Throws:

org.kuali.rice.kew.exception.InvalidXmlException - if there was a problem parsing the rule template attributes

formatDate

public java.sql.Timestamp formatDate(java.lang.String dateLabel,
                                     java.lang.String dateString)
                              throws org.kuali.rice.kew.exception.InvalidXmlException

Throws:

org.kuali.rice.kew.exception.InvalidXmlException