org.assistments.service.dao.base.impl.jdbc

Class JdbcBaseDao<T>

java.lang.Object

org.assistments.service.dao.base.impl.jdbc.JdbcBaseDao<T>

Type Parameters:

T - Domain object Type

All Implemented Interfaces:

CommonDao<T>

Direct Known Subclasses:

JdbcAccessTokenDao, JdbcActionEndDao, JdbcActionHintDao, JdbcActionLevelTypeDao, JdbcActionResponseDao, JdbcActionStartDao, JdbcActionSubmitDao, JdbcActionSurveyResponseDao, JdbcActionTypeDao, JdbcActionUrlDao, JdbcAnswerDao, JdbcAnswerEvalTypeDao, JdbcAssignmentActionDao, JdbcAssignmentContentPropertyDao, JdbcAssignmentDao, JdbcAssignmentLogDao, JdbcAssignmentObjectPropertyDao, JdbcAssistmentDao, JdbcAssistmentInfoDao, JdbcAssistmentOwnershipDao, JdbcAssistmentTypeDao, JdbcContentPropertyDefinitionDao, JdbcContentPropertyToPSNavigationDao, JdbcContentPropertyValidValueDao, JdbcContentPropertyValueDao, JdbcDataTypeDao, JdbcDependentPartnerDao, JdbcErrorLogDao, JdbcExternalReferenceDao, JdbcExternalReferenceTypeDao, JdbcFirstActionTypeDao, JdbcGroupDao, JdbcGroupMembershipDao, JdbcHintDao, JdbcLegacyApiPartnerLegacyDao, JdbcLegacyAssignmentLogDao, JdbcLegacyAssistmentToSequenceAssociationDao, JdbcLegacyClassAssignmentDao, JdbcLegacyCurriculumItemDao, JdbcLegacyEnrollmentDao, JdbcLegacyExternalReferenceDao, JdbcLegacyFolderDao, JdbcLegacyFolderItemDao, JdbcLegacyFolderOwnershipDao, JdbcLegacyPartnerExternalReferencesDao, JdbcLegacyPrerequisiteSkillDao, JdbcLegacyProblemLogDao, JdbcLegacySkillDao, JdbcLegacyStudentClassDao, JdbcLegacyTeacherClassDao, JdbcLegacyUserDao, JdbcLegacyUserRoleDao, JdbcLMSAccessTokenDao, JdbcLMSMappingDao, JdbcLMSObjectTypeDao, JdbcLMSProtocolTypeDao, JdbcLMSProviderDao, JdbcLoggedRequestDao, JdbcLoginAliasDao, JdbcLoginProviderDao, JdbcNavigationTypeDao, JdbcNavigatorDao, JdbcNetworkStateTypeDao, JdbcObjectPropertyDefinitionDao, JdbcObjectPropertyHierarchyDao, JdbcObjectPropertyHierarchyTypeDao, JdbcObjectPropertyTargetTypeDao, JdbcObjectPropertyValueDao, JdbcPartnerBridgeDao, JdbcPartnerDao, JdbcPartnerTypeDao, JdbcPlacementsMultiProblemSkillSequenceDao, JdbcPrerequisiteSkillDao, JdbcPrincipalTypeDao, JdbcProblemActionDao, JdbcProblemDao, JdbcProblemLogDao, JdbcProblemToSkillAssociationDao, JdbcPropertyCategoryDao, JdbcPropertyExposureDao, JdbcPropertyTypeDao, JdbcQualityLevelDao, JdbcResponseDao, JdbcResponseValuePartDao, JdbcScaffoldDao, JdbcSectionDao, JdbcSectionLinkDao, JdbcSequenceDao, JdbcSequenceInfoDao, JdbcSequenceQwnershipDao, JdbcSetActionDao, JdbcSkillDao, JdbcSkillSequenceDao, JdbcTerminatorDao, JdbcTutoringTypeDao, JdbcTutorStrategyDao, JdbcUserDao, JdbcUserGeneratedHintDao, JdbcUserRoleDao, JdbcUserRoleTypeDao, JdbcUserTypeDao, JdbcVariableDao

public abstract class JdbcBaseDao<T>
extends java.lang.Object
implements CommonDao<T>

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<java.lang.String>	COLUMN_NAMES
(package private) DataSourceRegistry	dsr
protected org.springframework.jdbc.core.JdbcTemplate	jdbcTemplate
protected java.lang.String	myPkName
protected SchemaTable	myTable
protected org.springframework.jdbc.core.namedparam.NamedParameterJdbcTemplate	namedTemplate
protected java.lang.String[]	RETURN_PK_NAME
protected java.lang.String	TABLE_NAME

Fields inherited from interface org.assistments.service.dao.base.CommonDao

FieldTypes

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JdbcBaseDao(SchemaTable table)

Method Summary

Modifier and Type	Method and Description
static java.util.List<NVPair>	convertToList(NVPair... values)
static java.util.List<QueryTerm>	convertToList(QueryTerm... values)
int	delete(java.util.List<QueryTerm> terms)
int	delete(QueryInstance qi)
int	delete(QueryTerm term)
int	deleteById(int dbid)
boolean	exists(java.util.List<QueryTerm> terms)
boolean	exists(QueryTerm term) Determines whether one or more rows exist matching all of the specified fields with exact values.
java.util.List<java.lang.Integer>	findAllIds(java.util.List<QueryTerm> terms) Returns the list of row IDs matching all of the specified fields with exact values.
java.util.List<java.lang.Integer>	findAllIds(QueryInstance qi)
java.util.List<java.lang.Integer>	findAllIds(QueryTerm term)
java.util.List<T>	findAllObjects() Returns the list of domain objects from all rows in the table.
java.util.List<T>	findAllObjects(java.util.List<QueryTerm> terms) Returns the list of domain objects matching all of the specified fields with exact values.
java.util.List<T>	findAllObjects(QueryInstance qi)
java.util.List<T>	findAllObjects(QueryTerm term)
T	findById(int dbId) Returns the domain object for the specified internal database ID.
int	findId(java.util.List<QueryTerm> terms)
int	findId(QueryTerm term) Returns the first IDs matching all of the specified fields with exact values.
java.util.List<T>	findMultipleObjects(java.util.List<QueryTerm> terms, int limit)
java.util.List<T>	findMultipleObjects(java.util.List<QueryTerm> terms, int start, int limit)
T	findObject(java.util.List<QueryTerm> terms) Returns the object matching all of the specified fields with exact values.
T	findObject(QueryInstance qi) Returns the object matching the specified query.
T	findObject(QueryTerm value) Returns the object matching the specified query term.
int	getCount(java.util.List<QueryTerm> terms)
int	getCount(QueryInstance qi)
int	getCount(QueryTerm term) Returns the number of rows matching all of the specified fields with exact values.
protected abstract NVPairList	getNVPairs(T obj)
protected abstract org.springframework.jdbc.core.RowMapper<T>	getRowMapper()
protected void	initOnce(javax.sql.DataSource dataSource, java.lang.String tableName, java.util.List<java.lang.String> expectedColNames)
int	persist(T obj) Inserts a row in the current table.
void	update(int dbId, java.util.List<NVPair> values) Updates a row in the current table
void	update(int dbId, NVPair value)
void	update(int dbId, T obj) Updates a row in the current table.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.assistments.service.dao.base.CommonDao

getFieldDefns

Field Detail

myTable

protected SchemaTable myTable

myPkName

protected java.lang.String myPkName

TABLE_NAME

protected java.lang.String TABLE_NAME

COLUMN_NAMES

protected java.util.List<java.lang.String> COLUMN_NAMES

RETURN_PK_NAME

protected java.lang.String[] RETURN_PK_NAME

namedTemplate

protected org.springframework.jdbc.core.namedparam.NamedParameterJdbcTemplate namedTemplate

jdbcTemplate

protected org.springframework.jdbc.core.JdbcTemplate jdbcTemplate

dsr

@Autowired
DataSourceRegistry dsr

Constructor Detail

JdbcBaseDao

protected JdbcBaseDao(SchemaTable table)

Method Detail

getNVPairs

protected abstract NVPairList getNVPairs(T obj)

getRowMapper

protected abstract org.springframework.jdbc.core.RowMapper<T> getRowMapper()

persist

public int persist(T obj)

Description copied from interface: CommonDao

Inserts a row in the current table. Assumes the table has a primary key defines.

Specified by:

persist in interface CommonDao<T>

Parameters:

obj - The object forming the basis of the new row.

Returns:

For tables with a primary key, returns the internal database ID of the newly created row; otherwise 0.

update

public void update(int dbId,
                   T obj)
            throws NotFoundException

Description copied from interface: CommonDao

Updates a row in the current table.

Specified by:

update in interface CommonDao<T>

Parameters:

dbId - The internal database ID for the row to modify. A caller should be able to obtain this value by getting it directly from the obj.

obj - Source object for updating the table row's fields.

Throws:

NotFoundException - If no such row exists

update

public void update(int dbId,
                   NVPair value)
            throws NotFoundException

Specified by:

update in interface CommonDao<T>

Throws:

NotFoundException

update

public void update(int dbId,
                   java.util.List<NVPair> values)
            throws NotFoundException

Description copied from interface: CommonDao

Updates a row in the current table

Specified by:

update in interface CommonDao<T>

Parameters:

dbId - The internal database ID for the row to modify.

values - A list of Pairs containing the field names (from the enum element defined in the concrete class) and values to change.

Throws:

NotFoundException - If no such row exists

findById

public T findById(int dbId)
           throws NotFoundException

Description copied from interface: CommonDao

Returns the domain object for the specified internal database ID.

Specified by:

findById in interface CommonDao<T>

Parameters:

dbId - Internal database ID for the row to return.

Returns:

A pojo containing the row's data.

Throws:

NotFoundException - If no such row exists

convertToList

@SafeVarargs
public static final java.util.List<NVPair> convertToList(NVPair... values)

convertToList

@SafeVarargs
public static final java.util.List<QueryTerm> convertToList(QueryTerm... values)

findId

public int findId(QueryTerm term)
           throws NotFoundException

Description copied from interface: CommonDao

Returns the first IDs matching all of the specified fields with exact values. That is to say the resulting query is of the form:

field1 = value1 AND field2 = value2 AND ...

Specified by:

findId in interface CommonDao<T>

Returns:

The first internal database IDs matching the values.

Throws:

NotFoundException - If no such row exists

findId

public int findId(java.util.List<QueryTerm> terms)
           throws NotFoundException

Specified by:

findId in interface CommonDao<T>

Throws:

NotFoundException

findAllIds

public java.util.List<java.lang.Integer> findAllIds(java.util.List<QueryTerm> terms)

Description copied from interface: CommonDao

Returns the list of row IDs matching all of the specified fields with exact values. That is to say the resulting query is of the form:
field1 = value1 AND field2 = value2 AND ...

Specified by:

findAllIds in interface CommonDao<T>

Parameters:

terms - A list of Pairs containing field names (as the enum element defined in the concrete class) and values to search on.

Returns:

A list of internal database IDs matching the values.

findAllIds

public java.util.List<java.lang.Integer> findAllIds(QueryTerm term)

Specified by:

findAllIds in interface CommonDao<T>

findAllIds

public java.util.List<java.lang.Integer> findAllIds(QueryInstance qi)

Specified by:

findAllIds in interface CommonDao<T>

findAllObjects

public final java.util.List<T> findAllObjects()
                                       throws NotFoundException

Description copied from interface: CommonDao

Returns the list of domain objects from all rows in the table.

Note: Use with caution. findAllObjects() is intentende for use on tables containing a modest number of rows.

Specified by:

findAllObjects in interface CommonDao<T>

Returns:

The list of domain object instances.

Throws:

NotFoundException - If no rows exist

findObject

public T findObject(QueryTerm value)
             throws NotFoundException

Description copied from interface: CommonDao

Returns the object matching the specified query term.

Specified by:

findObject in interface CommonDao<T>

Parameters:

value - A single term

Returns:

The result matching the terms.

Throws:

NotFoundException - If no such row exists

findObject

public T findObject(java.util.List<QueryTerm> terms)
             throws NotFoundException

Description copied from interface: CommonDao

Returns the object matching all of the specified fields with exact values. That is to say the resulting query is of the form:
field1 = value1 AND field2 = value2 AND ...

Specified by:

findObject in interface CommonDao<T>

Parameters:

terms - A list of Pairs containing field names (as the enum element defined in the concrete class) and values to search on.

Returns:

The result matching the terms.

Throws:

NotFoundException - If no such row exists

findAllObjects

public java.util.List<T> findAllObjects(QueryTerm term)
                                 throws NotFoundException

Specified by:

findAllObjects in interface CommonDao<T>

Throws:

NotFoundException

findAllObjects

public java.util.List<T> findAllObjects(java.util.List<QueryTerm> terms)
                                 throws NotFoundException

Description copied from interface: CommonDao

Returns the list of domain objects matching all of the specified fields with exact values. That is to say the resulting query is of the form:
field1 = value1 AND field2 = value2 AND ...

Specified by:

findAllObjects in interface CommonDao<T>

Parameters:

terms - A list of Pairs containing field names (as the enum element defined in the concrete class) and values to search on.

Returns:

A list of domain object instances matching the values.

Throws:

NotFoundException - If no rows exist

findMultipleObjects

public java.util.List<T> findMultipleObjects(java.util.List<QueryTerm> terms,
                                             int limit)
                                      throws NotFoundException

Specified by:

findMultipleObjects in interface CommonDao<T>

Throws:

NotFoundException

findMultipleObjects

public java.util.List<T> findMultipleObjects(java.util.List<QueryTerm> terms,
                                             int start,
                                             int limit)

Specified by:

findMultipleObjects in interface CommonDao<T>

findAllObjects

public java.util.List<T> findAllObjects(QueryInstance qi)
                                 throws NotFoundException

Specified by:

findAllObjects in interface CommonDao<T>

Throws:

NotFoundException

findObject

public T findObject(QueryInstance qi)
             throws NotFoundException

Description copied from interface: CommonDao

Returns the object matching the specified query.

Specified by:

findObject in interface CommonDao<T>

Parameters:

qi - A QueryInstance derived from a QueryBuilder

Returns:

The result matching the query.

Throws:

NotFoundException - If no such row exists

exists

public boolean exists(QueryTerm term)

Description copied from interface: CommonDao

Determines whether one or more rows exist matching all of the specified fields with exact values. That is to say the resulting query is of the form:
field1 = value1 AND field2 = value2 AND ...

Specified by:

exists in interface CommonDao<T>

Returns:

true if at least one row matches the values; otherwise false.

exists

public boolean exists(java.util.List<QueryTerm> terms)

Specified by:

exists in interface CommonDao<T>

getCount

public int getCount(QueryTerm term)

Description copied from interface: CommonDao

Returns the number of rows matching all of the specified fields with exact values. That is to say the resulting query is of the form:
field1 = value1 AND field2 = value2 AND ...

Specified by:

getCount in interface CommonDao<T>

Returns:

The number of rows matching the values.

getCount

public int getCount(java.util.List<QueryTerm> terms)

Specified by:

getCount in interface CommonDao<T>

getCount

public int getCount(QueryInstance qi)

Specified by:

getCount in interface CommonDao<T>

initOnce

protected void initOnce(javax.sql.DataSource dataSource,
                        java.lang.String tableName,
                        java.util.List<java.lang.String> expectedColNames)

deleteById

public int deleteById(int dbid)

Specified by:

deleteById in interface CommonDao<T>

delete

public int delete(QueryTerm term)

Specified by:

delete in interface CommonDao<T>

delete

public int delete(java.util.List<QueryTerm> terms)

Specified by:

delete in interface CommonDao<T>

delete

public int delete(QueryInstance qi)

Specified by:

delete in interface CommonDao<T>