org.kuali.ole.sys.batch.dataaccess.impl

Class FiscalYearMakersDaoOjb

java.lang.Object

org.springframework.dao.support.DaoSupport

org.springmodules.orm.ojb.support.PersistenceBrokerDaoSupport

org.kuali.rice.core.framework.persistence.ojb.dao.PlatformAwareDaoBaseOjb

org.kuali.ole.sys.batch.dataaccess.impl.FiscalYearMakersDaoOjb

All Implemented Interfaces:

FiscalYearMakersDao, org.kuali.rice.core.framework.persistence.dao.PlatformAwareDao, org.springframework.beans.factory.InitializingBean

public class FiscalYearMakersDaoOjb
extends org.kuali.rice.core.framework.persistence.ojb.dao.PlatformAwareDaoBaseOjb
implements FiscalYearMakersDao

See Also:

org.kuali.ole.coa.batch.dataaccess.FiscalYearMakersDao

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	KEY_STRING_DELIMITER

Fields inherited from class org.springframework.dao.support.DaoSupport

logger

Constructor Summary

Constructors

Constructor and Description
FiscalYearMakersDaoOjb()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addToKeysWritten(FiscalYearMaker fiscalYearMaker, List<String> keyFieldNames, FiscalYearBasedBusinessObject copiedObject, Set<String> keysWritten) Builds a string from the primary key values and adds to given set
Collection<String>	createNewYearRows(Integer baseYear, FiscalYearMaker fiscalYearMaker, boolean replaceMode, Map<Class<? extends FiscalYearBasedBusinessObject>,Set<String>> parentKeysWritten, boolean isParentClass) Populates records for the new year and object
void	deleteNewYearRows(Integer baseYear, FiscalYearMaker objectFiscalYearMaker) Clears out records for the new year and object being copied
protected String	getForeignKeyStringForReference(FiscalYearMaker fiscalYearMaker, FiscalYearBasedBusinessObject businessObject, String referenceName) Builds a String containing foreign key values for the given reference of the business object
protected String	getKeyString(FiscalYearMaker fiscalYearMaker, List<String> keyFieldNames, FiscalYearBasedBusinessObject businessObject)
protected void	removeNonPrimitiveFields(FiscalYearMaker fiscalYearMaker, FiscalYearBasedBusinessObject businessObject) Sets all reference and collection fields defined in the persistence layer to null on the given object
protected boolean	validateChildParentReferencesExist(FiscalYearMaker objectFiscalYearMaker, FiscalYearBasedBusinessObject childRecord, Class<? extends FiscalYearBasedBusinessObject> parentClass, Set<String> parentKeys, List<String> copyErrors) Validates the parent record(s) exists for the child record by retrieving the OJB reference (if found and foreign keys have value)
protected boolean	validateParentRecordsExist(FiscalYearMaker objectFiscalYearMaker, FiscalYearBasedBusinessObject childRecord, Map<Class<? extends FiscalYearBasedBusinessObject>,Set<String>> parentKeysWritten, List<String> copyErrors) Checks all parents for the object we are copying has a corresponding record for the child record
protected void	writeMissingParentCopyError(FiscalYearBasedBusinessObject childRecord, Class<? extends FiscalYearBasedBusinessObject> parentClass, String foreignKeyString, Collection<String> copyErrors) Builds an error message when a parent record was not found for the child

Methods inherited from class org.kuali.rice.core.framework.persistence.ojb.dao.PlatformAwareDaoBaseOjb

getDbPlatform, setDbPlatform

Methods inherited from class org.springmodules.orm.ojb.support.PersistenceBrokerDaoSupport

checkDaoConfig, convertOjbAccessException, createPersistenceBrokerTemplate, getJcdAlias, getPersistenceBroker, getPersistenceBrokerTemplate, releasePersistenceBroker, setJcdAlias, setPersistenceBrokerTemplate

Methods inherited from class org.springframework.dao.support.DaoSupport

afterPropertiesSet, initDao

Methods inherited from class java.lang.Object

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

Field Detail

KEY_STRING_DELIMITER

protected static final String KEY_STRING_DELIMITER

See Also:

Constant Field Values

Constructor Detail

FiscalYearMakersDaoOjb

public FiscalYearMakersDaoOjb()

Method Detail

deleteNewYearRows

public void deleteNewYearRows(Integer baseYear,
                     FiscalYearMaker objectFiscalYearMaker)

Description copied from interface: FiscalYearMakersDao

Clears out records for the new year and object being copied

Specified by:

deleteNewYearRows in interface FiscalYearMakersDao

Parameters:

baseYear - fiscal year that we are copying

objectFiscalYearMaker - FiscalYearMaker implementation for the object we are copying

See Also:

org.kuali.ole.coa.batch.dataaccess.FiscalYearMakersDao#deleteNewYearRows(java.lang.Integer, org.kuali.ole.coa.batch.dataaccess.FiscalYearMakerHelper)

createNewYearRows

public Collection<String> createNewYearRows(Integer baseYear,
                                   FiscalYearMaker fiscalYearMaker,
                                   boolean replaceMode,
                                   Map<Class<? extends FiscalYearBasedBusinessObject>,Set<String>> parentKeysWritten,
                                   boolean isParentClass)
                                     throws Exception

Description copied from interface: FiscalYearMakersDao

Populates records for the new year and object

Specified by:

createNewYearRows in interface FiscalYearMakersDao

Parameters:

baseYear - fiscal year that we are copying

fiscalYearMaker - FiscalYearMaker implementation for the object we are copying

replaceMode - indicates whether records found for the new year should be replaced or left alone

parentKeysWritten - Map that contains class as key and Set of of primary key strings representing records written

isParentClass - indicates whether the class being copied is a parent to another FYM class that will be copied

Returns:

Collection of error messages encountered while attempting to copy a record

Throws:

Exception

See Also:

org.kuali.ole.sys.batch.dataaccess.FiscalYearMakersDao#createNewYearRows(java.lang.Integer, org.kuali.ole.sys.batch.dataaccess.FiscalYearMaker, boolean, java.util.Map)

removeNonPrimitiveFields

protected void removeNonPrimitiveFields(FiscalYearMaker fiscalYearMaker,
                            FiscalYearBasedBusinessObject businessObject)

Sets all reference and collection fields defined in the persistence layer to null on the given object

Parameters:

businessObject - object to set properties for

validateParentRecordsExist

protected boolean validateParentRecordsExist(FiscalYearMaker objectFiscalYearMaker,
                                 FiscalYearBasedBusinessObject childRecord,
                                 Map<Class<? extends FiscalYearBasedBusinessObject>,Set<String>> parentKeysWritten,
                                 List<String> copyErrors)
                                      throws Exception

Checks all parents for the object we are copying has a corresponding record for the child record

Returns:

true if all parent records exist, false otherwise

Throws:

Exception

validateChildParentReferencesExist

protected boolean validateChildParentReferencesExist(FiscalYearMaker objectFiscalYearMaker,
                                         FiscalYearBasedBusinessObject childRecord,
                                         Class<? extends FiscalYearBasedBusinessObject> parentClass,
                                         Set<String> parentKeys,
                                         List<String> copyErrors)
                                              throws Exception

Validates the parent record(s) exists for the child record by retrieving the OJB reference (if found and foreign keys have value)

Parameters:

childRecord - child record we are inserting

parentClass - class for parent of child

parentKeys - Set of parent key Strings that have been written

copyErrors - Collection for adding error messages

Returns:

true if the parent record(s) exist, false otherwise

Throws:

Exception

getForeignKeyStringForReference

protected String getForeignKeyStringForReference(FiscalYearMaker fiscalYearMaker,
                                     FiscalYearBasedBusinessObject businessObject,
                                     String referenceName)
                                          throws Exception

Builds a String containing foreign key values for the given reference of the business object

Parameters:

businessObject - business object instance with reference

referenceName - name of reference

Returns:

String of foreign key values or null if any of the foreign key values are null

Throws:

Exception

writeMissingParentCopyError

protected void writeMissingParentCopyError(FiscalYearBasedBusinessObject childRecord,
                               Class<? extends FiscalYearBasedBusinessObject> parentClass,
                               String foreignKeyString,
                               Collection<String> copyErrors)

Builds an error message when a parent record was not found for the child

Parameters:

childRecord - child record we are inserting

parentClass - class for parent of child

foreignKeyString - string of foreign key values that was not found in parent

copyErrors - Collection for adding error messages

addToKeysWritten

protected void addToKeysWritten(FiscalYearMaker fiscalYearMaker,
                    List<String> keyFieldNames,
                    FiscalYearBasedBusinessObject copiedObject,
                    Set<String> keysWritten)
                         throws Exception

Builds a string from the primary key values and adds to given set

Parameters:

copiedObject - object to grab key values for

keysWritten - Set containing all pk strings

Throws:

Exception

getKeyString

protected String getKeyString(FiscalYearMaker fiscalYearMaker,
                  List<String> keyFieldNames,
                  FiscalYearBasedBusinessObject businessObject)
                       throws Exception

Throws:

Exception