org.springframework.roo.classpath.operations.jsr303

Class ReferenceField

java.lang.Object

org.springframework.roo.classpath.details.FieldDetails

org.springframework.roo.classpath.operations.jsr303.ReferenceField

public class ReferenceField
extends FieldDetails

Properties used by the many-to-one side of a relationship (called a "reference").

For example, an Order-LineItem link would have the LineItem contain a "reference" back to Order.

Limited support for collection mapping is provided. This reflects the pragmatic goals of ROO and the fact a user can edit the generated files by hand anyway.

This field is intended for use with JSR 220 and will create a @ManyToOne and @JoinColumn annotation.

Since:

1.0

Author:

Ben Alex

Field Summary

Fields inherited from class org.springframework.roo.classpath.details.FieldDetails

comment

Constructor Summary

Constructors

Constructor and Description
ReferenceField(String physicalTypeIdentifier, org.springframework.roo.model.JavaType fieldType, org.springframework.roo.model.JavaSymbolName fieldName, Cardinality cardinality, Cascade[] cascadeType)

Method Summary

Modifier and Type	Method and Description
void	addAdditionaAnnotation(AnnotationMetadataBuilder annotationBuilder)
void	decorateAnnotationsList(List<AnnotationMetadataBuilder> annotations)
Fetch	getFetch()
org.springframework.roo.model.JavaSymbolName	getMappedBy()
Boolean	getOrphanRemoval()
void	setFetch(Fetch fetch)
void	setJoinAnnotations(String joinTableName, String[] joinColumns, String[] referencedColumns, String[] inverseJoinColumns, String[] inverseReferencedColumns) Fill #joinTableAttributes for building @JoinTable annotation.
void	setJoinColumn(String joinColumn) Add @JoinColumn annotation to field
void	setJoinColumn(String joinColumn, String referencedColumn) Add @JoinColumn annotation to field
void	setMappedBy(org.springframework.roo.model.JavaSymbolName mappedBy)
void	setOrphanRemoval(Boolean orphanRemoval)

Methods inherited from class org.springframework.roo.classpath.details.FieldDetails

addAnnotations, getAnnotations, getColumn, getComment, getFieldName, getFieldType, getInitedAnnotations, getModifiers, getPhysicalTypeIdentifier, getValue, isNotNull, isNullRequired, isUnique, setAnnotations, setColumn, setComment, setModifiers, setNotNull, setNullRequired, setUnique, setValue

Methods inherited from class java.lang.Object

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

Constructor Detail

ReferenceField

public ReferenceField(String physicalTypeIdentifier,
                      org.springframework.roo.model.JavaType fieldType,
                      org.springframework.roo.model.JavaSymbolName fieldName,
                      Cardinality cardinality,
                      Cascade[] cascadeType)

Method Detail

decorateAnnotationsList

public void decorateAnnotationsList(List<AnnotationMetadataBuilder> annotations)

Overrides:

decorateAnnotationsList in class FieldDetails

getFetch

public Fetch getFetch()

getMappedBy

public org.springframework.roo.model.JavaSymbolName getMappedBy()

getOrphanRemoval

public Boolean getOrphanRemoval()

setFetch

public void setFetch(Fetch fetch)

setOrphanRemoval

public void setOrphanRemoval(Boolean orphanRemoval)

setMappedBy

public void setMappedBy(org.springframework.roo.model.JavaSymbolName mappedBy)

setJoinColumn

public void setJoinColumn(String joinColumn,
                          String referencedColumn)

Add @JoinColumn annotation to field

Parameters:

joinColumn -

referencedColumn -

setJoinColumn

public void setJoinColumn(String joinColumn)

Add @JoinColumn annotation to field

Parameters:

joinColumn -

addAdditionaAnnotation

public void addAdditionaAnnotation(AnnotationMetadataBuilder annotationBuilder)

setJoinAnnotations

public void setJoinAnnotations(String joinTableName,
                               String[] joinColumns,
                               String[] referencedColumns,
                               String[] inverseJoinColumns,
                               String[] inverseReferencedColumns)

Fill #joinTableAttributes for building @JoinTable annotation. The annotation would have some nested @JoinColumn annotations in each of its "joinColumns" and "inverseJoinColumns" attributes.

Parameters:

joinTableName -

joinColumns -

referencedColumns -

inverseJoinColumns -

inverseReferencedColumns -