org.gedcomx.rt

Annotation Type Model

@Retention(value=RUNTIME)
 @Target(value={})
public @interface Model

Metadata about a specific object model.

Author:

Ryan Heaton

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	id The id of the model.
String	namespace The namespace of the model.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	description A description of the model, used for user documentation.
String	label A label associated with the model, used to identify the model in the user documentation.

Element Detail

id

public abstract String id

The id of the model. Used to for things like naming the schema file and assigning an xml prefix.

Returns:

The id of the model.

namespace

public abstract String namespace

The namespace of the model.

Returns:

The namespace of the model.

label

public abstract String label

A label associated with the model, used to identify the model in the user documentation.

Returns:

A label associated with the model.

Default:

""

description

public abstract String description

A description of the model, used for user documentation.

Returns:

A description of the model, used for user documentation.

Default:

""