|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.scooterframework.orm.activerecord.ActiveRecordUtil
public class ActiveRecordUtil
ActiveRecordUtil class has helper methods.
Field Summary | |
---|---|
static java.lang.String |
DEFAULT_RECORD_CLASS
|
Constructor Summary | |
---|---|
ActiveRecordUtil()
|
Method Summary | |
---|---|
static ActiveRecord |
generateActiveRecordInstance(java.lang.String className,
java.lang.String model)
Generates an instance of ActiveRecord. |
static ActiveRecord |
generateActiveRecordInstance(java.lang.String className,
java.lang.String connName,
java.lang.String model)
Generates an instance of ActiveRecord. |
static ActiveRecord |
generateActiveRecordInstance(java.lang.String className,
java.lang.String connName,
java.lang.String model,
java.lang.String table)
Generates an instance of ActiveRecord. |
static Calculator |
getCalculator(java.lang.Class<? extends ActiveRecord> modelClass)
Returns a Calculator instance for the model class. |
static Calculator |
getCalculator(java.lang.String fullModelClassName)
Returns a Calculator instance for the model class. |
static java.lang.String |
getFullClassName(java.lang.Class<? extends ActiveRecord> c)
Returns the full class name |
static TableGateway |
getGateway(ActiveRecord home)
|
static TableGateway |
getGateway(java.lang.Class<? extends ActiveRecord> modelClass)
|
static TableGateway |
getGateway(java.lang.String fullModelClassName)
|
static ActiveRecord |
getHomeInstance(java.lang.Class<? extends ActiveRecord> clz)
Returns a home instance of a class type. |
static ActiveRecord |
getHomeInstance(java.lang.String fullModelClassName)
Returns a home instance of a class type. |
static ActiveRecord |
getHomeInstance(java.lang.String fullModelClassName,
java.lang.String modelName,
java.lang.String defaultModelClassName)
Returns an ActiveRecord home instance. |
static java.lang.String |
getModelName(ActiveRecord record)
Returns model name of an active record instance. |
static java.lang.String |
getModelName(java.lang.Class<? extends ActiveRecord> modelClass)
Returns model name of an active record class. |
static java.lang.String |
getModelName(java.lang.String tableName)
Returns model name for a table name. |
static java.lang.String |
getSimpleTableName(java.lang.Class<? extends ActiveRecord> c)
Returns the simple table name of an active record class. |
static java.lang.String |
getTableName(java.lang.Class<? extends ActiveRecord> c)
Returns full table name of an active record class. |
static boolean |
isSameRecord(ActiveRecord r1,
ActiveRecord r2)
Checks if the two records are actually the same record. |
static java.lang.Object |
newInstance(java.lang.Class<?> c,
java.lang.Class<?>[] parameterTypes,
java.lang.Object[] initargs)
Creates a new instance. |
static java.util.List<? extends ActiveRecord> |
remains(java.util.List<? extends ActiveRecord> one,
java.util.List<? extends ActiveRecord> two)
Removes duplicated items from list one. |
static void |
setCalculatorInstance(java.lang.String fullModelClassName,
Calculator cal)
Sets Calculator instance. |
static void |
setGateInstance(java.lang.String fullModelClassName,
TableGateway gate)
Sets gateway instance. |
static void |
setHomeInstance(ActiveRecord record)
Sets home instance. |
static void |
validateRecordType(java.lang.Class<? extends ActiveRecord> expected,
ActiveRecord record)
Validates a record is of the expected type. |
static void |
verifyExistenceOfColumn(java.lang.Class<? extends ActiveRecord> clazz,
java.lang.String fieldName)
Checks if a field name exists in a database table. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String DEFAULT_RECORD_CLASS
Constructor Detail |
---|
public ActiveRecordUtil()
Method Detail |
---|
public static boolean isSameRecord(ActiveRecord r1, ActiveRecord r2)
r1
- record 1r2
- record 2
public static void validateRecordType(java.lang.Class<? extends ActiveRecord> expected, ActiveRecord record)
expected
- record
-
WrongRecordTypeException
- exception if unexpected.public static java.util.List<? extends ActiveRecord> remains(java.util.List<? extends ActiveRecord> one, java.util.List<? extends ActiveRecord> two)
one
- the original listtwo
- the list to be subtracted
public static java.lang.String getFullClassName(java.lang.Class<? extends ActiveRecord> c)
public static java.lang.String getModelName(java.lang.Class<? extends ActiveRecord> modelClass)
modelClass
- an ActiveRecord class type
public static java.lang.String getModelName(ActiveRecord record)
record
- ActiveRecord instance
public static java.lang.String getModelName(java.lang.String tableName)
tableName
- table name for the model
public static java.lang.String getTableName(java.lang.Class<? extends ActiveRecord> c)
c
- an ActiveRecord class type
public static java.lang.String getSimpleTableName(java.lang.Class<? extends ActiveRecord> c)
c
- an ActiveRecord class type
public static ActiveRecord generateActiveRecordInstance(java.lang.String className, java.lang.String model)
Generates an instance of ActiveRecord. model value is used
to deduce the table name related to the ActiveRecord instance. The
meta data of the model is obtained from the default database
connection name as specified by the database.properties file
or from the getConnectionName()
method of the underlying model class.
className
- class name of the ActiveRecord instance to be created.model
- model name of the ActiveRecord class.
public static ActiveRecord generateActiveRecordInstance(java.lang.String className, java.lang.String connName, java.lang.String model)
Generates an instance of ActiveRecord. connName is the database connection name from where the meta data of the model is obtained. model value is used to deduce the table name related to the ActiveRecord instance.
The table name related to this model is going to be derived from the model name.
className
- class name of the ActiveRecord instance to be createdconnName
- db connection namemodel
- model name of the ActiveRecord class
public static ActiveRecord generateActiveRecordInstance(java.lang.String className, java.lang.String connName, java.lang.String model, java.lang.String table)
Generates an instance of ActiveRecord. connName is the database connection name from where the meta data of the model is obtained. model value is used to deduce the table name related to the ActiveRecord instance.
className
- class name of the ActiveRecord instance to be createdconnName
- db connection namemodel
- model name of the ActiveRecord classtable
- table name related to the ActiveRecord class
public static java.lang.Object newInstance(java.lang.Class<?> c, java.lang.Class<?>[] parameterTypes, java.lang.Object[] initargs) throws java.lang.Exception
c
- class type of the new instanceparameterTypes
- constructor parameter typesinitargs
- constructor parameter values
java.lang.Exception
public static ActiveRecord getHomeInstance(java.lang.String fullModelClassName, java.lang.String modelName, java.lang.String defaultModelClassName)
See description of
getHomeInstance(java.lang.String)
method for more details.
fullModelClassName
- class name of the modelmodelName
- model namedefaultModelClassName
- default model class name
public static ActiveRecord getHomeInstance(java.lang.String fullModelClassName)
Returns a home instance of a class type.
A home instance of a record is a read-only instance for a model type. Its main function is to provide meta information of the model and some finder methods.
In this method, the value of fullModelClassName cannot be
DEFAULT_RECORD_CLASS
, because each home instance of a record
class type is cached for performance.
This method creates a home instance the first time it is called.
fullModelClassName
- class type name of the model
public static ActiveRecord getHomeInstance(java.lang.Class<? extends ActiveRecord> clz)
Returns a home instance of a class type. See description of
getHomeInstance(java.lang.String)
method for more details.
clz
- class of the model
public static void setHomeInstance(ActiveRecord record)
record
- a home instancepublic static TableGateway getGateway(java.lang.Class<? extends ActiveRecord> modelClass)
public static TableGateway getGateway(java.lang.String fullModelClassName)
public static TableGateway getGateway(ActiveRecord home)
public static void setGateInstance(java.lang.String fullModelClassName, TableGateway gate)
fullModelClassName
- model class namegate
- a gateway instancepublic static Calculator getCalculator(java.lang.Class<? extends ActiveRecord> modelClass)
modelClass
- model class type
public static Calculator getCalculator(java.lang.String fullModelClassName)
fullModelClassName
-
public static void setCalculatorInstance(java.lang.String fullModelClassName, Calculator cal)
fullModelClassName
- model class namecal
- a Calculator instancepublic static void verifyExistenceOfColumn(java.lang.Class<? extends ActiveRecord> clazz, java.lang.String fieldName)
clazz
- the class type of an ActiveRecord recordfieldName
- a field name
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |