| 1 | |
|
| 2 | |
|
| 3 | |
|
| 4 | |
|
| 5 | |
|
| 6 | |
|
| 7 | |
|
| 8 | |
|
| 9 | |
|
| 10 | |
|
| 11 | |
|
| 12 | |
|
| 13 | |
|
| 14 | |
|
| 15 | |
|
| 16 | |
package org.kuali.rice.kns.datadictionary; |
| 17 | |
|
| 18 | |
import java.util.ArrayList; |
| 19 | |
import java.util.HashMap; |
| 20 | |
import java.util.List; |
| 21 | |
import java.util.Map; |
| 22 | |
|
| 23 | |
import org.apache.commons.lang.StringUtils; |
| 24 | |
import org.kuali.rice.kns.bo.BusinessObject; |
| 25 | |
import org.kuali.rice.kns.datadictionary.exception.AttributeValidationException; |
| 26 | |
import org.kuali.rice.kns.datadictionary.exception.DuplicateEntryException; |
| 27 | |
|
| 28 | |
|
| 29 | |
|
| 30 | |
|
| 31 | |
|
| 32 | |
|
| 33 | |
|
| 34 | |
|
| 35 | |
|
| 36 | |
|
| 37 | |
|
| 38 | |
|
| 39 | |
|
| 40 | |
|
| 41 | |
|
| 42 | |
|
| 43 | |
|
| 44 | |
|
| 45 | |
|
| 46 | |
|
| 47 | |
|
| 48 | |
|
| 49 | |
|
| 50 | |
|
| 51 | |
|
| 52 | |
|
| 53 | |
public class MaintainableCollectionDefinition extends MaintainableItemDefinition implements CollectionDefinitionI{ |
| 54 | |
private static final long serialVersionUID = -5617868782623587053L; |
| 55 | |
|
| 56 | |
|
| 57 | |
|
| 58 | |
|
| 59 | |
protected Class<? extends BusinessObject> businessObjectClass; |
| 60 | |
|
| 61 | |
protected Class<? extends BusinessObject> sourceClassName; |
| 62 | |
protected String summaryTitle; |
| 63 | |
protected String attributeToHighlightOnDuplicateKey; |
| 64 | |
|
| 65 | 0 | protected boolean includeAddLine = true; |
| 66 | 0 | protected boolean includeMultipleLookupLine = true; |
| 67 | 0 | private boolean alwaysAllowCollectionDeletion = false; |
| 68 | |
|
| 69 | 0 | protected Map<String,MaintainableFieldDefinition> maintainableFieldMap = new HashMap<String, MaintainableFieldDefinition>(); |
| 70 | 0 | protected Map<String,MaintainableCollectionDefinition> maintainableCollectionMap = new HashMap<String, MaintainableCollectionDefinition>(); |
| 71 | 0 | protected Map<String,MaintainableFieldDefinition> summaryFieldMap = new HashMap<String, MaintainableFieldDefinition>(); |
| 72 | 0 | protected Map<String,MaintainableFieldDefinition> duplicateIdentificationFieldMap = new HashMap<String, MaintainableFieldDefinition>(); |
| 73 | 0 | protected List<MaintainableFieldDefinition> maintainableFields = new ArrayList<MaintainableFieldDefinition>(); |
| 74 | 0 | protected List<MaintainableCollectionDefinition> maintainableCollections = new ArrayList<MaintainableCollectionDefinition>(); |
| 75 | 0 | protected List<MaintainableFieldDefinition> summaryFields = new ArrayList<MaintainableFieldDefinition>(); |
| 76 | 0 | protected List<MaintainableFieldDefinition> duplicateIdentificationFields = new ArrayList<MaintainableFieldDefinition>(); |
| 77 | |
|
| 78 | 0 | public MaintainableCollectionDefinition() {} |
| 79 | |
|
| 80 | |
|
| 81 | |
|
| 82 | |
|
| 83 | |
|
| 84 | |
|
| 85 | |
public Class<? extends BusinessObject> getBusinessObjectClass() { |
| 86 | 0 | return businessObjectClass; |
| 87 | |
} |
| 88 | |
|
| 89 | |
|
| 90 | |
|
| 91 | |
|
| 92 | |
public void setBusinessObjectClass(Class<? extends BusinessObject> businessObjectClass) { |
| 93 | 0 | if (businessObjectClass == null) { |
| 94 | 0 | throw new IllegalArgumentException("invalid (null) businessObjectClass"); |
| 95 | |
} |
| 96 | |
|
| 97 | 0 | this.businessObjectClass = businessObjectClass; |
| 98 | 0 | } |
| 99 | |
|
| 100 | |
|
| 101 | |
|
| 102 | |
|
| 103 | |
|
| 104 | |
public List<MaintainableFieldDefinition> getMaintainableFields() { |
| 105 | 0 | return maintainableFields; |
| 106 | |
} |
| 107 | |
|
| 108 | |
public List<? extends FieldDefinitionI> getFields() { |
| 109 | 0 | return maintainableFields; |
| 110 | |
} |
| 111 | |
|
| 112 | |
|
| 113 | |
|
| 114 | |
|
| 115 | |
|
| 116 | |
|
| 117 | |
public void completeValidation(Class rootBusinessObjectClass, Class otherBusinessObjectClass) { |
| 118 | 0 | if (!DataDictionary.isCollectionPropertyOf(rootBusinessObjectClass, getName())) { |
| 119 | 0 | throw new AttributeValidationException("unable to find collection named '" + getName() + "' in rootBusinessObjectClass '" + rootBusinessObjectClass.getName() + "' (" + "" + ")"); |
| 120 | |
} |
| 121 | |
|
| 122 | 0 | if (dissallowDuplicateKey()) { |
| 123 | 0 | if (!DataDictionary.isPropertyOf(businessObjectClass, attributeToHighlightOnDuplicateKey)) { |
| 124 | 0 | throw new AttributeValidationException("unable to find attribute named '" + attributeToHighlightOnDuplicateKey + "'in businessObjectClass '" + businessObjectClass.getName() + "' of collection '" + getName() + "' in rootBusinessObjectClass '" + rootBusinessObjectClass.getName() + "' (" + "" + ")"); |
| 125 | |
} |
| 126 | |
} |
| 127 | |
|
| 128 | 0 | for (MaintainableFieldDefinition maintainableField : maintainableFields ) { |
| 129 | 0 | maintainableField.completeValidation(businessObjectClass, null); |
| 130 | |
} |
| 131 | |
|
| 132 | 0 | for (MaintainableCollectionDefinition maintainableCollection : maintainableCollections ) { |
| 133 | 0 | maintainableCollection.completeValidation(businessObjectClass, null); |
| 134 | |
} |
| 135 | |
|
| 136 | |
|
| 137 | |
|
| 138 | |
|
| 139 | |
|
| 140 | |
|
| 141 | |
|
| 142 | |
|
| 143 | 0 | } |
| 144 | |
|
| 145 | |
|
| 146 | |
|
| 147 | |
|
| 148 | |
|
| 149 | |
public String toString() { |
| 150 | 0 | return "MaintainableCollectionDefinition for " + getName(); |
| 151 | |
} |
| 152 | |
|
| 153 | |
|
| 154 | |
public Class<? extends BusinessObject> getSourceClassName() { |
| 155 | 0 | return sourceClassName; |
| 156 | |
} |
| 157 | |
|
| 158 | |
|
| 159 | |
|
| 160 | |
|
| 161 | |
public void setSourceClassName(Class<? extends BusinessObject> sourceClass) { |
| 162 | 0 | this.sourceClassName = sourceClass; |
| 163 | 0 | } |
| 164 | |
|
| 165 | |
public boolean getIncludeAddLine() { |
| 166 | 0 | return includeAddLine; |
| 167 | |
} |
| 168 | |
|
| 169 | |
|
| 170 | |
|
| 171 | |
public void setIncludeAddLine(boolean includeAddLine) { |
| 172 | 0 | this.includeAddLine = includeAddLine; |
| 173 | 0 | } |
| 174 | |
|
| 175 | |
|
| 176 | |
|
| 177 | |
|
| 178 | |
|
| 179 | |
public List<MaintainableCollectionDefinition> getMaintainableCollections() { |
| 180 | 0 | return maintainableCollections; |
| 181 | |
} |
| 182 | |
|
| 183 | |
public List<? extends CollectionDefinitionI> getCollections() { |
| 184 | 0 | return maintainableCollections; |
| 185 | |
} |
| 186 | |
|
| 187 | |
|
| 188 | |
|
| 189 | |
|
| 190 | |
|
| 191 | |
|
| 192 | |
public List<? extends FieldDefinitionI> getSummaryFields() { |
| 193 | 0 | return summaryFields; |
| 194 | |
} |
| 195 | |
|
| 196 | |
public boolean hasSummaryField(String key) { |
| 197 | 0 | return summaryFieldMap.containsKey(key); |
| 198 | |
} |
| 199 | |
|
| 200 | |
public boolean isIncludeMultipleLookupLine() { |
| 201 | 0 | return includeMultipleLookupLine; |
| 202 | |
} |
| 203 | |
|
| 204 | |
|
| 205 | |
public void setIncludeMultipleLookupLine(boolean includeMultipleLookupLine) { |
| 206 | 0 | this.includeMultipleLookupLine = includeMultipleLookupLine; |
| 207 | 0 | } |
| 208 | |
|
| 209 | |
public String getSummaryTitle() { |
| 210 | 0 | return summaryTitle; |
| 211 | |
} |
| 212 | |
|
| 213 | |
|
| 214 | |
|
| 215 | |
|
| 216 | |
public void setSummaryTitle(String overrideSummaryName) { |
| 217 | 0 | this.summaryTitle = overrideSummaryName; |
| 218 | 0 | } |
| 219 | |
|
| 220 | |
|
| 221 | |
public String getAttributeToHighlightOnDuplicateKey() { |
| 222 | 0 | return attributeToHighlightOnDuplicateKey; |
| 223 | |
} |
| 224 | |
|
| 225 | |
|
| 226 | |
|
| 227 | |
|
| 228 | |
|
| 229 | |
|
| 230 | |
public void setAttributeToHighlightOnDuplicateKey(String attributeToHighlightOnDuplicate) { |
| 231 | 0 | this.attributeToHighlightOnDuplicateKey = attributeToHighlightOnDuplicate; |
| 232 | 0 | } |
| 233 | |
|
| 234 | |
public boolean dissallowDuplicateKey() { |
| 235 | 0 | return StringUtils.isNotBlank(getAttributeToHighlightOnDuplicateKey()); |
| 236 | |
} |
| 237 | |
|
| 238 | |
public List<MaintainableFieldDefinition> getDuplicateIdentificationFields() { |
| 239 | 0 | return duplicateIdentificationFields; |
| 240 | |
} |
| 241 | |
|
| 242 | |
|
| 243 | |
public void setMaintainableFields(List<MaintainableFieldDefinition> maintainableFields) { |
| 244 | 0 | maintainableFieldMap.clear(); |
| 245 | 0 | for ( MaintainableFieldDefinition maintainableField : maintainableFields ) { |
| 246 | 0 | if (maintainableField == null) { |
| 247 | 0 | throw new IllegalArgumentException("invalid (null) maintainableField"); |
| 248 | |
} |
| 249 | |
|
| 250 | 0 | String fieldName = maintainableField.getName(); |
| 251 | 0 | if (maintainableFieldMap.containsKey(fieldName)) { |
| 252 | 0 | throw new DuplicateEntryException("duplicate fieldName entry for field '" + fieldName + "'"); |
| 253 | |
} |
| 254 | |
|
| 255 | 0 | maintainableFieldMap.put(fieldName, maintainableField); |
| 256 | 0 | } |
| 257 | 0 | this.maintainableFields = maintainableFields; |
| 258 | 0 | } |
| 259 | |
|
| 260 | |
|
| 261 | |
public void setMaintainableCollections(List<MaintainableCollectionDefinition> maintainableCollections) { |
| 262 | 0 | maintainableCollectionMap.clear(); |
| 263 | 0 | for (MaintainableCollectionDefinition maintainableCollection : maintainableCollections ) { |
| 264 | 0 | if (maintainableCollection == null) { |
| 265 | 0 | throw new IllegalArgumentException("invalid (null) maintainableCollection"); |
| 266 | |
} |
| 267 | |
|
| 268 | 0 | String fieldName = maintainableCollection.getName(); |
| 269 | 0 | if (maintainableCollectionMap.containsKey(fieldName)) { |
| 270 | 0 | throw new DuplicateEntryException("duplicate fieldName entry for field '" + fieldName + "'"); |
| 271 | |
} |
| 272 | |
|
| 273 | 0 | maintainableCollectionMap.put(fieldName, maintainableCollection); |
| 274 | 0 | } |
| 275 | 0 | this.maintainableCollections = maintainableCollections; |
| 276 | 0 | } |
| 277 | |
|
| 278 | |
|
| 279 | |
|
| 280 | |
|
| 281 | |
|
| 282 | |
|
| 283 | |
public void setSummaryFields(List<MaintainableFieldDefinition> summaryFields) { |
| 284 | 0 | summaryFieldMap.clear(); |
| 285 | 0 | for (MaintainableFieldDefinition summaryField : summaryFields ) { |
| 286 | 0 | if (summaryField == null) { |
| 287 | 0 | throw new IllegalArgumentException("invalid (null) summaryField"); |
| 288 | |
} |
| 289 | |
|
| 290 | 0 | String fieldName = summaryField.getName(); |
| 291 | 0 | if (summaryFieldMap.containsKey(fieldName)) { |
| 292 | 0 | throw new DuplicateEntryException("duplicate fieldName entry for field '" + fieldName + "'"); |
| 293 | |
} |
| 294 | |
|
| 295 | 0 | summaryFieldMap.put(fieldName, summaryField); |
| 296 | 0 | } |
| 297 | 0 | this.summaryFields = summaryFields; |
| 298 | 0 | } |
| 299 | |
|
| 300 | |
|
| 301 | |
|
| 302 | |
|
| 303 | |
|
| 304 | |
|
| 305 | |
public void setDuplicateIdentificationFields(List<MaintainableFieldDefinition> duplicateIdentificationFields) { |
| 306 | 0 | duplicateIdentificationFieldMap.clear(); |
| 307 | 0 | for (MaintainableFieldDefinition identifierField : duplicateIdentificationFields) { |
| 308 | 0 | if (identifierField == null) { |
| 309 | 0 | throw new IllegalArgumentException("invalid (null) identifierField"); |
| 310 | |
} |
| 311 | |
|
| 312 | 0 | String fieldName = identifierField.getName(); |
| 313 | 0 | if (duplicateIdentificationFieldMap.containsKey(fieldName)) { |
| 314 | 0 | throw new DuplicateEntryException("duplicate fieldName entry for field '" + fieldName + "'"); |
| 315 | |
} |
| 316 | |
|
| 317 | 0 | duplicateIdentificationFieldMap.put(fieldName, identifierField); |
| 318 | 0 | } |
| 319 | 0 | this.duplicateIdentificationFields = duplicateIdentificationFields; |
| 320 | 0 | } |
| 321 | |
|
| 322 | |
|
| 323 | |
|
| 324 | |
public boolean isAlwaysAllowCollectionDeletion() { |
| 325 | 0 | return this.alwaysAllowCollectionDeletion; |
| 326 | |
} |
| 327 | |
|
| 328 | |
|
| 329 | |
|
| 330 | |
public void setAlwaysAllowCollectionDeletion( |
| 331 | |
boolean alwaysAllowCollectionDeletion) { |
| 332 | 0 | this.alwaysAllowCollectionDeletion = alwaysAllowCollectionDeletion; |
| 333 | 0 | } |
| 334 | |
|
| 335 | |
} |