JADE Java Persistence API
1.0

com.jadeworld.jade.persistence
Annotation Type Schema


@Retention(value=RUNTIME)
@Target(value=PACKAGE)
public @interface Schema

Package-level annotation. Each Java package that contains persisted classes must also be annotated. This is done by including a file named package-info.java in the package. This file must contain an @Schema annotation and the file contents are of the form:

@Schema(name="CDCatalogue", applicationName="CDCatJava", defaultMapFile="catalog")
package CDCatalogue;
import com.jadeworld.jade.persistence.Schema;

That is, the file contains an @Schema annotation, a Java package declaration for the current package name, and an import of com.jadeworld.jade.persistence.Schema to make the annotation available to the Java compiler.

Author:
JADE Development Centre, Jade Software Corporation Ltd.

Required Element Summary
 java.lang.String name
          The JADE schema name for the classes in the package.
 
Optional Element Summary
 java.lang.String applicationName
          Optional.
 java.lang.String defaultMapFile
          Optional.
 java.lang.String superSchema
          Optional.
 

Element Detail

name

public abstract java.lang.String name
The JADE schema name for the classes in the package.

applicationName

public abstract java.lang.String applicationName
Optional. The name of the non-GUI JADE application to run when signing on to this schema and defaults to the schema name.

Default:
""

superSchema

public abstract java.lang.String superSchema
Optional. The superschema name of this JADE schema and defaults to RootSchema (the top-most JADE schema).

Default:
"RootSchema"

defaultMapFile

public abstract java.lang.String defaultMapFile
Optional. The default mapFile to use for persisted classes and defaults to a map file with the same name as the schema.

Default:
""

JADE Java Persistence API
1.0

Copyright © 2007 Jade Software Corporation