com.impetus.kundera.metadata.model

Class Relation

java.lang.Object

com.impetus.kundera.metadata.model.Relation

public final class Relation
extends Object

The Class Relation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Relation.ForeignKey The Enum ForeignKey.

Field Summary

Fields

Modifier and Type	Field and Description
private Field	biDirectionalField
private List<javax.persistence.CascadeType>	cascades The cascades.
private javax.persistence.FetchType	fetchType The fetch type.
private boolean	isJoinedByPrimaryKey Whether this relationship is joined by primary key, only applicable for OneToOne.
private boolean	isRelatedViaJoinTable Whether this relationship is through a Join Table.
private String	joinColumnName Join column name for this relationship.
private JoinTableMetadata	joinTableMetadata Metadata for JoinTable, applicable only if isRelatedViaJoinTable==true.
private Class<?>	mapKeyJoinClass If relation is through a Map, Map Key Join Class
private String	mappedBy The mapped by.
private boolean	optional The optional.
private Field	property The property.
private Class<?>	propertyType The property type.
private Class<?>	targetEntity The target entity.
private EntityMetadata	targetEntityMetadata Target entity metadata.
private Relation.ForeignKey	type The type.

Constructor Summary

Constructors

Constructor and Description
Relation(Field property, Class<?> targetEntity, Class<?> propertyType, javax.persistence.FetchType fetchType, List<javax.persistence.CascadeType> cascades, boolean optional, String mappedBy, Relation.ForeignKey type) Specifies the type of the metadata.

Method Summary

Methods

Modifier and Type	Method and Description
Field	getBiDirectionalField()
List<javax.persistence.CascadeType>	getCascades() Gets the cascades.
javax.persistence.FetchType	getFetchType() Gets the fetch type.
String	getJoinColumnName(EntityManagerFactoryImpl.KunderaMetadata kunderaMetadata) Gets the join column name.
JoinTableMetadata	getJoinTableMetadata() Gets the join table metadata.
Class<?>	getMapKeyJoinClass()
String	getMappedBy() Gets the mapped by.
Field	getProperty() Gets the property.
Class<?>	getPropertyType() Gets the property type.
Class<?>	getTargetEntity() Gets the target entity.
Relation.ForeignKey	getType() Gets the type.
boolean	isBiDirectional()
boolean	isCollection() Checks if is collection.
boolean	isJoinedByPrimaryKey() Checks if is joined by primary key.
boolean	isOptional() Checks if is optional.
boolean	isRelatedViaJoinTable() Checks if is related via join table.
boolean	isUnary() Checks if is unary.
void	setBiDirectionalField(Class referencedClass)
void	setJoinColumnName(String joinColumnName) Sets the join column name.
void	setJoinedByPrimaryKey(boolean isJoinedByPrimaryKey) Sets the joined by primary key.
void	setJoinTableMetadata(JoinTableMetadata joinTableMetadata) Sets the join table metadata.
void	setMapKeyJoinClass(Class<?> mapKeyJoinClass)
void	setRelatedViaJoinTable(boolean isRelatedViaJoinTable) Sets the related via join table.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

property

private Field property

The property.

targetEntity

private Class<?> targetEntity

The target entity.

mapKeyJoinClass

private Class<?> mapKeyJoinClass

If relation is through a Map, Map Key Join Class

propertyType

private Class<?> propertyType

The property type.

fetchType

private javax.persistence.FetchType fetchType

The fetch type.

cascades

private List<javax.persistence.CascadeType> cascades

The cascades.

optional

private boolean optional

The optional.

mappedBy

private String mappedBy

The mapped by.

type

private Relation.ForeignKey type

The type.

joinColumnName

private String joinColumnName

Join column name for this relationship.

isRelatedViaJoinTable

private boolean isRelatedViaJoinTable

Whether this relationship is through a Join Table.

joinTableMetadata

private JoinTableMetadata joinTableMetadata

Metadata for JoinTable, applicable only if isRelatedViaJoinTable==true.

targetEntityMetadata

private EntityMetadata targetEntityMetadata

Target entity metadata.

isJoinedByPrimaryKey

private boolean isJoinedByPrimaryKey

Whether this relationship is joined by primary key, only applicable for OneToOne.

biDirectionalField

private Field biDirectionalField

Constructor Detail

Relation

public Relation(Field property,
        Class<?> targetEntity,
        Class<?> propertyType,
        javax.persistence.FetchType fetchType,
        List<javax.persistence.CascadeType> cascades,
        boolean optional,
        String mappedBy,
        Relation.ForeignKey type)

Specifies the type of the metadata.

Method Detail

getProperty

public Field getProperty()

Gets the property.

Returns:

the property

getTargetEntity

public Class<?> getTargetEntity()

Gets the target entity.

Returns:

the targetEntity

getMapKeyJoinClass

public Class<?> getMapKeyJoinClass()

Returns:

the mapKeyJoinClass

setMapKeyJoinClass

public void setMapKeyJoinClass(Class<?> mapKeyJoinClass)

Parameters:

mapKeyJoinClass - the mapKeyJoinClass to set

getPropertyType

public Class<?> getPropertyType()

Gets the property type.

Returns:

the propertyType

getFetchType

public javax.persistence.FetchType getFetchType()

Gets the fetch type.

Returns:

the fetchType

getCascades

public List<javax.persistence.CascadeType> getCascades()

Gets the cascades.

Returns:

the cascades

isOptional

public boolean isOptional()

Checks if is optional.

Returns:

the optional

getMappedBy

public String getMappedBy()

Gets the mapped by.

Returns:

the mappedBy

getType

public Relation.ForeignKey getType()

Gets the type.

Returns:

the type

getJoinColumnName

public String getJoinColumnName(EntityManagerFactoryImpl.KunderaMetadata kunderaMetadata)

Gets the join column name.

Returns:

the joinColumnName

setJoinColumnName

public void setJoinColumnName(String joinColumnName)

Sets the join column name.

Parameters:

joinColumnName - the joinColumnName to set

isRelatedViaJoinTable

public boolean isRelatedViaJoinTable()

Checks if is related via join table.

Returns:

the isRelatedViaJoinTable

setRelatedViaJoinTable

public void setRelatedViaJoinTable(boolean isRelatedViaJoinTable)

Sets the related via join table.

Parameters:

isRelatedViaJoinTable - the isRelatedViaJoinTable to set

getJoinTableMetadata

public JoinTableMetadata getJoinTableMetadata()

Gets the join table metadata.

Returns:

the joinTableMetadata

setJoinTableMetadata

public void setJoinTableMetadata(JoinTableMetadata joinTableMetadata)

Sets the join table metadata.

Parameters:

joinTableMetadata - the joinTableMetadata to set

isJoinedByPrimaryKey

public boolean isJoinedByPrimaryKey()

Checks if is joined by primary key.

Returns:

the isJoinedByPrimaryKey

setJoinedByPrimaryKey

public void setJoinedByPrimaryKey(boolean isJoinedByPrimaryKey)

Sets the joined by primary key.

Parameters:

isJoinedByPrimaryKey - the isJoinedByPrimaryKey to set

isUnary

public boolean isUnary()

Checks if is unary.

Returns:

true, if is unary

isCollection

public boolean isCollection()

Checks if is collection.

Returns:

true, if is collection

isBiDirectional

public boolean isBiDirectional()

getBiDirectionalField

public Field getBiDirectionalField()

setBiDirectionalField

public void setBiDirectionalField(Class referencedClass)