ManyToMany (TomEE :: Container :: Java EE 8.0.6 API)

java.lang.Object
- org.apache.openejb.jee.jpa.ManyToMany

All Implemented Interfaces:: RelationField, Keyable

public class ManyToMany
extends Object
implements RelationField

Target({METHOD, FIELD}) @Retention(RUNTIME) public @interface ManyToMany { Class targetEntity() default void.class; CascadeType[] cascade() default {}; FetchType fetch() default LAZY; String mappedBy() default ""; }

Java class for many-to-many complex type.

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

 <complexType name="many-to-many">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <choice>
           <element name="order-by" type="{http://java.sun.com/xml/ns/persistence/orm}order-by" minOccurs="0"/>
           <element name="order-column" type="{http://java.sun.com/xml/ns/persistence/orm}order-column" minOccurs="0"/>
         </choice>
         <choice>
           <element name="map-key" type="{http://java.sun.com/xml/ns/persistence/orm}map-key" minOccurs="0"/>
           <sequence>
             <element name="map-key-class" type="{http://java.sun.com/xml/ns/persistence/orm}map-key-class" minOccurs="0"/>
             <choice>
               <element name="map-key-temporal" type="{http://java.sun.com/xml/ns/persistence/orm}temporal" minOccurs="0"/>
               <element name="map-key-enumerated" type="{http://java.sun.com/xml/ns/persistence/orm}enumerated" minOccurs="0"/>
               <element name="map-key-attribute-override" type="{http://java.sun.com/xml/ns/persistence/orm}attribute-override" maxOccurs="unbounded" minOccurs="0"/>
             </choice>
             <choice>
               <element name="map-key-column" type="{http://java.sun.com/xml/ns/persistence/orm}map-key-column" minOccurs="0"/>
               <element name="map-key-join-column" type="{http://java.sun.com/xml/ns/persistence/orm}map-key-join-column" maxOccurs="unbounded" minOccurs="0"/>
             </choice>
           </sequence>
         </choice>
         <element name="join-table" type="{http://java.sun.com/xml/ns/persistence/orm}join-table" minOccurs="0"/>
         <element name="cascade" type="{http://java.sun.com/xml/ns/persistence/orm}cascade-type" minOccurs="0"/>
       </sequence>
       <attribute name="name" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="target-entity" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="fetch" type="{http://java.sun.com/xml/ns/persistence/orm}fetch-type" />
       <attribute name="access" type="{http://java.sun.com/xml/ns/persistence/orm}access-type" />
       <attribute name="mapped-by" type="{http://www.w3.org/2001/XMLSchema}string" />
     </restriction>
   </complexContent>
 </complexType>

Field Summary

Fields
Modifier and Type	Field and Description
`protected AccessType`	`access`
`protected CascadeType`	`cascade`
`protected FetchType`	`fetch`
`protected JoinTable`	`joinTable`
`protected MapKey`	`mapKey`
`protected List<AttributeOverride>`	`mapKeyAttributeOverride`
`protected MapKeyClass`	`mapKeyClass`
`protected MapKeyColumn`	`mapKeyColumn`
`protected EnumType`	`mapKeyEnumerated`
`protected List<MapKeyJoinColumn>`	`mapKeyJoinColumn`
`protected TemporalType`	`mapKeyTemporal`
`protected String`	`mappedBy`
`protected String`	`name`
`protected String`	`orderBy`
`protected OrderColumn`	`orderColumn`
`protected RelationField`	`relatedField`
`protected boolean`	`syntheticField`
`protected String`	`targetEntity`

Constructor Summary

Constructors
Constructor and Description

ManyToMany()

Constructors
Constructor and Description
`ManyToMany()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AccessType`	`getAccess()` Gets the value of the access property.
`CascadeType`	`getCascade()` Gets the value of the cascade property.
`FetchType`	`getFetch()` Gets the value of the fetch property.
`List<JoinColumn>`	`getJoinColumn()`
`JoinTable`	`getJoinTable()` Gets the value of the joinTable property.
`Object`	`getKey()` Gets the immutable key for this object.
`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.
`EnumType`	`getMapKeyEnumerated()` Gets the value of the mapKeyEnumerated property.
`List<MapKeyJoinColumn>`	`getMapKeyJoinColumn()` Gets the value of the mapKeyJoinColumn property.
`TemporalType`	`getMapKeyTemporal()` Gets the value of the mapKeyTemporal property.
`String`	`getMappedBy()` Gets the value of the mappedBy 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.
`RelationField`	`getRelatedField()` This is only used for xml converters and will normally return null.
`String`	`getTargetEntity()` Gets the value of the targetEntity property.
`boolean`	`isSyntheticField()` This is only used for xml converters and will normally return false.
`void`	`setAccess(AccessType value)` Sets the value of the access property.
`void`	`setCascade(CascadeType value)` Sets the value of the cascade property.
`void`	`setFetch(FetchType value)` Sets the value of the fetch property.
`void`	`setJoinTable(JoinTable value)` Sets the value of the joinTable 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`	`setMapKeyTemporal(TemporalType value)` Sets the value of the mapKeyTemporal property.
`void`	`setMappedBy(String value)` Sets the value of the mappedBy 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`	`setRelatedField(RelationField value)` Gets the field on the target entity for this relationship.
`void`	`setSyntheticField(boolean syntheticField)` This is only used for xml converters and will normally return false.
`void`	`setTargetEntity(String value)` Sets the value of the targetEntity 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
```
  - mapKeyColumn
```
protected MapKeyColumn mapKeyColumn
```
  - mapKeyJoinColumn
```
protected List<MapKeyJoinColumn> mapKeyJoinColumn
```
  - joinTable
```
protected JoinTable joinTable
```
  - cascade
```
protected CascadeType cascade
```
  - fetch
```
protected FetchType fetch
```
  - access
```
protected AccessType access
```
  - mappedBy
```
protected String mappedBy
```
  - name
```
protected String name
```
  - targetEntity
```
protected String targetEntity
```
  - relatedField
```
protected RelationField relatedField
```
  - syntheticField
```
protected boolean syntheticField
```
- Constructor Detail
  - ManyToMany
```
public ManyToMany()
```
- 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 set method for the mapKeyAttributeOverride property. For example, to add a new item, do as follows:
```
    getMapKeyAttributeOverride().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list AttributeOverride
  - 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 set method for the mapKeyJoinColumn property. For example, to add a new item, do as follows:
```
    getMapKeyJoinColumn().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list MapKeyJoinColumn
  - getJoinTable
```
public JoinTable getJoinTable()
```
    Gets the value of the joinTable property.
    
    Specified by:
    
    getJoinTable in interface RelationField
    
    Returns:
    
    possible object is JoinTable
  - setJoinTable
```
public void setJoinTable(JoinTable value)
```
    Sets the value of the joinTable property.
    
    Specified by:
    
    setJoinTable in interface RelationField
    
    Parameters:
    
    value - allowed object is JoinTable
  - getCascade
```
public CascadeType getCascade()
```
    Gets the value of the cascade property.
    
    Specified by:
    
    getCascade in interface RelationField
    
    Returns:
    
    possible object is CascadeType
  - setCascade
```
public void setCascade(CascadeType value)
```
    Sets the value of the cascade property.
    
    Specified by:
    
    setCascade in interface RelationField
    
    Parameters:
    
    value - allowed object is CascadeType
  - getFetch
```
public FetchType getFetch()
```
    Gets the value of the fetch property.
    
    Specified by:
    
    getFetch in interface RelationField
    
    Returns:
    
    possible object is FetchType
  - setFetch
```
public void setFetch(FetchType value)
```
    Sets the value of the fetch property.
    
    Specified by:
    
    setFetch in interface RelationField
    
    Parameters:
    
    value - allowed object is FetchType
  - getMappedBy
```
public String getMappedBy()
```
    Gets the value of the mappedBy property.
    
    Specified by:
    
    getMappedBy in interface RelationField
    
    Returns:
    
    possible object is String
  - setMappedBy
```
public void setMappedBy(String value)
```
    Sets the value of the mappedBy property.
    
    Specified by:
    
    setMappedBy in interface RelationField
    
    Parameters:
    
    value - allowed object is String
  - getName
```
public String getName()
```
    Gets the value of the name property.
    
    Specified by:
    
    getName in interface RelationField
    
    Returns:
    
    possible object is String
  - setName
```
public void setName(String value)
```
    Sets the value of the name property.
    
    Specified by:
    
    setName in interface RelationField
    
    Parameters:
    
    value - allowed object is String
  - 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
  - getTargetEntity
```
public String getTargetEntity()
```
    Gets the value of the targetEntity property.
    
    Specified by:
    
    getTargetEntity in interface RelationField
    
    Returns:
    
    possible object is String
  - setTargetEntity
```
public void setTargetEntity(String value)
```
    Sets the value of the targetEntity property.
    
    Specified by:
    
    setTargetEntity in interface RelationField
    
    Parameters:
    
    value - allowed object is String
  - getJoinColumn
```
public List<JoinColumn> getJoinColumn()
```
    Specified by:
    
    getJoinColumn in interface RelationField
  - getRelatedField
```
public RelationField getRelatedField()
```
    This is only used for xml converters and will normally return null. Gets the field on the target entity for this relationship.
    
    Specified by:
    
    getRelatedField in interface RelationField
    
    Returns:
    
    the field on the target entity for this relationship.
  - setRelatedField
```
public void setRelatedField(RelationField value)
```
    Gets the field on the target entity for this relationship.
    
    Specified by:
    
    setRelatedField in interface RelationField
    
    Parameters:
    
    value - field on the target entity for this relationship.
  - isSyntheticField
```
public boolean isSyntheticField()
```
    This is only used for xml converters and will normally return false. A true value indicates that this field was generated for CMR back references.
    
    Specified by:
    
    isSyntheticField in interface RelationField
    
    Returns:
    
    true if this field was generated for CMR back references.
  - setSyntheticField
```
public void setSyntheticField(boolean syntheticField)
```
    This is only used for xml converters and will normally return false. A true value indicates that this field was generated for CMR back references.
    
    Specified by:
    
    setSyntheticField in interface RelationField
  - getKey
```
public Object getKey()
```
    Description copied from interface: Keyable
    
    Gets the immutable key for this object.
    
    Specified by:
    
    getKey in interface Keyable
    
    Returns:
    
    gets the immutable key for this object

Class ManyToMany

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

orderBy

orderColumn

mapKey

mapKeyClass

mapKeyTemporal

mapKeyEnumerated

mapKeyAttributeOverride

mapKeyColumn

mapKeyJoinColumn

joinTable

cascade

fetch

access

mappedBy

name

targetEntity

relatedField

syntheticField

Constructor Detail

ManyToMany

Method Detail

getOrderBy

setOrderBy

getOrderColumn

setOrderColumn

getMapKey

setMapKey

getMapKeyClass

setMapKeyClass

getMapKeyTemporal

setMapKeyTemporal

getMapKeyEnumerated

setMapKeyEnumerated

getMapKeyAttributeOverride

getMapKeyColumn

setMapKeyColumn

getMapKeyJoinColumn

getJoinTable

setJoinTable

getCascade

setCascade

getFetch

setFetch

getMappedBy

setMappedBy

getName

setName

getAccess

setAccess

getTargetEntity

setTargetEntity

getJoinColumn

getRelatedField

setRelatedField

isSyntheticField

setSyntheticField

getKey