com.jadeworld.jade.persistence
Annotation Type DictionaryKey

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

Specifies each key detail for a MemberkeyDictionary subclass. Each annotation is in an array of CollectionEntity keys, in sequence from most-significant to least-significant.

Author:

JADE Development Centre, Jade Software Corporation Ltd.

Required Element Summary

java.lang.String

key The name of property or field in the member class that holds the key value.

Optional Element Summary

boolean	caseInsensitive Case-sensitivity option.
java.lang.String	jadeType The JADE type of this property, used only for internal purposes.
int	length length is required only for a key of an external keyed dictionary which is of JADE types Binary, Decimal, and String.
KeyOrder	sort The key sort sequence, one of KeyOrder.ASCENDING or KeyOrder.DESCENDING.
java.lang.String	sortOrder The key sort collation sequence.
java.lang.String	type The Java type of this property, used only for internal purposes.

Element Detail

key

public abstract java.lang.String key

The name of property or field in the member class that holds the key value.

type

public abstract java.lang.String type

The Java type of this property, used only for internal purposes.

Default:

""

length

public abstract int length

length is required only for a key of an external keyed dictionary which is of JADE types Binary, Decimal, and String.

Default:

-1

jadeType

public abstract java.lang.String jadeType

The JADE type of this property, used only for internal purposes.

Default:

""

sort

public abstract KeyOrder sort

The key sort sequence, one of KeyOrder.ASCENDING or KeyOrder.DESCENDING.

Default:

ASCENDING

sortOrder

public abstract java.lang.String sortOrder

The key sort collation sequence. Applies only to String keys, is one of "Binary", "Latin1", or a JADE locale name.

Default:

"Binary"

caseInsensitive

public abstract boolean caseInsensitive

Case-sensitivity option. Applies only to String keys; is either true or false.

Default:

true