ElementCollection (hibernate-jpamodelgen JavaDocs)

java.lang.Object
- org.hibernate.jpamodelgen.xml.jaxb.ElementCollection

```
public class ElementCollection
extends Object
```
@Target({METHOD, FIELD}) @Retention(RUNTIME) public @interface ElementCollection { Class targetClass() default void.class; FetchType fetch() default LAZY; }

Java class for element-collection complex type.

The following schema fragment specifies the expected content contained within this class.

<pre> <complexType name="element-collection"> <complexContent> <restriction base="{http://www.w3.org/2001/XMLSchema}anyType"> <sequence> <choice> <element name="order-by" type="{http://xmlns.jcp.org/xml/ns/persistence/orm}order-by" minOccurs="0"/> <element name="order-column" type="{http://xmlns.jcp.org/xml/ns/persistence/orm}order-column" minOccurs="0"/> </choice> <choice> <element name="map-key" type="{http://xmlns.jcp.org/xml/ns/persistence/orm}map-key" minOccurs="0"/> <sequence> <element name="map-key-class" type="{http://xmlns.jcp.org/xml/ns/persistence/orm}map-key-class" minOccurs="0"/> <choice> <element name="map-key-temporal" type="{http://xmlns.jcp.org/xml/ns/persistence/orm}temporal" minOccurs="0"/> <element name="map-key-enumerated" type="{http://xmlns.jcp.org/xml/ns/persistence/orm}enumerated" minOccurs="0"/> <sequence> <element name="map-key-attribute-override" type="{http://xmlns.jcp.org/xml/ns/persistence/orm}attribute-override" maxOccurs="unbounded" minOccurs="0"/> <element name="map-key-convert" type="{http://xmlns.jcp.org/xml/ns/persistence/orm}convert" maxOccurs="unbounded" minOccurs="0"/> </sequence> </choice> <choice> <element name="map-key-column" type="{http://xmlns.jcp.org/xml/ns/persistence/orm}map-key-column" minOccurs="0"/> <sequence> <element name="map-key-join-column" type="{http://xmlns.jcp.org/xml/ns/persistence/orm}map-key-join-column" maxOccurs="unbounded" minOccurs="0"/> <element name="map-key-foreign-key" type="{http://xmlns.jcp.org/xml/ns/persistence/orm}foreign-key" minOccurs="0"/> </sequence> </choice> </sequence> </choice> <choice> <sequence> <element name="column" type="{http://xmlns.jcp.org/xml/ns/persistence/orm}column" minOccurs="0"/> <choice> <element name="temporal" type="{http://xmlns.jcp.org/xml/ns/persistence/orm}temporal" minOccurs="0"/> <element name="enumerated" type="{http://xmlns.jcp.org/xml/ns/persistence/orm}enumerated" minOccurs="0"/> <element name="lob" type="{http://xmlns.jcp.org/xml/ns/persistence/orm}lob" minOccurs="0"/> </choice> </sequence> <sequence> <element name="attribute-override" type="{http://xmlns.jcp.org/xml/ns/persistence/orm}attribute-override" maxOccurs="unbounded" minOccurs="0"/> <element name="association-override" type="{http://xmlns.jcp.org/xml/ns/persistence/orm}association-override" maxOccurs="unbounded" minOccurs="0"/> <element name="convert" type="{http://xmlns.jcp.org/xml/ns/persistence/orm}convert" maxOccurs="unbounded" minOccurs="0"/> </sequence> </choice> <element name="collection-table" type="{http://xmlns.jcp.org/xml/ns/persistence/orm}collection-table" minOccurs="0"/> </sequence> <attribute name="name" use="required" type="{http://www.w3.org/2001/XMLSchema}string" /> <attribute name="target-class" type="{http://www.w3.org/2001/XMLSchema}string" /> <attribute name="fetch" type="{http://xmlns.jcp.org/xml/ns/persistence/orm}fetch-type" /> <attribute name="access" type="{http://xmlns.jcp.org/xml/ns/persistence/orm}access-type" /> </restriction> </complexContent> </complexType> </pre>

Field Summary

Fields
Modifier and Type	Field and Description
`protected AccessType`	`access`
`protected List<AssociationOverride>`	`associationOverride`
`protected List<AttributeOverride>`	`attributeOverride`
`protected CollectionTable`	`collectionTable`
`protected Column`	`column`
`protected List<Convert>`	`convert`
`protected EnumType`	`enumerated`
`protected FetchType`	`fetch`
`protected Lob`	`lob`
`protected MapKey`	`mapKey`
`protected List<AttributeOverride>`	`mapKeyAttributeOverride`
`protected MapKeyClass`	`mapKeyClass`
`protected MapKeyColumn`	`mapKeyColumn`
`protected List<Convert>`	`mapKeyConvert`
`protected EnumType`	`mapKeyEnumerated`
`protected ForeignKey`	`mapKeyForeignKey`
`protected List<MapKeyJoinColumn>`	`mapKeyJoinColumn`
`protected TemporalType`	`mapKeyTemporal`
`protected String`	`name`
`protected String`	`orderBy`
`protected OrderColumn`	`orderColumn`
`protected String`	`targetClass`
`protected TemporalType`	`temporal`

Constructor Summary

Constructors
Constructor and Description

ElementCollection()

Constructors
Constructor and Description
`ElementCollection()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AccessType`	`getAccess()` Gets the value of the access property.
`List<AssociationOverride>`	`getAssociationOverride()` Gets the value of the associationOverride property.
`List<AttributeOverride>`	`getAttributeOverride()` Gets the value of the attributeOverride property.
`CollectionTable`	`getCollectionTable()` Gets the value of the collectionTable property.
`Column`	`getColumn()` Gets the value of the column property.
`List<Convert>`	`getConvert()` Gets the value of the convert property.
`EnumType`	`getEnumerated()` Gets the value of the enumerated property.
`FetchType`	`getFetch()` Gets the value of the fetch property.
`Lob`	`getLob()` Gets the value of the lob property.
`MapKey`	`getMapKey()` Gets the value of the mapKey property.
`List<AttributeOverride>`	`getMapKeyAttributeOverride()` Gets the value of the mapKeyAttributeOverride property.
`MapKeyClass`	`getMapKeyClass()` Gets the value of the mapKeyClass property.
`MapKeyColumn`	`getMapKeyColumn()` Gets the value of the mapKeyColumn property.
`List<Convert>`	`getMapKeyConvert()` Gets the value of the mapKeyConvert property.
`EnumType`	`getMapKeyEnumerated()` Gets the value of the mapKeyEnumerated property.
`ForeignKey`	`getMapKeyForeignKey()` Gets the value of the mapKeyForeignKey property.
`List<MapKeyJoinColumn>`	`getMapKeyJoinColumn()` Gets the value of the mapKeyJoinColumn property.
`TemporalType`	`getMapKeyTemporal()` Gets the value of the mapKeyTemporal property.
`String`	`getName()` Gets the value of the name property.
`String`	`getOrderBy()` Gets the value of the orderBy property.
`OrderColumn`	`getOrderColumn()` Gets the value of the orderColumn property.
`String`	`getTargetClass()` Gets the value of the targetClass property.
`TemporalType`	`getTemporal()` Gets the value of the temporal property.
`void`	`setAccess(AccessType value)` Sets the value of the access property.
`void`	`setCollectionTable(CollectionTable value)` Sets the value of the collectionTable property.
`void`	`setColumn(Column value)` Sets the value of the column property.
`void`	`setEnumerated(EnumType value)` Sets the value of the enumerated property.
`void`	`setFetch(FetchType value)` Sets the value of the fetch property.
`void`	`setLob(Lob value)` Sets the value of the lob property.
`void`	`setMapKey(MapKey value)` Sets the value of the mapKey property.
`void`	`setMapKeyClass(MapKeyClass value)` Sets the value of the mapKeyClass property.
`void`	`setMapKeyColumn(MapKeyColumn value)` Sets the value of the mapKeyColumn property.
`void`	`setMapKeyEnumerated(EnumType value)` Sets the value of the mapKeyEnumerated property.
`void`	`setMapKeyForeignKey(ForeignKey value)` Sets the value of the mapKeyForeignKey property.
`void`	`setMapKeyTemporal(TemporalType value)` Sets the value of the mapKeyTemporal property.
`void`	`setName(String value)` Sets the value of the name property.
`void`	`setOrderBy(String value)` Sets the value of the orderBy property.
`void`	`setOrderColumn(OrderColumn value)` Sets the value of the orderColumn property.
`void`	`setTargetClass(String value)` Sets the value of the targetClass property.
`void`	`setTemporal(TemporalType value)` Sets the value of the temporal property.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
 - orderBy
```
protected String orderBy
```
 - orderColumn
```
protected OrderColumn orderColumn
```
 - mapKey
```
protected MapKey mapKey
```
 - mapKeyClass
```
protected MapKeyClass mapKeyClass
```
 - mapKeyTemporal
```
protected TemporalType mapKeyTemporal
```
 - mapKeyEnumerated
```
protected EnumType mapKeyEnumerated
```
 - mapKeyAttributeOverride
```
protected List<AttributeOverride> mapKeyAttributeOverride
```
 - mapKeyConvert
```
protected List<Convert> mapKeyConvert
```
 - mapKeyColumn
```
protected MapKeyColumn mapKeyColumn
```
 - mapKeyJoinColumn
```
protected List<MapKeyJoinColumn> mapKeyJoinColumn
```
 - mapKeyForeignKey
```
protected ForeignKey mapKeyForeignKey
```
 - column
```
protected Column column
```
 - temporal
```
protected TemporalType temporal
```
 - enumerated
```
protected EnumType enumerated
```
 - lob
```
protected Lob lob
```
 - attributeOverride
```
protected List<AttributeOverride> attributeOverride
```
 - associationOverride
```
protected List<AssociationOverride> associationOverride
```
 - convert
```
protected List<Convert> convert
```
 - collectionTable
```
protected CollectionTable collectionTable
```
 - name
```
protected String name
```
 - targetClass
```
protected String targetClass
```
 - fetch
```
protected FetchType fetch
```
 - access
```
protected AccessType access
```
- Constructor Detail
 - ElementCollection
```
public ElementCollection()
```
- Method Detail
 - getOrderBy
```
public String getOrderBy()
```
 Gets the value of the orderBy property.
 
 Returns:
 
 possible object is String
 - setOrderBy
```
public void setOrderBy(String value)
```
 Sets the value of the orderBy property.
 
 Parameters:
 
 value - allowed object is String
 - getOrderColumn
```
public OrderColumn getOrderColumn()
```
 Gets the value of the orderColumn property.
 
 Returns:
 
 possible object is OrderColumn
 - setOrderColumn
```
public void setOrderColumn(OrderColumn value)
```
 Sets the value of the orderColumn property.
 
 Parameters:
 
 value - allowed object is OrderColumn
 - getMapKey
```
public MapKey getMapKey()
```
 Gets the value of the mapKey property.
 
 Returns:
 
 possible object is MapKey
 - setMapKey
```
public void setMapKey(MapKey value)
```
 Sets the value of the mapKey property.
 
 Parameters:
 
 value - allowed object is MapKey
 - getMapKeyClass
```
public MapKeyClass getMapKeyClass()
```
 Gets the value of the mapKeyClass property.
 
 Returns:
 
 possible object is MapKeyClass
 - setMapKeyClass
```
public void setMapKeyClass(MapKeyClass value)
```
 Sets the value of the mapKeyClass property.
 
 Parameters:
 
 value - allowed object is MapKeyClass
 - getMapKeyTemporal
```
public TemporalType getMapKeyTemporal()
```
 Gets the value of the mapKeyTemporal property.
 
 Returns:
 
 possible object is TemporalType
 - setMapKeyTemporal
```
public void setMapKeyTemporal(TemporalType value)
```
 Sets the value of the mapKeyTemporal property.
 
 Parameters:
 
 value - allowed object is TemporalType
 - getMapKeyEnumerated
```
public EnumType getMapKeyEnumerated()
```
 Gets the value of the mapKeyEnumerated property.
 
 Returns:
 
 possible object is EnumType
 - setMapKeyEnumerated
```
public void setMapKeyEnumerated(EnumType value)
```
 Sets the value of the mapKeyEnumerated property.
 
 Parameters:
 
 value - allowed object is EnumType
 - getMapKeyAttributeOverride
```
public List<AttributeOverride> getMapKeyAttributeOverride()
```
 Gets the value of the mapKeyAttributeOverride property.
 
 This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a <CODE>set</CODE> method for the mapKeyAttributeOverride property.
 
 For example, to add a new item, do as follows: <pre> getMapKeyAttributeOverride().add(newItem); </pre>
 
 Objects of the following type(s) are allowed in the list AttributeOverride
 - getMapKeyConvert
```
public List<Convert> getMapKeyConvert()
```
 Gets the value of the mapKeyConvert property.
 
 This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a <CODE>set</CODE> method for the mapKeyConvert property.
 
 For example, to add a new item, do as follows: <pre> getMapKeyConvert().add(newItem); </pre>
 
 Objects of the following type(s) are allowed in the list Convert
 - getMapKeyColumn
```
public MapKeyColumn getMapKeyColumn()
```
 Gets the value of the mapKeyColumn property.
 
 Returns:
 
 possible object is MapKeyColumn
 - setMapKeyColumn
```
public void setMapKeyColumn(MapKeyColumn value)
```
 Sets the value of the mapKeyColumn property.
 
 Parameters:
 
 value - allowed object is MapKeyColumn
 - getMapKeyJoinColumn
```
public List<MapKeyJoinColumn> getMapKeyJoinColumn()
```
 Gets the value of the mapKeyJoinColumn property.
 
 This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a <CODE>set</CODE> method for the mapKeyJoinColumn property.
 
 For example, to add a new item, do as follows: <pre> getMapKeyJoinColumn().add(newItem); </pre>
 
 Objects of the following type(s) are allowed in the list MapKeyJoinColumn
 - getMapKeyForeignKey
```
public ForeignKey getMapKeyForeignKey()
```
 Gets the value of the mapKeyForeignKey property.
 
 Returns:
 
 possible object is ForeignKey
 - setMapKeyForeignKey
```
public void setMapKeyForeignKey(ForeignKey value)
```
 Sets the value of the mapKeyForeignKey property.
 
 Parameters:
 
 value - allowed object is ForeignKey
 - getColumn
```
public Column getColumn()
```
 Gets the value of the column property.
 
 Returns:
 
 possible object is Column
 - setColumn
```
public void setColumn(Column value)
```
 Sets the value of the column property.
 
 Parameters:
 
 value - allowed object is Column
 - getTemporal
```
public TemporalType getTemporal()
```
 Gets the value of the temporal property.
 
 Returns:
 
 possible object is TemporalType
 - setTemporal
```
public void setTemporal(TemporalType value)
```
 Sets the value of the temporal property.
 
 Parameters:
 
 value - allowed object is TemporalType
 - getEnumerated
```
public EnumType getEnumerated()
```
 Gets the value of the enumerated property.
 
 Returns:
 
 possible object is EnumType
 - setEnumerated
```
public void setEnumerated(EnumType value)
```
 Sets the value of the enumerated property.
 
 Parameters:
 
 value - allowed object is EnumType
 - getLob
```
public Lob getLob()
```
 Gets the value of the lob property.
 
 Returns:
 
 possible object is Lob
 - setLob
```
public void setLob(Lob value)
```
 Sets the value of the lob property.
 
 Parameters:
 
 value - allowed object is Lob
 - getAttributeOverride
```
public List<AttributeOverride> getAttributeOverride()
```
 Gets the value of the attributeOverride property.
 
 This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a <CODE>set</CODE> method for the attributeOverride property.
 
 For example, to add a new item, do as follows: <pre> getAttributeOverride().add(newItem); </pre>
 
 Objects of the following type(s) are allowed in the list AttributeOverride
 - getAssociationOverride
```
public List<AssociationOverride> getAssociationOverride()
```
 Gets the value of the associationOverride property.
 
 This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a <CODE>set</CODE> method for the associationOverride property.
 
 For example, to add a new item, do as follows: <pre> getAssociationOverride().add(newItem); </pre>
 
 Objects of the following type(s) are allowed in the list AssociationOverride
 - getConvert
```
public List<Convert> getConvert()
```
 Gets the value of the convert property.
 
 This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a <CODE>set</CODE> method for the convert property.
 
 For example, to add a new item, do as follows: <pre> getConvert().add(newItem); </pre>
 
 Objects of the following type(s) are allowed in the list Convert
 - getCollectionTable
```
public CollectionTable getCollectionTable()
```
 Gets the value of the collectionTable property.
 
 Returns:
 
 possible object is CollectionTable
 - setCollectionTable
```
public void setCollectionTable(CollectionTable value)
```
 Sets the value of the collectionTable property.
 
 Parameters:
 
 value - allowed object is CollectionTable
 - getName
```
public String getName()
```
 Gets the value of the name property.
 
 Returns:
 
 possible object is String
 - setName
```
public void setName(String value)
```
 Sets the value of the name property.
 
 Parameters:
 
 value - allowed object is String
 - getTargetClass
```
public String getTargetClass()
```
 Gets the value of the targetClass property.
 
 Returns:
 
 possible object is String
 - setTargetClass
```
public void setTargetClass(String value)
```
 Sets the value of the targetClass property.
 
 Parameters:
 
 value - allowed object is String
 - getFetch
```
public FetchType getFetch()
```
 Gets the value of the fetch property.
 
 Returns:
 
 possible object is FetchType
 - setFetch
```
public void setFetch(FetchType value)
```
 Sets the value of the fetch property.
 
 Parameters:
 
 value - allowed object is FetchType
 - getAccess
```
public AccessType getAccess()
```
 Gets the value of the access property.
 
 Returns:
 
 possible object is AccessType
 - setAccess
```
public void setAccess(AccessType value)
```
 Sets the value of the access property.
 
 Parameters:
 
 value - allowed object is AccessType

Class ElementCollection

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

orderBy

orderColumn

mapKey

mapKeyClass

mapKeyTemporal

mapKeyEnumerated

mapKeyAttributeOverride

mapKeyConvert

mapKeyColumn

mapKeyJoinColumn

mapKeyForeignKey

column

temporal

enumerated

lob

attributeOverride

associationOverride

convert

collectionTable

name

targetClass

fetch

access

Constructor Detail

ElementCollection

Method Detail

getOrderBy

setOrderBy

getOrderColumn

setOrderColumn

getMapKey

setMapKey

getMapKeyClass

setMapKeyClass

getMapKeyTemporal

setMapKeyTemporal

getMapKeyEnumerated

setMapKeyEnumerated

getMapKeyAttributeOverride

getMapKeyConvert

getMapKeyColumn

setMapKeyColumn

getMapKeyJoinColumn

getMapKeyForeignKey

setMapKeyForeignKey

getColumn

setColumn

getTemporal

setTemporal

getEnumerated

setEnumerated

getLob

setLob

getAttributeOverride

getAssociationOverride

getConvert

getCollectionTable

setCollectionTable

getName

setName

getTargetClass

setTargetClass

getFetch

setFetch

getAccess

setAccess