Package org.apache.openejb.jee.jpa

Class 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>

    • 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

      • 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

      • 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

      • 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

      • 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