Package org.apache.openejb.jee.jpa

Class Id

java.lang.Object

org.apache.openejb.jee.jpa.Id

All Implemented Interfaces:

Field, Keyable

public class Id
extends Object
implements Field

Target({METHOD, FIELD}) @Retention(RUNTIME) public @interface Id {}

Java class for id complex type.

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

 <complexType name="id">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="column" type="{http://java.sun.com/xml/ns/persistence/orm}column" minOccurs="0"/>
         <element name="generated-value" type="{http://java.sun.com/xml/ns/persistence/orm}generated-value" minOccurs="0"/>
         <element name="temporal" type="{http://java.sun.com/xml/ns/persistence/orm}temporal" minOccurs="0"/>
         <element name="table-generator" type="{http://java.sun.com/xml/ns/persistence/orm}table-generator" minOccurs="0"/>
         <element name="sequence-generator" type="{http://java.sun.com/xml/ns/persistence/orm}sequence-generator" minOccurs="0"/>
       </sequence>
       <attribute name="name" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="access" type="{http://java.sun.com/xml/ns/persistence/orm}access-type" />
     </restriction>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field	Description
protected AccessType	access
protected Column	column
protected GeneratedValue	generatedValue
protected String	name
protected SequenceGenerator	sequenceGenerator
protected TableGenerator	tableGenerator
protected TemporalType	temporal

Constructor Summary

Constructors

Constructor	Description
Id()
Id(String name)
Id(String name, String columnName)

Method Summary

Modifier and Type	Method	Description
AccessType	getAccess()	Gets the value of the access property.
Column	getColumn()	Gets the value of the column property.
GeneratedValue	getGeneratedValue()	Gets the value of the generatedValue property.
Object	getKey()	Gets the immutable key for this object.
String	getName()	Gets the value of the name property.
SequenceGenerator	getSequenceGenerator()	Gets the value of the sequenceGenerator property.
TableGenerator	getTableGenerator()	Gets the value of the tableGenerator property.
TemporalType	getTemporal()	Gets the value of the temporal property.
void	setAccess(AccessType value)	Sets the value of the access property.
void	setColumn(Column value)	Sets the value of the column property.
void	setGeneratedValue(GeneratedValue value)	Sets the value of the generatedValue property.
void	setName(String value)	Sets the value of the name property.
void	setSequenceGenerator(SequenceGenerator value)	Sets the value of the sequenceGenerator property.
void	setTableGenerator(TableGenerator value)	Sets the value of the tableGenerator 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

column

protected Column column

generatedValue

protected GeneratedValue generatedValue

temporal

protected TemporalType temporal

tableGenerator

protected TableGenerator tableGenerator

sequenceGenerator

protected SequenceGenerator sequenceGenerator

name

protected String name

access

protected AccessType access

Constructor Detail

Id

public Id()

Id

public Id(String name)

Id

public Id(String name,
          String columnName)

Method Detail

getColumn

public Column getColumn()

Gets the value of the column property.

Specified by:

getColumn in interface Field

Returns:

possible object is Column

setColumn

public void setColumn(Column value)

Sets the value of the column property.

Specified by:

setColumn in interface Field

Parameters:

value - allowed object is Column

getGeneratedValue

public GeneratedValue getGeneratedValue()

Gets the value of the generatedValue property.

Returns:

possible object is GeneratedValue

setGeneratedValue

public void setGeneratedValue(GeneratedValue value)

Sets the value of the generatedValue property.

Parameters:

value - allowed object is GeneratedValue

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

getTableGenerator

public TableGenerator getTableGenerator()

Gets the value of the tableGenerator property.

Returns:

possible object is TableGenerator

setTableGenerator

public void setTableGenerator(TableGenerator value)

Sets the value of the tableGenerator property.

Parameters:

value - allowed object is TableGenerator

getSequenceGenerator

public SequenceGenerator getSequenceGenerator()

Gets the value of the sequenceGenerator property.

Returns:

possible object is SequenceGenerator

setSequenceGenerator

public void setSequenceGenerator(SequenceGenerator value)

Sets the value of the sequenceGenerator property.

Parameters:

value - allowed object is SequenceGenerator

getName

public String getName()

Gets the value of the name property.

Specified by:

getName in interface Field

Returns:

possible object is String

setName

public void setName(String value)

Sets the value of the name property.

Specified by:

setName in interface Field

Parameters:

value - allowed object is String

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

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