com.edorasware.commons.core.persistence

Class PersistenceUtils

java.lang.Object

com.edorasware.commons.core.persistence.PersistenceUtils

public final class PersistenceUtils
extends Object

Provides utility methods related to persistence operations.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DDL_CREATE_OPERATION Name constant for "create" operation.
static String	DDL_DROP_OPERATION Name constant for "drop" operation.
static String	DDL_UPDATE_OPERATION Name constant for "update" operation.

Method Summary

Modifier and Type	Method and Description
static String	buildDdlResourcePath(String base, String namespace, String operation, String component, DatabaseType databaseType) Convenience method that builds a specific DDL resource path from the given elements that make up the path.
static String	buildDdlResourcePath(String base, String namespace, String operation, String component, String classifier, DatabaseType databaseType) Convenience method that builds a specific DDL resource path from the given elements that make up the path.
static com.google.common.collect.ImmutableList<URL>	buildDdlResourcePaths(String base, String namespace, String operation, String component, String classifier, DatabaseType databaseType) Convenience method that builds a list of specific DDL resource paths from the given elements that make up the paths.
static SqlMappingContext	createSqlMappingContext(List<org.springframework.core.io.Resource> resources, DatabaseType databaseType, EntityResolver entityResolver) Reads the specified XML resources into a SqlMappingContext.
static SqlMappingContext	createSqlMappingContext(String[] fileNames, DatabaseType databaseType, EntityResolver entityResolver) Reads the specified XML file resources into a SqlMappingContext.
static com.google.common.collect.ImmutableList<String>	extractParameterNames(String sql) Extracts the parameter names from the given sql statement.
static com.google.common.collect.ImmutableMap<String,Integer>	extractParameterSqlTypes(String sql) Extracts the sql type information for each named parameter from the given sql statement.
static com.google.common.collect.ImmutableList<URL>	findDdlResources(String base, String defaultBase, String namespace, String operation, String component, int initialFromVersion, int finalToVersion, DatabaseType databaseType) Convenience method that returns DDL resources in a given version range.
static <T extends ComponentEntity> com.google.common.collect.ImmutableMap<String,Set<T>>	mapByForeignKey(Collection<T> components) Separates the given component entities by their source reference.
static String	removeParameterSqlTypes(String sql) Removes the sql type information from the given sql statement.
static String	replaceParameterName(String sql, String parameterName, String newParameterName) Replaces the given parameter name with a new parameter name in the given sql statement.

Methods inherited from class java.lang.Object

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

Field Detail

DDL_CREATE_OPERATION

public static final String DDL_CREATE_OPERATION

Name constant for "create" operation.

See Also:

Constant Field Values

DDL_UPDATE_OPERATION

public static final String DDL_UPDATE_OPERATION

Name constant for "update" operation.

See Also:

Constant Field Values

DDL_DROP_OPERATION

public static final String DDL_DROP_OPERATION

Name constant for "drop" operation.

See Also:

Constant Field Values

Method Detail

createSqlMappingContext

public static SqlMappingContext createSqlMappingContext(String[] fileNames,
                                                        DatabaseType databaseType,
                                                        EntityResolver entityResolver)
                                                 throws Exception

Reads the specified XML file resources into a SqlMappingContext.

Parameters:

fileNames - the XML file resources to be read

databaseType - the type of database for which to read the mappings

entityResolver - the resolver used to locate XML entities

Returns:

the context encapsulating the loaded mappings

Throws:

Exception - thrown in case something goes wrong during the XML loading/parsing process

createSqlMappingContext

public static SqlMappingContext createSqlMappingContext(List<org.springframework.core.io.Resource> resources,
                                                        DatabaseType databaseType,
                                                        EntityResolver entityResolver)
                                                 throws Exception

Reads the specified XML resources into a SqlMappingContext.

Parameters:

resources - the XML resources to be read

databaseType - the type of database for which to read the mappings

entityResolver - the resolver used to locate XML entities

Returns:

the context encapsulating the loaded mappings

Throws:

Exception - thrown in case something goes wrong during the XML loading/parsing process

replaceParameterName

public static String replaceParameterName(String sql,
                                          String parameterName,
                                          String newParameterName)

Replaces the given parameter name with a new parameter name in the given sql statement.

A named parameter and its sql type are defined as :<name>{<TYPE>}, e.g. :id{VARCHAR}.

Parameters:

sql - the sql statement to process

parameterName - the parameter name to replace

newParameterName - the new parameter name

Returns:

the substituted sql statement

extractParameterNames

public static com.google.common.collect.ImmutableList<String> extractParameterNames(String sql)

Extracts the parameter names from the given sql statement.

A named parameter and its sql type are defined as :<name>{<TYPE>}, e.g. :id{VARCHAR}.

Parameters:

sql - the sql statement to process

Returns:

the name of each parameter

extractParameterSqlTypes

public static com.google.common.collect.ImmutableMap<String,Integer> extractParameterSqlTypes(String sql)

Extracts the sql type information for each named parameter from the given sql statement.

A named parameter and its sql type are defined as :<name>{<TYPE>}, e.g. :id{VARCHAR}.

Parameters:

sql - the sql statement to process

Returns:

the sql type for each named parameter

removeParameterSqlTypes

public static String removeParameterSqlTypes(String sql)

Removes the sql type information from the given sql statement.

A named parameter and its sql type are defined as :<name>{<TYPE>}, e.g. :id{VARCHAR}.

Parameters:

sql - the sql statement to process

Returns:

the sql statement without any sql type information

buildDdlResourcePath

public static String buildDdlResourcePath(String base,
                                          String namespace,
                                          String operation,
                                          String component,
                                          DatabaseType databaseType)

Convenience method that builds a specific DDL resource path from the given elements that make up the path. The path is built as following:

base/operation/namespace.databaseType.operation.component.sql

Parameters:

base - the base path

namespace - the namespace of the table

operation - the type of db operations to execute

component - the component affected

databaseType - the database type

Returns:

the DLL resource path

buildDdlResourcePath

public static String buildDdlResourcePath(String base,
                                          String namespace,
                                          String operation,
                                          String component,
                                          String classifier,
                                          DatabaseType databaseType)

Convenience method that builds a specific DDL resource path from the given elements that make up the path. The path is built as following:

base/operation/namespace.databaseType.operation.component[.classifier].sql

Parameters:

base - the base path

namespace - the namespace of the table

operation - the type of db operations to execute

component - the component affected

classifier - the optional classifier

databaseType - the database type

Returns:

the DLL resource path

buildDdlResourcePaths

public static com.google.common.collect.ImmutableList<URL> buildDdlResourcePaths(String base,
                                                                                 String namespace,
                                                                                 String operation,
                                                                                 String component,
                                                                                 String classifier,
                                                                                 DatabaseType databaseType)

Convenience method that builds a list of specific DDL resource paths from the given elements that make up the paths. The paths are built as following:

base/operation/namespace.databaseType.operation.component[.classifier].sql

This method is useful when the resources have the same path but are located under a different root.

Parameters:

base - the base path

namespace - the namespace of the table

operation - the type of db operations to execute

component - the component affected

classifier - the optional classifier

databaseType - the database type

Returns:

the DLL resource path

findDdlResources

public static com.google.common.collect.ImmutableList<URL> findDdlResources(String base,
                                                                            String defaultBase,
                                                                            String namespace,
                                                                            String operation,
                                                                            String component,
                                                                            int initialFromVersion,
                                                                            int finalToVersion,
                                                                            DatabaseType databaseType)

Convenience method that returns DDL resources in a given version range. The path is built as following:

base/operation/namespace.databaseType.operation.component.Sx.to.Sy.sql

Parameters:

base - the primary base path

defaultBase - the default base path

namespace - the namespace of the table

operation - the type of db operations to execute

component - the component affected

initialFromVersion - the start of the first range to find

finalToVersion - the end of the last range to find

databaseType - the database type

Returns:

the DDL resources in the given version range

mapByForeignKey

public static <T extends ComponentEntity> com.google.common.collect.ImmutableMap<String,Set<T>> mapByForeignKey(Collection<T> components)

Separates the given component entities by their source reference.

Type Parameters:

T - component entity

Parameters:

components - the component entities to separate

Returns:

the component entities separated by their source reference