View Javadoc

1   /**
2    * Copyright 2005-2013 The Kuali Foundation
3    *
4    * Licensed under the Educational Community License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    * http://www.opensource.org/licenses/ecl2.php
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  package org.kuali.rice.krad.service.impl;
17  
18  import org.apache.commons.lang.StringUtils;
19  import org.kuali.rice.core.api.config.property.ConfigurationService;
20  import org.kuali.rice.core.api.exception.RiceRuntimeException;
21  import org.kuali.rice.core.api.uif.DataType;
22  import org.kuali.rice.core.api.uif.RemotableAbstractControl;
23  import org.kuali.rice.core.api.uif.RemotableAbstractWidget;
24  import org.kuali.rice.core.api.uif.RemotableAttributeField;
25  import org.kuali.rice.core.api.uif.RemotableCheckbox;
26  import org.kuali.rice.core.api.uif.RemotableCheckboxGroup;
27  import org.kuali.rice.core.api.uif.RemotableHiddenInput;
28  import org.kuali.rice.core.api.uif.RemotableQuickFinder;
29  import org.kuali.rice.core.api.uif.RemotableRadioButtonGroup;
30  import org.kuali.rice.core.api.uif.RemotableSelect;
31  import org.kuali.rice.core.api.uif.RemotableTextInput;
32  import org.kuali.rice.core.api.uif.RemotableTextarea;
33  import org.kuali.rice.core.api.util.KeyValue;
34  import org.kuali.rice.krad.bo.BusinessObject;
35  import org.kuali.rice.krad.bo.DataObjectRelationship;
36  import org.kuali.rice.krad.datadictionary.AttributeDefinition;
37  import org.kuali.rice.krad.service.DataDictionaryRemoteFieldService;
38  import org.kuali.rice.krad.service.DataDictionaryService;
39  import org.kuali.rice.krad.service.DataObjectMetaDataService;
40  import org.kuali.rice.krad.service.KRADServiceLocator;
41  import org.kuali.rice.krad.service.KRADServiceLocatorInternal;
42  import org.kuali.rice.krad.service.KRADServiceLocatorWeb;
43  import org.kuali.rice.krad.uif.control.CheckboxControl;
44  import org.kuali.rice.krad.uif.control.CheckboxGroupControl;
45  import org.kuali.rice.krad.uif.control.Control;
46  import org.kuali.rice.krad.uif.control.GroupControl;
47  import org.kuali.rice.krad.uif.control.HiddenControl;
48  import org.kuali.rice.krad.uif.control.MultiValueControl;
49  import org.kuali.rice.krad.uif.control.RadioGroupControl;
50  import org.kuali.rice.krad.uif.control.SelectControl;
51  import org.kuali.rice.krad.uif.control.TextAreaControl;
52  import org.kuali.rice.krad.uif.control.TextControl;
53  import org.kuali.rice.krad.uif.control.UserControl;
54  import org.kuali.rice.krad.util.KRADConstants;
55  import org.kuali.rice.krad.workflow.service.WorkflowAttributePropertyResolutionService;
56  
57  import java.util.Collections;
58  import java.util.HashMap;
59  import java.util.List;
60  import java.util.Map;
61  
62  /**
63   * Implementation of the {@link DataDictionaryRemoteFieldService} service
64   *
65   * @author Kuali Rice Team (rice.collab@kuali.org)
66   */
67  public class DataDictionaryRemoteFieldServiceImpl implements DataDictionaryRemoteFieldService {
68  
69      /**
70       * @see org.kuali.rice.krad.service.DataDictionaryRemoteFieldService#buildRemotableFieldFromAttributeDefinition(java.lang.String,
71       *      java.lang.String)
72       */
73      public RemotableAttributeField buildRemotableFieldFromAttributeDefinition(String componentClassName,
74              String attributeName) {
75          AttributeDefinition baseDefinition;
76          Class<?> componentClass;
77          // try to resolve the component name - if not possible - try to pull the definition from the app mediation service
78          try {
79              componentClass = (Class<? extends BusinessObject>) Class.forName(componentClassName);
80              baseDefinition = getDataDictionaryService().getDataDictionary().getDictionaryObjectEntry(componentClassName)
81                      .getAttributeDefinition(attributeName);
82          } catch (ClassNotFoundException ex) {
83              throw new RiceRuntimeException("Unable to find attribute definition for attribute : " + attributeName);
84          }
85  
86          RemotableAttributeField.Builder definition = RemotableAttributeField.Builder.create(baseDefinition.getName());
87  
88          definition.setLongLabel(baseDefinition.getLabel());
89          definition.setShortLabel(baseDefinition.getShortLabel());
90          definition.setMaxLength(baseDefinition.getMaxLength());
91  
92          if (baseDefinition.isRequired() != null) {
93              definition.setRequired(baseDefinition.isRequired());
94          }
95  
96          definition.setForceUpperCase(baseDefinition.getForceUppercase());
97          //set the datatype - needed for successful custom doc searches
98          WorkflowAttributePropertyResolutionService propertyResolutionService = KRADServiceLocatorInternal
99                  .getWorkflowAttributePropertyResolutionService();
100         String dataType = propertyResolutionService.determineFieldDataType(
101                 (Class<? extends BusinessObject>) componentClass, attributeName);
102         definition.setDataType(DataType.valueOf(dataType.toUpperCase()));
103         RemotableAbstractControl.Builder control = createControl(baseDefinition);
104         if (control != null) {
105             definition.setControl(control);
106         }
107 
108         RemotableQuickFinder.Builder qf = createQuickFinder(componentClass, attributeName);
109         if (qf != null) {
110             definition.setWidgets(Collections.<RemotableAbstractWidget.Builder>singletonList(qf));
111         }
112 
113         return definition.build();
114     }
115 
116     /**
117      * Creates a {@link RemotableAbstractControl} instance based on the control definition within the given
118      * attribute definition
119      *
120      * @param attr - attribute definition instance to pull control from
121      * @return RemotableAbstractControl instance or null if one could not be built
122      */
123     protected RemotableAbstractControl.Builder createControl(AttributeDefinition attr) {
124         Control control = attr.getControlField();
125 
126         if (control != null) {
127             if (control instanceof CheckboxControl) {
128                 return RemotableCheckbox.Builder.create();
129             } else if (control instanceof CheckboxGroupControl) {
130                 return RemotableCheckboxGroup.Builder.create(getValues(attr));
131             } else if (control instanceof HiddenControl) {
132                 return RemotableHiddenInput.Builder.create();
133             } else if (control instanceof SelectControl) {
134                 RemotableSelect.Builder b = RemotableSelect.Builder.create(getValues(attr));
135                 b.setMultiple(((SelectControl) control).isMultiple());
136                 b.setSize(((SelectControl) control).getSize());
137             } else if (control instanceof RadioGroupControl) {
138                 return RemotableRadioButtonGroup.Builder.create(getValues(attr));
139             } else if (control instanceof TextControl) {
140                 final RemotableTextInput.Builder b = RemotableTextInput.Builder.create();
141                 b.setSize(((TextControl) control).getSize());
142                 return b;
143             } else if (control instanceof UserControl) {
144                 final RemotableTextInput.Builder b = RemotableTextInput.Builder.create();
145                 b.setSize(((UserControl) control).getSize());
146                 return b;
147             } else if (control instanceof GroupControl) {
148                 final RemotableTextInput.Builder b = RemotableTextInput.Builder.create();
149                 b.setSize(((GroupControl) control).getSize());
150                 return b;
151             } else if (control instanceof TextAreaControl) {
152                 final RemotableTextarea.Builder b = RemotableTextarea.Builder.create();
153                 b.setCols(((TextAreaControl) control).getCols());
154                 b.setRows(((TextAreaControl) control).getRows());
155                 return b;
156             }
157         }
158         
159         return null;
160     }
161 
162     /**
163      * Will first try to retrieve options configured on the control.  If that doesn't return any values then will
164      * try to use the optionfinder on the AttributeDefinition.
165      *
166      * @param attr - AttributeDefinition
167      * @return Map of key value pairs
168      */
169     protected Map<String, String> getValues(AttributeDefinition attr) {
170         Control control = attr.getControlField();
171 
172         if ((control instanceof MultiValueControl)
173                 && (((MultiValueControl) control).getOptions() != null)
174                 && !((MultiValueControl) control).getOptions().isEmpty()) {
175             List<KeyValue> keyValues = ((MultiValueControl) control).getOptions();
176                     Map<String, String> options = new HashMap<String, String> ();
177                     for (KeyValue keyValue : keyValues) {
178                         options.put(keyValue.getKey(), keyValue.getValue());
179                     }
180                     return options;
181         } else if (attr.getOptionsFinder() != null) {
182             return attr.getOptionsFinder().getKeyLabelMap();
183         }
184 
185         return Collections.emptyMap();
186     }
187 
188     /**
189      * Builds a {@link RemotableQuickFinder} instance for the given attribute based on determined relationships
190      *
191      * <p>
192      * Uses the {@link DataObjectMetaDataService} to find relationships the given attribute participates in within the
193      * given class. If a relationship is not found, the title attribute is also checked to determine if a lookup should
194      * be rendered back to the component class itself. If a relationship suitable for lookup is found, the associated
195      * field conversions and lookup parameters are built
196      * </p>
197      *
198      * @param componentClass - class that attribute belongs to and should be checked for relationships
199      * @param attributeName - name of the attribute to determine quickfinder for
200      * @return RemotableQuickFinder.Builder instance for the configured lookup, or null if one could not be found
201      */
202     protected RemotableQuickFinder.Builder createQuickFinder(Class<?> componentClass, String attributeName) {
203         Object sampleComponent;
204         try {
205             sampleComponent = componentClass.newInstance();
206         } catch (InstantiationException e) {
207             throw new RiceRuntimeException(e);
208         } catch (IllegalAccessException e) {
209             throw new RiceRuntimeException(e);
210         }
211 
212         String lookupClassName = null;
213         Map<String, String> fieldConversions = new HashMap<String, String>();
214         Map<String, String> lookupParameters = new HashMap<String, String>();
215 
216         DataObjectRelationship relationship = getDataObjectMetaDataService().getDataObjectRelationship(sampleComponent,
217                 componentClass, attributeName, "", true, true, false);
218         if (relationship != null) {
219             lookupClassName = relationship.getRelatedClass().getName();
220 
221             for (Map.Entry<String, String> entry : relationship.getParentToChildReferences().entrySet()) {
222                 String fromField = entry.getValue();
223                 String toField = entry.getKey();
224                 fieldConversions.put(fromField, toField);
225             }
226 
227             for (Map.Entry<String, String> entry : relationship.getParentToChildReferences().entrySet()) {
228                 String fromField = entry.getKey();
229                 String toField = entry.getValue();
230 
231                 if (relationship.getUserVisibleIdentifierKey() == null || relationship.getUserVisibleIdentifierKey()
232                         .equals(fromField)) {
233                     lookupParameters.put(fromField, toField);
234                 }
235             }
236         } else {
237             // check for title attribute and if match build lookup to component class using pk fields
238             String titleAttribute = getDataObjectMetaDataService().getTitleAttribute(componentClass);
239             if (StringUtils.equals(titleAttribute, attributeName)) {
240                 lookupClassName = componentClass.getName();
241 
242                 List<String> pkAttributes = getDataObjectMetaDataService().listPrimaryKeyFieldNames(componentClass);
243                 for (String pkAttribute : pkAttributes) {
244                     fieldConversions.put(pkAttribute, pkAttribute);
245                     if (!StringUtils.equals(pkAttribute, attributeName)) {
246                         lookupParameters.put(pkAttribute, pkAttribute);
247                     }
248                 }
249             }
250         }
251         
252         if (StringUtils.isNotBlank(lookupClassName)) {
253             String baseUrl = getKualiConfigurationService().getPropertyValueAsString(KRADConstants.KRAD_LOOKUP_URL_KEY);
254             RemotableQuickFinder.Builder builder = RemotableQuickFinder.Builder.create(baseUrl, lookupClassName);
255             builder.setLookupParameters(lookupParameters);
256             builder.setFieldConversions(fieldConversions);
257 
258             return builder;
259         }
260 
261         return null;
262     }
263 
264     protected DataDictionaryService getDataDictionaryService() {
265         return KRADServiceLocatorWeb.getDataDictionaryService();
266     }
267 
268     protected DataObjectMetaDataService getDataObjectMetaDataService() {
269         return KRADServiceLocatorWeb.getDataObjectMetaDataService();
270     }
271 
272     protected ConfigurationService getKualiConfigurationService() {
273         return KRADServiceLocator.getKualiConfigurationService();
274     }
275 }