net.java.ao
Class Common

java.lang.Object
  net.java.ao.Common

public final class Common
extends java.lang.Object

WARNING: Not part of the public API. This class is public only to allow its use within other packages in the ActiveObjects library.

Author:

Daniel Spiewak

Constructor Summary

Common()

Method Summary

static void	closeQuietly(java.sql.Connection connection) Closes the Connection in a null safe manner and quietly, i.e without throwing nor logging any exception
static void	closeQuietly(java.sql.ResultSet resultSet) Closes the ResultSet in a null safe manner and quietly, i.e without throwing nor logging any exception
static void	closeQuietly(java.sql.Statement statement) Closes the Statement in a null safe manner and quietly, i.e without throwing nor logging any exception
static java.lang.String	convert(FieldNameConverter fnc, java.lang.String column)
static java.lang.String	convertDowncaseName(java.lang.String name)
static java.lang.String	convertSimpleClassName(java.lang.String name)
static <T extends RawEntity<K>,K> T	createPeer(EntityManager manager, java.lang.Class<T> type, K key)
static java.lang.reflect.Method	findCounterpart(FieldNameConverter converter, java.lang.reflect.Method method) Finds the corresponding method in an accessor/mutator pair based on the given method (or null if no corresponding method).
static boolean	fuzzyCompare(java.lang.Object a, java.lang.Object b)
static boolean	fuzzyTypeCompare(int typeA, int typeB)
static AnnotationDelegate	getAnnotationDelegate(FieldNameConverter converter, java.lang.reflect.Method method) Note: this method leads to the creation and quick discard of large numbers of AnnotationDelegate objects.
static java.lang.Class<?>	getAttributeTypeFromMethod(java.lang.reflect.Method method)
static java.lang.String	getCallingClassName(int depth)
static java.lang.String[]	getMappingFields(FieldNameConverter converter, java.lang.Class<? extends RawEntity<?>> from, java.lang.Class<? extends RawEntity<?>> to)
static java.lang.String[]	getPolymorphicFieldNames(FieldNameConverter converter, java.lang.Class<? extends RawEntity<?>> from, java.lang.Class<? extends RawEntity<?>> to)
static java.lang.reflect.Method	getPrimaryKeyAccessor(java.lang.Class<? extends RawEntity<?>> type)
static <K> java.lang.Class<K>	getPrimaryKeyClassType(java.lang.Class<? extends RawEntity<K>> type)
static java.lang.String	getPrimaryKeyField(java.lang.Class<? extends RawEntity<?>> type, FieldNameConverter converter)
static java.lang.reflect.Method	getPrimaryKeyMethod(java.lang.Class<? extends RawEntity<?>> type)
static <K> DatabaseType<K>	getPrimaryKeyType(java.lang.Class<? extends RawEntity<K>> type)
static <K> K	getPrimaryKeyValue(RawEntity<K> entity)
static java.util.List<java.lang.String>	getSearchableFields(EntityManager manager, java.lang.Class<? extends RawEntity<?>> type)
static java.util.Set<java.lang.reflect.Method>	getValueFieldsMethods(java.lang.Class<? extends RawEntity<?>> entity, FieldNameConverter converter) Gets all the methods of an entity that correspond to a value field.
static java.util.Set<java.lang.String>	getValueFieldsNames(java.lang.Class<? extends RawEntity<?>> entity, FieldNameConverter converter)
static boolean	interfaceInheritsFrom(java.lang.Class<?> type, java.lang.Class<?> superType)
static boolean	isAccessor(java.lang.reflect.Method method)
static boolean	isAnnotatedAsRelational(java.lang.reflect.Method method)
static boolean	isAnnotatedMutator(java.lang.reflect.Method method)
static boolean	isMutator(java.lang.reflect.Method method)
static java.util.List<java.lang.String>	preloadValue(Preload preload, FieldNameConverter fnc)
static java.lang.String	shorten(java.lang.String s, int length) Shortens a String to the given length if necessary.
static boolean	typeInstanceOf(java.lang.Class<?> type, java.lang.Class<?> otherType)
static java.lang.String	where(ManyToMany manyToMany, FieldNameConverter fnc)
static java.lang.String	where(OneToMany oneToMany, FieldNameConverter fnc)
static java.lang.String	where(OneToOne oneToOne, FieldNameConverter fnc)

Methods inherited from class java.lang.Object

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

Constructor Detail

Common

public Common()

Method Detail

createPeer

public static <T extends RawEntity<K>,K> T createPeer(EntityManager manager,
                                                      java.lang.Class<T> type,
                                                      K key)
                                         throws java.sql.SQLException

Throws:

java.sql.SQLException

convertSimpleClassName

public static java.lang.String convertSimpleClassName(java.lang.String name)

convertDowncaseName

public static java.lang.String convertDowncaseName(java.lang.String name)

interfaceInheritsFrom

public static boolean interfaceInheritsFrom(java.lang.Class<?> type,
                                            java.lang.Class<?> superType)

typeInstanceOf

public static boolean typeInstanceOf(java.lang.Class<?> type,
                                     java.lang.Class<?> otherType)

getMappingFields

public static java.lang.String[] getMappingFields(FieldNameConverter converter,
                                                  java.lang.Class<? extends RawEntity<?>> from,
                                                  java.lang.Class<? extends RawEntity<?>> to)

getPolymorphicFieldNames

public static java.lang.String[] getPolymorphicFieldNames(FieldNameConverter converter,
                                                          java.lang.Class<? extends RawEntity<?>> from,
                                                          java.lang.Class<? extends RawEntity<?>> to)

getAnnotationDelegate

public static AnnotationDelegate getAnnotationDelegate(FieldNameConverter converter,
                                                       java.lang.reflect.Method method)

Note: this method leads to the creation and quick discard of large numbers of AnnotationDelegate objects. Need to do some research to determine whether or not this is actually a problem.

findCounterpart

public static java.lang.reflect.Method findCounterpart(FieldNameConverter converter,
                                                       java.lang.reflect.Method method)

Finds the corresponding method in an accessor/mutator pair based on the given method (or null if no corresponding method).

Parameters:

converter - TODO

isMutator

public static boolean isMutator(java.lang.reflect.Method method)

isAnnotatedMutator

public static boolean isAnnotatedMutator(java.lang.reflect.Method method)

isAccessor

public static boolean isAccessor(java.lang.reflect.Method method)

isAnnotatedAsRelational

public static boolean isAnnotatedAsRelational(java.lang.reflect.Method method)

getAttributeTypeFromMethod

public static java.lang.Class<?> getAttributeTypeFromMethod(java.lang.reflect.Method method)

getCallingClassName

public static java.lang.String getCallingClassName(int depth)

getSearchableFields

public static java.util.List<java.lang.String> getSearchableFields(EntityManager manager,
                                                                   java.lang.Class<? extends RawEntity<?>> type)

getPrimaryKeyAccessor

public static java.lang.reflect.Method getPrimaryKeyAccessor(java.lang.Class<? extends RawEntity<?>> type)

getPrimaryKeyField

public static java.lang.String getPrimaryKeyField(java.lang.Class<? extends RawEntity<?>> type,
                                                  FieldNameConverter converter)

getPrimaryKeyMethod

public static java.lang.reflect.Method getPrimaryKeyMethod(java.lang.Class<? extends RawEntity<?>> type)

getPrimaryKeyType

public static <K> DatabaseType<K> getPrimaryKeyType(java.lang.Class<? extends RawEntity<K>> type)

getPrimaryKeyClassType

public static <K> java.lang.Class<K> getPrimaryKeyClassType(java.lang.Class<? extends RawEntity<K>> type)

getPrimaryKeyValue

public static <K> K getPrimaryKeyValue(RawEntity<K> entity)

fuzzyCompare

public static boolean fuzzyCompare(java.lang.Object a,
                                   java.lang.Object b)

fuzzyTypeCompare

public static boolean fuzzyTypeCompare(int typeA,
                                       int typeB)

getValueFieldsMethods

public static java.util.Set<java.lang.reflect.Method> getValueFieldsMethods(java.lang.Class<? extends RawEntity<?>> entity,
                                                                            FieldNameConverter converter)

Gets all the methods of an entity that correspond to a value field. This means fields that are stored as values in the database as opposed to fields (IDs) that define a relationship to another table in the database.

Parameters:

entity - the entity to look up the methods from

converter - the field name converter currently in use for entities

Returns:

the set of method found

getValueFieldsNames

public static java.util.Set<java.lang.String> getValueFieldsNames(java.lang.Class<? extends RawEntity<?>> entity,
                                                                  FieldNameConverter converter)

preloadValue

public static java.util.List<java.lang.String> preloadValue(Preload preload,
                                                            FieldNameConverter fnc)

where

public static java.lang.String where(OneToOne oneToOne,
                                     FieldNameConverter fnc)

where

public static java.lang.String where(OneToMany oneToMany,
                                     FieldNameConverter fnc)

where

public static java.lang.String where(ManyToMany manyToMany,
                                     FieldNameConverter fnc)

convert

public static java.lang.String convert(FieldNameConverter fnc,
                                       java.lang.String column)

closeQuietly

public static void closeQuietly(java.sql.ResultSet resultSet)

Closes the ResultSet in a null safe manner and quietly, i.e without throwing nor logging any exception

Parameters:

resultSet - the result set to close

closeQuietly

public static void closeQuietly(java.sql.Statement statement)

Closes the Statement in a null safe manner and quietly, i.e without throwing nor logging any exception

Parameters:

statement - the statement to close

closeQuietly

public static void closeQuietly(java.sql.Connection connection)

Closes the Connection in a null safe manner and quietly, i.e without throwing nor logging any exception

Parameters:

connection - the connection to close, can be null

shorten

public static java.lang.String shorten(java.lang.String s,
                                       int length)

Shortens a String to the given length if necessary. The process of shortening is stable.