org.ujorm.orm.metaModel
Class MetaParams

java.lang.Object
  org.ujorm.extensions.AbstractUjo
      org.ujorm.implementation.quick.QuickUjo
          org.ujorm.orm.AbstractMetaModel
              org.ujorm.orm.metaModel.MetaParams

All Implemented Interfaces:

java.io.Serializable, UjoCloneable, UjoTextable, Ujo

public final class MetaParams
extends AbstractMetaModel

A logical database description. The class is a root of database configuration.

Author:

Pavel Ponec

See Also:

Serialized Form

Field Summary

static Property<MetaParams,java.lang.Object>	APPL_CONTEXT An application context for initializaton of the customer componets of the meta-model.
static Property<MetaParams,CachePolicy>	CACHE_POLICY Session cache policy.
static Property<MetaParams,CommentPolicy>	COMMENT_POLICY A policy for assigning an annotation table comment Comment to database.
static Property<MetaParams,CheckReport>	CHECK_KEYWORDS CheckReport a keyword in the database table or colum name inside the meta-model.
static Property<MetaParams,java.lang.Boolean>	INHERITANCE_MODE Any action type or CREATE, UPDATE, DELETE on inheritance objects calls the same action to its 'parrent' object.
static Property<MetaParams,java.lang.Integer>	INSERT_MULTIROW_ITEM_LIMIT The parameter is used to limit of the insert sttatemtn in case the "sql multirow insert".
static Property<MetaParams,java.lang.Boolean>	LOG_METAMODEL_INFO Set a logging level for a full meta-model information in the XML format.
static Property<MetaParams,java.lang.Boolean>	LOGBACK_LOGGING_SUPPORT Pamameter tries to install a brighe to the Logback logging framework using a statement SLF4JBridgeHandler.install();
static Property<MetaParams,java.lang.Integer>	MAX_ITEM_COUNT_4_IN The maximal count of items for the SQL IN operator, default value is 500 items The limit is used inside the method loadLazyValuesAsBatch(..).
static Property<MetaParams,MoreParams>	MORE_PARAMS The parameter contains the special parameters with for different use.
static Property<MetaParams,Orm2ddlPolicy>	ORM2DLL_POLICY A policy to defining the database structure by a DDL.
static Property<MetaParams,java.io.File>	SAVE_CONFIG_TO_FILE Framework can save the final configuration file to a new file for an external use.
static Property<MetaParams,java.lang.Integer>	SEQUENCE_CACHE Sequential cache parameter saves the number of requests to the following sequence when a insert statement into DB.
static Property<MetaParams,java.lang.Boolean>	SEQUENCE_SCHEMA_SYMBOL The parameter value TRUE affects to a Sequence key name in the internal sequence generator.
static Property<MetaParams,java.lang.String>	TABLE_ALIAS_PREFIX Special prameter for an automatically assembled table alias prefix.
static Property<MetaParams,java.lang.String>	TABLE_ALIAS_SUFFIX Special prameter for an automatically assembled table alias prefix.
static Property<MetaParams,java.lang.Class<? extends TypeService>>	TYPE_SERVICE The instance of the parameter class TypeService is used for conversion, reading and writting to/from the ResultSet.

Constructor Summary

MetaParams()

Method Summary

TypeService	getConverter(java.lang.Class<? extends TypeService> converterClass) Returns a converter instance.
MoreParams	more() Returns an object to provide the special parameters for a different use.
<UJO extends MetaParams,VALUE> MetaParams	set(UjoProperty<UJO,VALUE> property, VALUE value) Set a parameter value
MetaParams	setApplContext(java.lang.Object applContext) Set application context.
void	writeValue(UjoProperty property, java.lang.Object value) It is a common method for writing all object values, however there is strongly recomended to use a method Property.setValue(org.ujorm.Ujo, java.lang.Object) to an external access for a better type safe.

Methods inherited from class org.ujorm.orm.AbstractMetaModel

get, changeDefault, checkReadOnly, isFilled, isFilled, readAuthorization, readOnly, setReadOnly

Methods inherited from class org.ujorm.implementation.quick.QuickUjo

newListProperty, newListProperty, newProperty, newProperty, newProperty, newProperty, newProperty, newProperty, readValue

Methods inherited from class org.ujorm.extensions.AbstractUjo

clone, equals, init, init, readProperties, readUjoManager, readValueString, toString, writeValueString

Methods inherited from class java.lang.Object

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

Field Detail

CACHE_POLICY

public static final Property<MetaParams,CachePolicy> CACHE_POLICY

Session cache policy. The default value is PROTECTED_CACHE.

See Also:

Parameter values

TABLE_ALIAS_PREFIX

public static final Property<MetaParams,java.lang.String> TABLE_ALIAS_PREFIX

Special prameter for an automatically assembled table alias prefix. The default value is the empty string.

TABLE_ALIAS_SUFFIX

public static final Property<MetaParams,java.lang.String> TABLE_ALIAS_SUFFIX

Special prameter for an automatically assembled table alias prefix. The default value is the empty String.

SEQUENCE_CACHE

public static final Property<MetaParams,java.lang.Integer> SEQUENCE_CACHE

Sequential cache parameter saves the number of requests to the following sequence when a insert statement into DB. The value of the parameter is used only when creating a new DB, indivuální ORM changes for each table can be changed any time later in the column 'cache' of table 'ormujo_pk_support' . Default values is 100, the smallest possible value is 1.

ORM2DLL_POLICY

public static final Property<MetaParams,Orm2ddlPolicy> ORM2DLL_POLICY

A policy to defining the database structure by a DDL. The default value is option: CREATE_OR_UPDATE_DDL.

See Also:

Parameter values

COMMENT_POLICY

public static final Property<MetaParams,CommentPolicy> COMMENT_POLICY

A policy for assigning an annotation table comment Comment to database. The default value is ON_ANY_CHANGE.

See Also:

Parameter values

SAVE_CONFIG_TO_FILE

public static final Property<MetaParams,java.io.File> SAVE_CONFIG_TO_FILE

Framework can save the final configuration file to a new file for an external use. If this parameter is null than the save action is skipped.

TYPE_SERVICE

public static final Property<MetaParams,java.lang.Class<? extends TypeService>> TYPE_SERVICE

The instance of the parameter class TypeService is used for conversion, reading and writting to/from the ResultSet. You can specify a sybtype of the class for a commiono special fetures.

See Also:

Column.converter()

CHECK_KEYWORDS

public static final Property<MetaParams,CheckReport> CHECK_KEYWORDS

CheckReport a keyword in the database table or colum name inside the meta-model. The default value is EXCEPTION.

See Also:

Parameter values

MAX_ITEM_COUNT_4_IN

public static final Property<MetaParams,java.lang.Integer> MAX_ITEM_COUNT_4_IN

The maximal count of items for the SQL IN operator, default value is 500 items The limit is used inside the method loadLazyValuesAsBatch(..).

See Also:

OrmTools.loadLazyValuesAsBatch(java.lang.Iterable, org.ujorm.UjoProperty)

SEQUENCE_SCHEMA_SYMBOL

public static final Property<MetaParams,java.lang.Boolean> SEQUENCE_SCHEMA_SYMBOL

The parameter value TRUE affects to a Sequence key name in the internal sequence generator. Value TRUE generate a special character "~" instead of default database schema in the sequence table. The benefit of the special chatacter can be evaluated in the case of the renaming of the database schema. In case of change of the parameter value is necessary to convert values in the database column 'ujorm_pk_support.id' by hand. The default value is FALSE.

INHERITANCE_MODE

public static final Property<MetaParams,java.lang.Boolean> INHERITANCE_MODE

Any action type or CREATE, UPDATE, DELETE on inheritance objects calls the same action to its 'parrent' object. If the mode is off than you must take care of all its parents in the code handy. The default falue is TRUE.
Note: the parameter does not affect the opearations batch update or batch delete due direct modification of database.

See Also:

MetaTable.getParent(..)

INSERT_MULTIROW_ITEM_LIMIT

public static final Property<MetaParams,java.lang.Integer> INSERT_MULTIROW_ITEM_LIMIT

The parameter is used to limit of the insert sttatemtn in case the "sql multirow insert". The default value is 100.

See Also:

save(List)

MORE_PARAMS

public static final Property<MetaParams,MoreParams> MORE_PARAMS

The parameter contains the special parameters with for different use.

See Also:

MoreParams

LOG_METAMODEL_INFO

public static final Property<MetaParams,java.lang.Boolean> LOG_METAMODEL_INFO

Set a logging level for a full meta-model information in the XML format. The TRUE value means the INFO level and the FALSE value means the FINE logging level.

LOGBACK_LOGGING_SUPPORT

public static final Property<MetaParams,java.lang.Boolean> LOGBACK_LOGGING_SUPPORT

Pamameter tries to install a brighe to the Logback logging framework using a statement SLF4JBridgeHandler.install();

APPL_CONTEXT

public static final Property<MetaParams,java.lang.Object> APPL_CONTEXT

An application context for initializaton of the customer componets of the meta-model.

Constructor Detail

MetaParams

public MetaParams()

Method Detail

writeValue

public void writeValue(UjoProperty property,
                       java.lang.Object value)

Description copied from class: QuickUjo

It is a common method for writing all object values, however there is strongly recomended to use a method Property.setValue(org.ujorm.Ujo, java.lang.Object) to an external access for a better type safe. The method have got a strategy place for an implementation of several listeners and validators.
NOTE: If property is an incorrect then method can throws an ArrayIndexOutOfBoundsException.

Specified by:

writeValue in interface Ujo

Overrides:

writeValue in class AbstractMetaModel

Parameters:

property - Property must be a direct type only!

See Also:

Property.setValue(Ujo,Object)

getConverter

public TypeService getConverter(java.lang.Class<? extends TypeService> converterClass)

Returns a converter instance. Method use an internal cache for smaller converter instance count.

Parameters:

converterClass - A class to create an instance of the converter. If the value is [@code null], then a default converter defined in parameters is used.

Returns:

Returns a converter instance.

set

public <UJO extends MetaParams,VALUE> MetaParams set(UjoProperty<UJO,VALUE> property,
                                                     VALUE value)

Set a parameter value

setApplContext

public MetaParams setApplContext(java.lang.Object applContext)

Set application context.

more

public MoreParams more()

Returns an object to provide the special parameters for a different use.