com.jadeworld.jade.persistence
Annotation Type CollectionEntity

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

Specifies the details for a JADE collection class. The class must inherit from one of the com.jadeworld.jade.rootschema.Collection subclasses.

Author:

JADE Development Centre, Jade Software Corporation Ltd.

Optional Element Summary

boolean	duplicatesAllowed duplicatesAllowed is relevant only for a Dictionary subclass and it determines whether more than one distinct entry is allowed for the same key values.
DictionaryKey[]	keys Collections classes inheriting from Dictionary need one or more DictionaryKey entries to define the keys used in this collection.
java.lang.String	mapFile JADE collection class map file name, which defaults to member class map file name.
java.lang.String	memberClass The member class is the class contained within this collection.
java.lang.String	name The name of the JADE class.

name

public abstract java.lang.String name

The name of the JADE class. Defaults to the unqualified name of the Java class.

Default:

""

memberClass

public abstract java.lang.String memberClass

The member class is the class contained within this collection. JADE collections are typed. If the collection class is defined using generics, the menber class name is derived from the class definition; otherwise it must be defined here. If it is defined both here and in the class definition using generics, this definition is ignored and the class one is used instead.

Default:

""

duplicatesAllowed

public abstract boolean duplicatesAllowed

duplicatesAllowed is relevant only for a Dictionary subclass and it determines whether more than one distinct entry is allowed for the same key values.

Default:

false

mapFile

public abstract java.lang.String mapFile

JADE collection class map file name, which defaults to member class map file name.

Default:

""

keys

public abstract DictionaryKey[] keys

Collections classes inheriting from Dictionary need one or more DictionaryKey entries to define the keys used in this collection. The keys are defined in sequence from most-major to most-minor.

Default:

{}