org.jtransfo

Annotation Type MappedBy

@Retention(value=RUNTIME)
 @Target(value={FIELD,ANNOTATION_TYPE})
 @Documented
public @interface MappedBy

Annotation which indicates how the field in the transfer object should be mapped to a field in the domain object.

By default fields are mapped in both directions between fields of the same name.

Field Summary

Fields

Modifier and Type	Fields and Description
static String	DEFAULT_FIELD Default value for field() indicating that then domain object field is expected to have the same name as the annotated field.
static String	DEFAULT_PATH Default value for path() indicating that then domain object field is in the domain object itself.
static String	DEFAULT_TYPE_CONVERTER Default value for type converter class name, indicating no name specified.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	field Name of the field in the domain class.
String	path Path to the field when it is transitive.
boolean	readOnly When set, the field will never be written in the domain class.
String	typeConverter Fully qualified class name for the type converter.
Class	typeConverterClass Class to use for type conversion.

Field Detail

DEFAULT_FIELD

public static final String DEFAULT_FIELD

Default value for field() indicating that then domain object field is expected to have the same name as the annotated field.

DEFAULT_PATH

public static final String DEFAULT_PATH

Default value for path() indicating that then domain object field is in the domain object itself.

DEFAULT_TYPE_CONVERTER

public static final String DEFAULT_TYPE_CONVERTER

Default value for type converter class name, indicating no name specified.

Element Detail

field

public abstract String field

Name of the field in the domain class.

By default the field is assumed to have the same name in the domain class.

Default:

"?"

path

public abstract String path

Path to the field when it is transitive.

By default the path is empty, meaning that the field is inside the domain object itself.

Default:

""

typeConverter

public abstract String typeConverter

Fully qualified class name for the type converter.

Using this allows you to avoid a compile dependency on the class name but makes the connection more brittle when refactoring. The value is ignored if typeConverterClass() is set.

Default:

"?"

typeConverterClass

public abstract Class typeConverterClass

Class to use for type conversion.

This requires a compile dependency on the domain class. The value has precedence over typeConverter().

Default:

org.jtransfo.MappedBy.DefaultTypeConverter.class

readOnly

public abstract boolean readOnly

When set, the field will never be written in the domain class.

Default:

false