com.github.braisdom.objsql.annotations

注释类型 DomainModel

@Target(value=TYPE)
 @Retention(value=RUNTIME)
public @interface DomainModel

The domain model is a core concept in ObjectiveSql, it holds the logic and status in the application, describes the data structure of the database at the same time.
In ObjectiveSql, The query, persistence and convenient methods for database will be generated automatically base the JSR269. The methods generated:

• The setter and getter methods of fields
• The factory method for query and persistence
• The query methods of queryable field and model instance
• The persistence methods of model instance
• The transactional logic methods of domain

从以下版本开始:

1.3.1

作者:

braisdom

可选元素概要

可选元素

限定符和类型	可选元素和说明
boolean	allFieldsPersistent This option indicates the most of field can save into database, however the domain model can be applied into lots of different scenarios, sometimes, only few field can save into database, so the option defined.
String	dataSource Defines a customized name of DataSource in multi-data source time.
boolean	fluent It indicates the DomainModel has fluent method for setting field.
Class<?>	primaryClass Changes the primary type if it is different data type in the database.
String	primaryColumnName Customizes the column name mapped for the domain model
String	primaryFieldName Customizes the field name for mapping the column
String	primaryKeyDefaultValue Default value for primary key, in general, it is a auto increment identifier at inserting.
boolean	skipNullValueOnUpdating Skips the null value of field when updating a domain model if true Returns false if the null value can save into the database.
boolean	skipPrimaryValueOnInsert Indicates the primary key is auto generated, and the SQL will ignore the value of 'id' when domain object inserted.
String	tableName Returns the table name customized.

元素详细资料

tableName

public abstract String tableName

Returns the table name customized.
It will tableize the class name as the table name by default. Defines a table name by DomainModel annotation while it's out of the rule.

返回:

a table name customized.

另请参阅:

WordUtil.tableize(String)

默认值:

""

dataSource

public abstract String dataSource

Defines a customized name of DataSource in multi-data source time. By default, a named 'objsql-default-datasource' will be used, the application should be named that way.

返回:

a name of data source related to the domain model who maps a table.

默认值:

"objsql-default-datasource"

fluent

public abstract boolean fluent

It indicates the DomainModel has fluent method for setting field.
Like this:

     Model model = new Model();
     model.setField1(...)
          .setField2(...)
          .setField3(...);
 

You can disable the feature if in special scenes.

默认值:

true

primaryClass

public abstract Class<?> primaryClass

Changes the primary type if it is different data type in the database. By default, the Integer is used for a primary key as the mapping of database.
Notice: Only Long, Integer, Short can be as a primary key.

默认值:

java.lang.Long.class

primaryColumnName

public abstract String primaryColumnName

Customizes the column name mapped for the domain model

默认值:

"id"

primaryFieldName

public abstract String primaryFieldName

Customizes the field name for mapping the column

默认值:

"id"

skipNullValueOnUpdating

public abstract boolean skipNullValueOnUpdating

Skips the null value of field when updating a domain model if true Returns false if the null value can save into the database.

默认值:

true

allFieldsPersistent

public abstract boolean allFieldsPersistent

This option indicates the most of field can save into database, however the domain model can be applied into lots of different scenarios, sometimes, only few field can save into database, so the option defined.

默认值:

true

primaryKeyDefaultValue

public abstract String primaryKeyDefaultValue

Default value for primary key, in general, it is a auto increment identifier at inserting.

默认值:

""

skipPrimaryValueOnInsert

public abstract boolean skipPrimaryValueOnInsert

Indicates the primary key is auto generated, and the SQL will ignore the value of 'id' when domain object inserted.

返回:

从以下版本开始:

1.3.6

默认值:

false