org.apereo.services.persondir.support.jdbc

Class MultiRowJdbcPersonAttributeDao

java.lang.Object

org.apereo.services.persondir.support.BasePersonAttributeDao

org.apereo.services.persondir.support.AbstractFlatteningPersonAttributeDao

org.apereo.services.persondir.support.AbstractDefaultAttributePersonAttributeDao

org.apereo.services.persondir.support.AbstractQueryPersonAttributeDao<org.apereo.services.persondir.support.jdbc.PartialWhereClause>

org.apereo.services.persondir.support.jdbc.AbstractJdbcPersonAttributeDao<java.util.Map<java.lang.String,java.lang.Object>>

org.apereo.services.persondir.support.jdbc.MultiRowJdbcPersonAttributeDao

All Implemented Interfaces:

java.lang.Comparable<IPersonAttributeDao>, IPersonAttributeDao

public class MultiRowJdbcPersonAttributeDao
extends AbstractJdbcPersonAttributeDao<java.util.Map<java.lang.String,java.lang.Object>>

An IPersonAttributeDao implementation that maps attribute names and values from name and value column pairs. This is usefull if user attributes are stored in a table like:

USER_NM	ATTR_NM	ATTR_VL
jstudent	name.given	joe
jstudent	name.family	student
badvisor	name.given	bob
badvisor	name.family	advisor

This class expects 1 to N row results for a query, with each row containing 1 to N name value attribute mappings and the userName of the user the attributes are for. This contrasts SingleRowJdbcPersonAttributeDao which expects a single row result for a user query.


Configuration:

Property	Description	Required	Default
nameValueColumnMappings	A Map of attribute name columns to attribute value columns. A single result row can have multiple name columns and multiple value columns associated with each name. The values of the Map can be either String or Collection of String.	Yes	null

Since:

uPortal 2.5

Author:

andrew.petro@yale.edu, Eric Dalquist edalquist@unicon.net

Field Summary

Fields inherited from class org.apereo.services.persondir.support.AbstractQueryPersonAttributeDao

DEFAULT_CASE_CANONICALIZATION_MODE, DEFAULT_USERNAME_CASE_CANONICALIZATION_MODE

Fields inherited from class org.apereo.services.persondir.support.BasePersonAttributeDao

logger

Fields inherited from interface org.apereo.services.persondir.IPersonAttributeDao

WILDCARD, WILDCARD_PATTERN

Constructor Summary

Constructors

Constructor and Description
MultiRowJdbcPersonAttributeDao()
MultiRowJdbcPersonAttributeDao(javax.sql.DataSource ds, java.lang.String sql) Creates a new MultiRowJdbcPersonAttributeDao specifying the DataSource and SQL to use.

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.util.Set<java.lang.String>>	getNameValueColumnMappings()
protected org.springframework.jdbc.core.RowMapper<java.util.Map<java.lang.String,java.lang.Object>>	getRowMapper()
protected java.util.List<IPersonAttributes>	parseAttributeMapFromResults(java.util.List<java.util.Map<java.lang.String,java.lang.Object>> queryResults, java.lang.String queryUserName) Takes the List from the query and parses it into the List of IPersonAttributes attributes to be returned.
void	setNameValueColumnMappings(java.util.Map<java.lang.String,?> nameValueColumnMap) The Map of columns from a name column to value columns.

Methods inherited from class org.apereo.services.persondir.support.jdbc.AbstractJdbcPersonAttributeDao

appendAttributeToQuery, canonicalizeDataAttributeForSql, getCaseInsensitiveDataAttributes, getDataAttributeCaseCanonicalizationFunctions, getPeopleForQuery, getQueryTemplate, getQueryType, setCaseInsensitiveDataAttributes, setCaseInsensitiveDataAttributesAsCollection, setDataAttributeCaseCanonicalizationFunctions, setQueryType

Methods inherited from class org.apereo.services.persondir.support.AbstractQueryPersonAttributeDao

appendCanonicalizedAttributeToQuery, canonicalizeAttribute, generateQuery, getAvailableQueryAttributes, getCaseCanonicalizationLocale, getCaseInsensitiveQueryAttributes, getCaseInsensitiveResultAttributes, getConfiguredUserNameAttribute, getDefaultCaseCanonicalizationMode, getPeopleWithMultivaluedAttributes, getPossibleUserAttributeNames, getQueryAttributeMapping, getResultAttributeMapping, getUnmappedUsernameAttribute, getUsernameCaseCanonicalizationMode, isRequireAllQueryAttributes, isUseAllQueryAttributes, isUserNameAttributeConfigured, mapPersonAttributes, setCaseCanonicalizationLocale, setCaseInsensitiveQueryAttributes, setCaseInsensitiveQueryAttributesAsCollection, setCaseInsensitiveResultAttributes, setCaseInsensitiveResultAttributesAsCollection, setDefaultCaseCanonicalizationMode, setQueryAttributeMapping, setRequireAllQueryAttributes, setResultAttributeMapping, setUnmappedUsernameAttribute, setUseAllQueryAttributes, setUsernameCaseCanonicalizationMode

Methods inherited from class org.apereo.services.persondir.support.AbstractDefaultAttributePersonAttributeDao

getPerson, getUsernameAttributeProvider, setUsernameAttributeProvider, toSeedMap

Methods inherited from class org.apereo.services.persondir.support.AbstractFlatteningPersonAttributeDao

getPeople, toMultivaluedSeed

Methods inherited from class org.apereo.services.persondir.support.BasePersonAttributeDao

compareTo, flattenResults, getMultivaluedUserAttributes, getMultivaluedUserAttributes, getOrder, getUserAttributes, getUserAttributes, setOrder

Methods inherited from class java.lang.Object

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

Constructor Detail

MultiRowJdbcPersonAttributeDao

public MultiRowJdbcPersonAttributeDao()

MultiRowJdbcPersonAttributeDao

public MultiRowJdbcPersonAttributeDao(javax.sql.DataSource ds,
                                      java.lang.String sql)

Creates a new MultiRowJdbcPersonAttributeDao specifying the DataSource and SQL to use.

Parameters:

ds - The DataSource to get connections from for executing queries, may not be null.

sql - The SQL to execute for user attributes, may not be null.

Method Detail

getNameValueColumnMappings

public java.util.Map<java.lang.String,java.util.Set<java.lang.String>> getNameValueColumnMappings()

Returns:

The Map of name column to value column(s).

setNameValueColumnMappings

public void setNameValueColumnMappings(java.util.Map<java.lang.String,?> nameValueColumnMap)

The Map of columns from a name column to value columns. Keys are Strings, Values are Strings or List of Strings.

Parameters:

nameValueColumnMap - The Map of name column to value column(s).

getRowMapper

protected org.springframework.jdbc.core.RowMapper<java.util.Map<java.lang.String,java.lang.Object>> getRowMapper()

Specified by:

getRowMapper in class AbstractJdbcPersonAttributeDao<java.util.Map<java.lang.String,java.lang.Object>>

Returns:

The ParameterizedRowMapper to handle the results of the SQL query.

parseAttributeMapFromResults

protected java.util.List<IPersonAttributes> parseAttributeMapFromResults(java.util.List<java.util.Map<java.lang.String,java.lang.Object>> queryResults,
                                                                         java.lang.String queryUserName)

Description copied from class: AbstractJdbcPersonAttributeDao

Takes the List from the query and parses it into the List of IPersonAttributes attributes to be returned.

Specified by:

parseAttributeMapFromResults in class AbstractJdbcPersonAttributeDao<java.util.Map<java.lang.String,java.lang.Object>>

Parameters:

queryResults - Results from the query.

queryUserName - The username passed in the query map, if no username attribute existed in the query Map null is provided.

Returns:

The results of the query