org.kuali.kra.award.awardhierarchy.sync.helpers

Class AwardSyncHelperBase

java.lang.Object

org.kuali.kra.award.awardhierarchy.sync.helpers.AwardSyncHelperBase

All Implemented Interfaces:

AwardSyncHelper

Direct Known Subclasses:

AwardSyncAwardHelper, AwardSyncCommentsHelper, AwardSyncPersonHelper, AwardSyncReportHelper, AwardSyncReportRecipientHelper, AwardSyncSponsorContactHelper, AwardSyncTermHelper, AwardSyncUnitHelper

public abstract class AwardSyncHelperBase
extends Object
implements AwardSyncHelper

Base class for award hierarchy sync data access objects.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	DELIMITER Delimiter used between fields for the object data description
protected org.apache.commons.logging.Log	LOG

Constructor Summary

Constructors

Constructor and Description
AwardSyncHelperBase()

Method Summary

Methods

Modifier and Type	Method and Description
void	applySyncChange(Award award, AwardSyncChange change) Applies the associated change to award.
protected void	applySyncChange(org.kuali.rice.krad.bo.PersistableBusinessObject object, AwardSyncChange change, String attrName, AwardSyncXmlExport xmlExport) Applies the xmlExport keys and values to the object.
protected void	applySyncChange(org.kuali.rice.krad.bo.PersistableBusinessObject object, AwardSyncChange change, String attrName, Collection<AwardSyncXmlExport> xmlExports) Creates all items defined by xmlExports and adds them to the attribute.
protected List<AwardSyncXmlExport>	buildXmlExport(Collection syncables) Loops through a collection of business objects to return a list of AwardSyncXmlExport.
AwardSyncXmlExport	buildXmlExport(org.kuali.rice.krad.bo.PersistableBusinessObject syncable, String attrName) Builds the xmlExport maps for syncable and an optional attrName including parent references.
protected AwardSyncXmlExport	buildXmlExport(org.kuali.rice.krad.bo.PersistableBusinessObject syncable, String attrName, String childAttr, AwardSyncXmlExport childExport, boolean walkParents) Using annotations set on the class and reflection creates a map based hierarchy of objects from the award attribute down to the BO this is initially called on.
AwardSyncChange	createAwardSyncChange(AwardSyncType syncType, org.kuali.rice.krad.bo.PersistableBusinessObject syncableObject, String awardAttrName, String boAttrName) Create an award sync change for the syncableObject.
protected org.kuali.rice.krad.bo.PersistableBusinessObject	createNewItem(AwardSyncChange change, AwardSyncXmlExport xmlExport) Creates a new item based on the key values and values passed in.
protected Field	findField(Class clazz, String propertyName) Recursively ascends the class tree to find the property field.
AwardSyncUtilityService	getAwardSyncUtilityService()
protected abstract String	getDataDesc(org.kuali.rice.krad.bo.PersistableBusinessObject syncableObject, String attrName) Returns the data description for this object type.
protected abstract String	getObjectDesc(org.kuali.rice.krad.bo.PersistableBusinessObject syncableObject, String attrName) Returns the object description for this object type.
protected PropertyDescriptor	getPropertyDescriptor(org.kuali.rice.krad.bo.PersistableBusinessObject object, String attributeName) Finds the bean property descriptor for the names attribute.
protected Object	getPropertyValue(org.kuali.rice.krad.bo.PersistableBusinessObject object, String attributeName) Finds the property descriptor for the named attribute and returns the value retrieved using the read method
protected Object	getValueForExport(Object propertyValue) Returns a value for export based on the property type.
void	setAwardSyncUtilityService(AwardSyncUtilityService awardSyncUtilityService)
protected void	setValuesOnSyncable(org.kuali.rice.krad.bo.PersistableBusinessObject syncable, Map<String,Object> values, AwardSyncChange change) Recursively sets values on this syncable working way down in the object tree found in the values map.

Methods inherited from class java.lang.Object

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

Field Detail

LOG

protected final org.apache.commons.logging.Log LOG

DELIMITER

protected final String DELIMITER

Delimiter used between fields for the object data description

See Also:

Constant Field Values

Constructor Detail

AwardSyncHelperBase

public AwardSyncHelperBase()

Method Detail

createAwardSyncChange

public AwardSyncChange createAwardSyncChange(AwardSyncType syncType,
                                    org.kuali.rice.krad.bo.PersistableBusinessObject syncableObject,
                                    String awardAttrName,
                                    String boAttrName)
                                      throws NoSuchFieldException,
                                             IllegalAccessException,
                                             InvocationTargetException

Description copied from interface: AwardSyncHelper

Create an award sync change for the syncableObject.

Specified by:

createAwardSyncChange in interface AwardSyncHelper

awardAttrName - attribute on the award under which syncableObject can be found

boAttrName - attribute on the syncableObject that should be synced by this change

Returns:

Throws:

NoSuchFieldException

IllegalAccessException

InvocationTargetException

See Also:

org.kuali.kra.award.awardhierarchy.sync.helpers.AwardSyncHelper#createAwardSyncChange(org.kuali.kra.award.awardhierarchy.sync.AwardSyncType, org.kuali.rice.krad.bo.BusinessObject, java.lang.String, java.lang.String)

getObjectDesc

protected abstract String getObjectDesc(org.kuali.rice.krad.bo.PersistableBusinessObject syncableObject,
                   String attrName)

Returns the object description for this object type.

Parameters:

syncableObject -

attrName -

Returns:

getDataDesc

protected abstract String getDataDesc(org.kuali.rice.krad.bo.PersistableBusinessObject syncableObject,
                 String attrName)

Returns the data description for this object type.

Parameters:

syncableObject -

attrName -

Returns:

buildXmlExport

public AwardSyncXmlExport buildXmlExport(org.kuali.rice.krad.bo.PersistableBusinessObject syncable,
                                String attrName)
                                  throws NoSuchFieldException,
                                         IllegalAccessException,
                                         InvocationTargetException

Description copied from interface: AwardSyncHelper

Builds the xmlExport maps for syncable and an optional attrName including parent references.

Specified by:

buildXmlExport in interface AwardSyncHelper

Returns:

Throws:

NoSuchFieldException

IllegalAccessException

InvocationTargetException

See Also:

org.kuali.kra.award.awardhierarchy.sync.helpers.AwardSyncHelper#buildXmlExport(org.kuali.kra.award.awardhierarchy.sync.AwardHierarchySyncable, java.lang.String)

buildXmlExport

protected AwardSyncXmlExport buildXmlExport(org.kuali.rice.krad.bo.PersistableBusinessObject syncable,
                                String attrName,
                                String childAttr,
                                AwardSyncXmlExport childExport,
                                boolean walkParents)
                                     throws NoSuchFieldException,
                                            IllegalAccessException,
                                            InvocationTargetException

Using annotations set on the class and reflection creates a map based hierarchy of objects from the award attribute down to the BO this is initially called on.

Parameters:

syncable -

attrName -

childAttr -

childExport -

walkParents -

Returns:

Throws:

NoSuchFieldException

IllegalAccessException

InvocationTargetException

getValueForExport

protected Object getValueForExport(Object propertyValue)
                            throws NoSuchFieldException,
                                   IllegalAccessException,
                                   InvocationTargetException

Returns a value for export based on the property type. If it is a collection, the return will be a list of AwardSyncXmlExport. If the value is a simple business object it will return an AwardSyncXmlExport. Otherwise the return will be the value itself.

Parameters:

propertyValue -

Returns:

Throws:

NoSuchFieldException

IllegalAccessException

InvocationTargetException

buildXmlExport

protected List<AwardSyncXmlExport> buildXmlExport(Collection syncables)
                                           throws NoSuchFieldException,
                                                  IllegalAccessException,
                                                  InvocationTargetException

Loops through a collection of business objects to return a list of AwardSyncXmlExport.

Parameters:

syncables -

Returns:

Throws:

NoSuchFieldException

IllegalAccessException

InvocationTargetException

findField

protected Field findField(Class clazz,
              String propertyName)

Recursively ascends the class tree to find the property field. This is done because you cannot get the field for a private property unless called on the defining class itself.

Parameters:

clazz -

propertyName -

Returns:

applySyncChange

public void applySyncChange(Award award,
                   AwardSyncChange change)
                     throws NoSuchFieldException,
                            IllegalAccessException,
                            InvocationTargetException,
                            ClassNotFoundException,
                            NoSuchMethodException,
                            InstantiationException,
                            AwardSyncException

Description copied from interface: AwardSyncHelper

Applies the associated change to award.

Specified by:

applySyncChange in interface AwardSyncHelper

Throws:

NoSuchFieldException

IllegalAccessException

InvocationTargetException

ClassNotFoundException

NoSuchMethodException

InstantiationException

AwardSyncException

See Also:

org.kuali.kra.award.awardhierarchy.sync.helpers.AwardSyncHelper#applySyncChange(org.kuali.kra.award.home.Award, org.kuali.kra.award.awardhierarchy.sync.AwardSyncChange, boolean)

applySyncChange

protected void applySyncChange(org.kuali.rice.krad.bo.PersistableBusinessObject object,
                   AwardSyncChange change,
                   String attrName,
                   AwardSyncXmlExport xmlExport)
                        throws NoSuchFieldException,
                               IllegalAccessException,
                               InvocationTargetException,
                               ClassNotFoundException,
                               NoSuchMethodException,
                               InstantiationException

Applies the xmlExport keys and values to the object. This will recursively descend the tree of objects defined in the xmlExport by calling setValuesOnSyncable(org.kuali.rice.krad.bo.PersistableBusinessObject, java.util.Map<java.lang.String, java.lang.Object>, org.kuali.kra.award.awardhierarchy.sync.AwardSyncChange).

Parameters:

object -

change -

attrName -

xmlExport -

Throws:

NoSuchFieldException

IllegalAccessException

InvocationTargetException

ClassNotFoundException

NoSuchMethodException

InstantiationException

applySyncChange

protected void applySyncChange(org.kuali.rice.krad.bo.PersistableBusinessObject object,
                   AwardSyncChange change,
                   String attrName,
                   Collection<AwardSyncXmlExport> xmlExports)
                        throws ClassNotFoundException,
                               NoSuchMethodException,
                               InstantiationException,
                               IllegalAccessException,
                               InvocationTargetException,
                               NoSuchFieldException

Creates all items defined by xmlExports and adds them to the attribute.

Parameters:

object -

change -

attrName -

xmlExports -

Throws:

ClassNotFoundException

NoSuchMethodException

InstantiationException

IllegalAccessException

InvocationTargetException

NoSuchFieldException

createNewItem

protected org.kuali.rice.krad.bo.PersistableBusinessObject createNewItem(AwardSyncChange change,
                                                             AwardSyncXmlExport xmlExport)
                                                                  throws ClassNotFoundException,
                                                                         NoSuchMethodException,
                                                                         InstantiationException,
                                                                         IllegalAccessException,
                                                                         InvocationTargetException,
                                                                         NoSuchFieldException

Creates a new item based on the key values and values passed in.

Parameters:

change -

xmlExport -

Returns:

Throws:

ClassNotFoundException

NoSuchMethodException

InstantiationException

IllegalAccessException

InvocationTargetException

NoSuchFieldException

setValuesOnSyncable

protected void setValuesOnSyncable(org.kuali.rice.krad.bo.PersistableBusinessObject syncable,
                       Map<String,Object> values,
                       AwardSyncChange change)
                            throws NoSuchFieldException,
                                   IllegalAccessException,
                                   InvocationTargetException,
                                   ClassNotFoundException,
                                   NoSuchMethodException,
                                   InstantiationException

Recursively sets values on this syncable working way down in the object tree found in the values map.

Parameters:

syncable -

values -

change -

Throws:

NoSuchFieldException

IllegalAccessException

InvocationTargetException

ClassNotFoundException

NoSuchMethodException

InstantiationException

getPropertyDescriptor

protected PropertyDescriptor getPropertyDescriptor(org.kuali.rice.krad.bo.PersistableBusinessObject object,
                                       String attributeName)

Finds the bean property descriptor for the names attribute.

Parameters:

object -

attributeName -

Returns:

getPropertyValue

protected Object getPropertyValue(org.kuali.rice.krad.bo.PersistableBusinessObject object,
                      String attributeName)
                           throws IllegalAccessException,
                                  InvocationTargetException

Finds the property descriptor for the named attribute and returns the value retrieved using the read method

Parameters:

object -

attributeName -

Returns:

Throws:

IllegalAccessException

InvocationTargetException

getAwardSyncUtilityService

public AwardSyncUtilityService getAwardSyncUtilityService()

setAwardSyncUtilityService

public void setAwardSyncUtilityService(AwardSyncUtilityService awardSyncUtilityService)