OneToOne

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

All Implemented Interfaces:: RelationField, Keyable

public class OneToOne
extends java.lang.Object
implements RelationField

Target({METHOD, FIELD}) @Retention(RUNTIME) public @interface OneToOne { Class targetEntity() default void.class; CascadeType[] cascade() default {}; FetchType fetch() default EAGER; boolean optional() default true; String mappedBy() default ""; boolean orphanRemoval() default false; }

Java class for one-to-one complex type.

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

 <complexType name="one-to-one">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <choice>
           <element name="primary-key-join-column" type="{http://java.sun.com/xml/ns/persistence/orm}primary-key-join-column" maxOccurs="unbounded" minOccurs="0"/>
           <element name="join-column" type="{http://java.sun.com/xml/ns/persistence/orm}join-column" maxOccurs="unbounded" minOccurs="0"/>
           <element name="join-table" type="{http://java.sun.com/xml/ns/persistence/orm}join-table" minOccurs="0"/>
         </choice>
         <element name="cascade" type="{http://java.sun.com/xml/ns/persistence/orm}cascade-type" minOccurs="0"/>
       </sequence>
       <attribute name="fetch" type="{http://java.sun.com/xml/ns/persistence/orm}fetch-type" />
       <attribute name="mapped-by" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="name" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="optional" type="{http://www.w3.org/2001/XMLSchema}boolean" />
       <attribute name="target-entity" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="access" type="{http://java.sun.com/xml/ns/persistence/orm}access-type" />
       <attribute name="orphan-removal" type="{http://www.w3.org/2001/XMLSchema}boolean" />
       <attribute name="maps-id" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="id" type="{http://www.w3.org/2001/XMLSchema}boolean" />
     </restriction>
   </complexContent>
 </complexType>

Field Summary

Fields
Modifier and Type	Field and Description
`protected AccessType`	`access`
`protected CascadeType`	`cascade`
`protected FetchType`	`fetch`
`protected java.lang.Boolean`	`id`
`protected java.util.List<JoinColumn>`	`joinColumn`
`protected JoinTable`	`joinTable`
`protected java.lang.String`	`mappedBy`
`protected java.lang.String`	`mapsId`
`protected java.lang.String`	`name`
`protected java.lang.Boolean`	`optional`
`protected java.lang.Boolean`	`orphanRemoval`
`protected java.util.List<PrimaryKeyJoinColumn>`	`primaryKeyJoinColumn`
`protected RelationField`	`relatedField`
`protected boolean`	`syntheticField`
`protected java.lang.String`	`targetEntity`

Constructor Summary

Constructors
Constructor and Description

OneToOne()

Constructors
Constructor and Description
`OneToOne()`

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.
`java.util.List<JoinColumn>`	`getJoinColumn()` Gets the value of the joinColumn property.
`JoinTable`	`getJoinTable()` Gets the value of the joinTable property.
`java.lang.Object`	`getKey()` Gets the immutable key for this object.
`java.lang.String`	`getMappedBy()` Gets the value of the mappedBy property.
`java.lang.String`	`getMapsId()` Gets the value of the mapsId property.
`java.lang.String`	`getName()` Gets the value of the name property.
`java.util.List<PrimaryKeyJoinColumn>`	`getPrimaryKeyJoinColumn()` Gets the value of the primaryKeyJoinColumn property.
`RelationField`	`getRelatedField()` This is only used for xml converters and will normally return null.
`java.lang.String`	`getTargetEntity()` Gets the value of the targetEntity property.
`java.lang.Boolean`	`isId()` Gets the value of the id property.
`java.lang.Boolean`	`isOptional()` Gets the value of the optional property.
`java.lang.Boolean`	`isOrphanRemoval()` Gets the value of the orphanRemoval 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`	`setId(java.lang.Boolean value)` Sets the value of the id property.
`void`	`setJoinTable(JoinTable value)` Sets the value of the joinTable property.
`void`	`setMappedBy(java.lang.String value)` Sets the value of the mappedBy property.
`void`	`setMapsId(java.lang.String value)` Sets the value of the mapsId property.
`void`	`setName(java.lang.String value)` Sets the value of the name property.
`void`	`setOptional(java.lang.Boolean value)` Sets the value of the optional property.
`void`	`setOrphanRemoval(java.lang.Boolean value)` Sets the value of the orphanRemoval 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(java.lang.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
  - primaryKeyJoinColumn
```
protected java.util.List<PrimaryKeyJoinColumn> primaryKeyJoinColumn
```
  - joinColumn
```
protected java.util.List<JoinColumn> joinColumn
```
  - joinTable
```
protected JoinTable joinTable
```
  - cascade
```
protected CascadeType cascade
```
  - fetch
```
protected FetchType fetch
```
  - access
```
protected AccessType access
```
  - mappedBy
```
protected java.lang.String mappedBy
```
  - orphanRemoval
```
protected java.lang.Boolean orphanRemoval
```
  - mapsId
```
protected java.lang.String mapsId
```
  - id
```
protected java.lang.Boolean id
```
  - name
```
protected java.lang.String name
```
  - optional
```
protected java.lang.Boolean optional
```
  - targetEntity
```
protected java.lang.String targetEntity
```
  - relatedField
```
protected RelationField relatedField
```
  - syntheticField
```
protected boolean syntheticField
```
- Constructor Detail
  - OneToOne
```
public OneToOne()
```
- Method Detail
  - getPrimaryKeyJoinColumn
```
public java.util.List<PrimaryKeyJoinColumn> getPrimaryKeyJoinColumn()
```
    Gets the value of the primaryKeyJoinColumn 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 primaryKeyJoinColumn property. For example, to add a new item, do as follows:
```
    getPrimaryKeyJoinColumn().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list PrimaryKeyJoinColumn
  - getJoinColumn
```
public java.util.List<JoinColumn> getJoinColumn()
```
    Gets the value of the joinColumn 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 joinColumn property. For example, to add a new item, do as follows:
```
    getJoinColumn().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list JoinColumn
    Specified by:
    
    getJoinColumn in interface RelationField
  - 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
  - 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
  - getMappedBy
```
public java.lang.String getMappedBy()
```
    Gets the value of the mappedBy property.
    
    Specified by:
    
    getMappedBy in interface RelationField
    
    Returns:
    
    possible object is String
  - setMappedBy
```
public void setMappedBy(java.lang.String value)
```
    Sets the value of the mappedBy property.
    
    Specified by:
    
    setMappedBy in interface RelationField
    
    Parameters:
    
    value - allowed object is String
  - isOrphanRemoval
```
public java.lang.Boolean isOrphanRemoval()
```
    Gets the value of the orphanRemoval property.
    
    Returns:
    
    possible object is Boolean
  - setOrphanRemoval
```
public void setOrphanRemoval(java.lang.Boolean value)
```
    Sets the value of the orphanRemoval property.
    
    Parameters:
    
    value - allowed object is Boolean
  - getMapsId
```
public java.lang.String getMapsId()
```
    Gets the value of the mapsId property.
    
    Returns:
    
    possible object is String
  - setMapsId
```
public void setMapsId(java.lang.String value)
```
    Sets the value of the mapsId property.
    
    Parameters:
    
    value - allowed object is String
  - isId
```
public java.lang.Boolean isId()
```
    Gets the value of the id property.
    
    Returns:
    
    possible object is Boolean
  - setId
```
public void setId(java.lang.Boolean value)
```
    Sets the value of the id property.
    
    Parameters:
    
    value - allowed object is Boolean
  - getName
```
public java.lang.String getName()
```
    Gets the value of the name property.
    
    Specified by:
    
    getName in interface RelationField
    
    Returns:
    
    possible object is String
  - setName
```
public void setName(java.lang.String value)
```
    Sets the value of the name property.
    
    Specified by:
    
    setName in interface RelationField
    
    Parameters:
    
    value - allowed object is String
  - isOptional
```
public java.lang.Boolean isOptional()
```
    Gets the value of the optional property.
    
    Returns:
    
    possible object is Boolean
  - setOptional
```
public void setOptional(java.lang.Boolean value)
```
    Sets the value of the optional property.
    
    Parameters:
    
    value - allowed object is Boolean
  - getTargetEntity
```
public java.lang.String getTargetEntity()
```
    Gets the value of the targetEntity property.
    
    Specified by:
    
    getTargetEntity in interface RelationField
    
    Returns:
    
    possible object is String
  - setTargetEntity
```
public void setTargetEntity(java.lang.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()
```
    Description copied from interface: RelationField
    
    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)
```
    Description copied from interface: RelationField
    
    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 java.lang.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 OneToOne

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

primaryKeyJoinColumn

joinColumn

joinTable

cascade

fetch

access

mappedBy

orphanRemoval

mapsId

id

name

optional

targetEntity

relatedField

syntheticField

Constructor Detail

OneToOne

Method Detail

getPrimaryKeyJoinColumn

getJoinColumn

getJoinTable

setJoinTable

getCascade

setCascade

getFetch

setFetch

getAccess

setAccess

getMappedBy

setMappedBy

isOrphanRemoval

setOrphanRemoval

getMapsId

setMapsId

isId

setId

getName

setName

isOptional

setOptional

getTargetEntity

setTargetEntity

getRelatedField

setRelatedField

isSyntheticField

setSyntheticField

getKey