org.springframework.roo.addon.jpa.annotations.entity

Annotation Type RooJpaEntity

@Retention(value=SOURCE)
 @Target(value=TYPE)
public @interface RooJpaEntity

Indicates a type that is a JPA entity.

Since:

1.2.0

Author:

Andrew Swan, Juan Carlos García, Sergio Clares

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	catalog Specifies the database catalog name that should be used for the entity.
String	entityFormatExpression Specifies the Spring Expression Language expression to use for formatting the entity in presentation layer.
String	entityFormatMessage Specifies the localization message used to obtain a localized Spring Expression Language expression to format the entity when showing it in presentation layer.
String	entityName Specifies the name used to refer to the entity in queries.
String	inheritanceType Specifies the JPA inheritance type that should be used for the entity.
boolean	mappedSuperclass
boolean	readOnly Specifies if current entity should be used for read only operations.
String	schema Specifies the database schema name that should be used for the entity.
String	table Specifies the table name that should be used for the entity.

Element Detail

catalog

public abstract String catalog

Specifies the database catalog name that should be used for the entity.

Returns:

the name of the catalog to use (defaults to "")

Default:

""

entityName

public abstract String entityName

Specifies the name used to refer to the entity in queries.

The name must not be a reserved literal in JPQL.

Returns:

the name given to the entity (defaults to "")

Default:

""

inheritanceType

public abstract String inheritanceType

Specifies the JPA inheritance type that should be used for the entity.

Returns:

the inheritance type to use (defaults to "")

Default:

""

mappedSuperclass

public abstract boolean mappedSuperclass

Returns:

whether to generated a @MappedSuperclass type annotation instead of @Entity (defaults to false).

Default:

false

schema

public abstract String schema

Specifies the database schema name that should be used for the entity.

Returns:

the name of the schema to use (defaults to "")

Default:

""

table

public abstract String table

Specifies the table name that should be used for the entity.

Returns:

the name of the table to use (defaults to "")

Default:

""

readOnly

public abstract boolean readOnly

Specifies if current entity should be used for read only operations. This param will be taken in mind to generate readOnly repositories and services.

Returns:

true if entity should be used for read only operations and false if this entity should be used for CRUD operations.

Default:

false

entityFormatMessage

public abstract String entityFormatMessage

Specifies the localization message used to obtain a localized Spring Expression Language expression to format the entity when showing it in presentation layer.

Returns:

the key of the message with the SpEL (defaults to "").

Default:

""

entityFormatExpression

public abstract String entityFormatExpression

Specifies the Spring Expression Language expression to use for formatting the entity in presentation layer.

Returns:

the SpEL (defaults to "").

Default:

""