A.6. metadata.xml

这种类型的文件用来注册自定义的数据类型以及非持久化实体并且设置元注解(meta-annotations)

XML schema 标准: http://schemas.haulmont.com/cuba/7.0/metadata.xsd。

项目的 metadata.xml 文件通过 cuba.metadataConfig 应用程序属性来指定。

文件有如下结构:

metadata – 根元素。

metadata 的元素:

  • datatypes - 自定义类型的一个可选描述。

datatypes 的元素:

  • datatype - 数据类型描述,有如下属性:
  1. -

id - 标识符,用来在 @MetaProperty 注解中表示这个数据类型。

  1. -

class - 定义实现类

  1. -

sqlType - 可选参数,用来保存此数据类型值的数据库 SQL 类型(数据库字段类型)。CUBA Studio 会在生成数据库脚本的时候使用这个 SQL 类型。参考 自定义数据类型示例 了解细节。

datatype 元素可以包含其它依赖这个数据类型实现的属性。

  • metadata-model – 项目元数据模型描述符。

metadata-model 的属性:

  • root-package – 项目包的根目录。

metadata-model 的元素:

  • class – 非持久化实体类
  • annotations – 包含实体元注解的设置。

annotations 元素包含 entity 元素定义元注解设置的实体类。每个 entity 元素必须包含 class 属性来指定实体类,以及一组 annotation 元素。

annotation 元素用来定义元注解,用 name 属性来指定元注解的名称。元注解的其它属性通过一组 attribute 子元素来指定。

示例:

  1. <metadata xmlns="http://schemas.haulmont.com/cuba/metadata.xsd">
  2. <metadata-model root-package="com.sample.sales">
  3. <class>com.sample.sales.entity.SomeNonPersistentEntity</class>
  4. <class>com.sample.sales.entity.OtherNonPersistentEntity</class>
  5. </metadata-model>
  6. <annotations>
  7. <entity class="com.haulmont.cuba.security.entity.User">
  8. <annotation name="com.haulmont.cuba.core.entity.annotation.TrackEditScreenHistory">
  9. <attribute name="value" value="true" datatype="boolean"/>
  10. </annotation>
  11. <annotation name="com.haulmont.cuba.core.entity.annotation.EnableRestore">
  12. <attribute name="value" value="true" datatype="boolean"/>
  13. </annotation>
  14. </entity>
  15. <entity class="com.haulmont.cuba.core.entity.Category">
  16. <annotation name="com.haulmont.cuba.core.entity.annotation.SystemLevel">
  17. <attribute name="value" value="false" datatype="boolean"/>
  18. </annotation>
  19. </entity>
  20. </annotations>
  21. </metadata>