net.akaish.kitty.orm.util

Class KittyNamingUtils

java.lang.Object

net.akaish.kitty.orm.util.KittyNamingUtils

public class KittyNamingUtils
extends java.lang.Object

Just some namings utils for default strings and filenames Created by akaish on 28.07.18.

Author:

akaish (Denis Bogomolov)

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	AFTER_CREATE_SCRIPT_FILENAME_PATTERN
static java.lang.String	AFTER_MIGRATE_SCRIPT_FILENAME_PATTERN
static java.lang.String	ASSETS_URI_START
static java.lang.String	CREATE_SCRIPT_FILENAME_PATTERN
static java.lang.String	DESERIALIZE
static java.lang.String	DROP_SCRIPT_FILENAME_PATTERN
static java.lang.String	EXTERNAL_MEM_URI_START
static java.lang.String	IA_BAD_URI
static java.lang.String	INTERNAL_MEM_URI_START

Constructor Summary

Constructors

Constructor and Description
KittyNamingUtils()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	generateColumnNameFromModelField(java.lang.reflect.Field f) Returns default column name generated from KittyModel field.
static <T extends KittyDatabase> java.lang.String	generateSchemaNameFromDatabaseClassName(java.lang.Class<T> kittyDatabaseClass) Returns default schema name generated from KittyDatabase implementation classname.
static <T extends KittyModel> java.lang.String	generateTableNameFromRecordName(java.lang.Class<T> model) Returns generated name of table 1) Record and Model endings would be deleted 2) Camel case would be changes to lower_case_underscore
static java.lang.String	getAfterCreateScriptDefaultFilename(java.lang.String schemaName, int schemaVersion) Returns default filename for schema after create script.
static java.lang.String	getAfterMigrateScriptDefaultFilename(java.lang.String schemaName, int schemaVersion) Returns default filename for schema after migrate script.
static java.lang.String	getCreateSchemaDefaultFilename(java.lang.String schemaName, int schemaVersion) Returns default filename for schema create script.
static java.lang.String	getDefaultAssetDatabaseScriptsPath(java.lang.String schemaName) Returns default scripts location for provided database name, output would be: file:///android_asset/ + kittysqliteorm/database_name/
static java.lang.String	getDefaultDatabaseMigrationScriptsPath(android.content.Context ctx, java.lang.String schemaName, boolean scriptsInAssets) Returns default scripts location for provided database name, output would be: getFilesDir().getAbsolutePath() + /kittysqliteorm/database_name/version_migrations or file:///android_asset + /kittysqliteorm/database_name/version_migrations
static java.lang.String	getDefaultDatabaseScriptsPath(android.content.Context context, java.lang.String schemaName) Returns default scripts location for provided database name, output would be: file:///internal_memory/ + kittysqliteorm/database_name/ that is equivalent for getFilesDir().getAbsolutePath() + /kittysqliteorm/database_name/
static java.lang.String	getDefaultDeserializationMethodName(java.lang.String fieldName) Returns default serialization name for provided field name.
static java.lang.String	getDefaultSerializationMethodName(java.lang.String fieldName) Returns default serialization name for provided field name.
static java.lang.String	getDevelopmentDumpsDefaultPath(java.lang.String scriptRootPath, java.lang.String scriptName) Returns filepath for development create\drop scripts (or other if necessary) for specified scripts root.
static java.lang.String	getDropSchemaDefaultFilename(java.lang.String schemaName, int schemaVersion) Returns default filename for schema drop script.
static java.io.File	getScriptFile(java.lang.String locationUri, android.content.Context ctx) Returns script file instance depends on locationUri value (if locationUri starts with ASSETS_URI_START IA exception would be thrown)
static java.lang.String	getSQLiteScriptPath(java.lang.String scriptRootPath, java.lang.String scriptName) Returns filepath for create\drop scripts for specified scripts root.

Methods inherited from class java.lang.Object

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

Field Detail

ASSETS_URI_START

public static final java.lang.String ASSETS_URI_START

See Also:

Constant Field Values

INTERNAL_MEM_URI_START

public static final java.lang.String INTERNAL_MEM_URI_START

See Also:

Constant Field Values

EXTERNAL_MEM_URI_START

public static final java.lang.String EXTERNAL_MEM_URI_START

See Also:

Constant Field Values

CREATE_SCRIPT_FILENAME_PATTERN

public static final java.lang.String CREATE_SCRIPT_FILENAME_PATTERN

See Also:

Constant Field Values

DROP_SCRIPT_FILENAME_PATTERN

public static final java.lang.String DROP_SCRIPT_FILENAME_PATTERN

See Also:

Constant Field Values

AFTER_CREATE_SCRIPT_FILENAME_PATTERN

public static final java.lang.String AFTER_CREATE_SCRIPT_FILENAME_PATTERN

See Also:

Constant Field Values

AFTER_MIGRATE_SCRIPT_FILENAME_PATTERN

public static final java.lang.String AFTER_MIGRATE_SCRIPT_FILENAME_PATTERN

See Also:

Constant Field Values

DESERIALIZE

public static final java.lang.String DESERIALIZE

See Also:

Constant Field Values

IA_BAD_URI

public static final java.lang.String IA_BAD_URI

See Also:

Constant Field Values

Constructor Detail

KittyNamingUtils

public KittyNamingUtils()

Method Detail

generateSchemaNameFromDatabaseClassName

public static final <T extends KittyDatabase> java.lang.String generateSchemaNameFromDatabaseClassName(java.lang.Class<T> kittyDatabaseClass)

Returns default schema name generated from KittyDatabase implementation classname.
Name generated with usage of KittyUtils.fieldNameToLowerCaseUnderScore(String)

Type Parameters:

T -

Parameters:

kittyDatabaseClass -

Returns:

generateColumnNameFromModelField

public static final java.lang.String generateColumnNameFromModelField(java.lang.reflect.Field f)

Returns default column name generated from KittyModel field.
Name generated with usage of KittyUtils.fieldNameToLowerCaseUnderScore(String)

Parameters:

f -

Returns:

getDefaultAssetDatabaseScriptsPath

public static final java.lang.String getDefaultAssetDatabaseScriptsPath(java.lang.String schemaName)

Returns default scripts location for provided database name, output would be:
file:///android_asset/ + kittysqliteorm/database_name/

Parameters:

schemaName -

Returns:

getScriptFile

public static final java.io.File getScriptFile(java.lang.String locationUri,
                                               android.content.Context ctx)

Returns script file instance depends on locationUri value (if locationUri starts with ASSETS_URI_START IA exception would be thrown)

Parameters:

locationUri -

ctx -

Returns:

getDefaultDatabaseScriptsPath

public static final java.lang.String getDefaultDatabaseScriptsPath(android.content.Context context,
                                                                   java.lang.String schemaName)

Returns default scripts location for provided database name, output would be:
file:///internal_memory/ + kittysqliteorm/database_name/
that is equivalent for
getFilesDir().getAbsolutePath() + /kittysqliteorm/database_name/

Parameters:

context -

schemaName -

Returns:

getDefaultDatabaseMigrationScriptsPath

public static final java.lang.String getDefaultDatabaseMigrationScriptsPath(android.content.Context ctx,
                                                                            java.lang.String schemaName,
                                                                            boolean scriptsInAssets)

Returns default scripts location for provided database name, output would be:
getFilesDir().getAbsolutePath() + /kittysqliteorm/database_name/version_migrations
or
file:///android_asset + /kittysqliteorm/database_name/version_migrations

Parameters:

ctx -

schemaName -

Returns:

getCreateSchemaDefaultFilename

public static final java.lang.String getCreateSchemaDefaultFilename(java.lang.String schemaName,
                                                                    int schemaVersion)

Returns default filename for schema create script. For schema "sample" v.3 it would be sample-v-3-create.sql (pattern is {0}-v-{1}-create.sql)

Parameters:

schemaName -

schemaVersion -

Returns:

getDropSchemaDefaultFilename

public static final java.lang.String getDropSchemaDefaultFilename(java.lang.String schemaName,
                                                                  int schemaVersion)

Returns default filename for schema drop script. For schema "sample" v.3 it would be sample-v-3-drop.sql (pattern is {0}-v-{1}-drop.sql)

Parameters:

schemaName -

schemaVersion -

Returns:

getAfterCreateScriptDefaultFilename

public static final java.lang.String getAfterCreateScriptDefaultFilename(java.lang.String schemaName,
                                                                         int schemaVersion)

Returns default filename for schema after create script. For schema "sample" v.3 it would be sample-v-3-after_create.sql (pattern is {0}-v-{1}-after_create.sql)

Parameters:

schemaName -

schemaVersion -

Returns:

getAfterMigrateScriptDefaultFilename

public static final java.lang.String getAfterMigrateScriptDefaultFilename(java.lang.String schemaName,
                                                                          int schemaVersion)

Returns default filename for schema after migrate script. For schema "sample" v.3 it would be sample-v-3-after_migrate.sql (pattern is {0}-v-{1}-after_migrate.sql)

Parameters:

schemaName -

schemaVersion -

Returns:

getSQLiteScriptPath

public static final java.lang.String getSQLiteScriptPath(java.lang.String scriptRootPath,
                                                         java.lang.String scriptName)

Returns filepath for create\drop scripts for specified scripts root.

Parameters:

scriptRootPath -

scriptName -

Returns:

getDevelopmentDumpsDefaultPath

public static final java.lang.String getDevelopmentDumpsDefaultPath(java.lang.String scriptRootPath,
                                                                    java.lang.String scriptName)

Returns filepath for development create\drop scripts (or other if necessary) for specified scripts root.

Parameters:

scriptRootPath -

scriptName -

Returns:

getDefaultSerializationMethodName

public static final java.lang.String getDefaultSerializationMethodName(java.lang.String fieldName)

Returns default serialization name for provided field name. For example, for field _id returned String would be _idSerialize

Parameters:

fieldName -

Returns:

getDefaultDeserializationMethodName

public static final java.lang.String getDefaultDeserializationMethodName(java.lang.String fieldName)

Returns default serialization name for provided field name. For example, for field _id returned String would be _idDeserialize

Parameters:

fieldName -

Returns:

generateTableNameFromRecordName

public static final <T extends KittyModel> java.lang.String generateTableNameFromRecordName(java.lang.Class<T> model)

Returns generated name of table
1) Record and Model endings would be deleted
2) Camel case would be changes to lower_case_underscore

Type Parameters:

T - implementation of KittyModel

Parameters:

model - model class

Returns:

table name