org.eclipse.persistence.annotations

Annotation Type Struct

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

Struct types are extended object-relational data-types supported by some databases. Struct types are user define types in the database such as OBJECT types on Oracle. Structs can normally contains Arrays (VARRAY) or other Struct types, and can be stored in a column or a table.

This annotation define a class to map to a database Struct type. The class should normally be an Embeddable, but could also be an Entity if stored in a object table.

See Also:

ObjectRelationalDataTypeDescriptor, StructureMapping

Author:

James Sutherland

Since:

EclipseLink 2.3

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
java.lang.String	name (Required) The database name of the database structure type.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
java.lang.String[]	fields (Optional) Defines the order of the fields contained in the database structure type.

Element Detail

name

public abstract java.lang.String name

(Required) The database name of the database structure type.

fields

public abstract java.lang.String[] fields

(Optional) Defines the order of the fields contained in the database structure type.

Default:

{}