JeeWiz Architect's Guide


	The Model-Driven System Builder

JeeWiz Architect's Guide

Contents > 14. 'Business Object' Reference

14.28 KeyMap Object

Used on

end

Description Describes a foreign key mapping from the entity referenced by its parent element to the entity represented by another element.

There must be precisely one key-map item for each field in the related primary key (but these can be in any order).

Validation 1. Related key does not identify an attribute on the other end's entity
2. Related key identifies an attribute on the other end's entity that is not a key or auto-key

Inherited
properties

name (base property)

description (base property)

template (base property)

text (base property)

jwpattern (base property)

14.28.1	Property 'foreignKey'
14.28.2	Property 'foreignKeyDbmsColumn'
14.28.3	Property 'relatedKey'
14.28.4	Property 'uid'

14.28.1 Property 'foreignKey'

*Description*	Identifies information in the parent end's entity, that is a foreign key to the related entity. The foreign-key may be an attribute in the design model; if so, it will not be listed as a container-managed attribute in J2EE/EJB rendering. The foreign-key can also not be an attribute in the design model: in this case, a synthetic attribute will be created on the entity.
*Type*	String
*Required*	true

14.28.2 Property 'foreignKeyDbmsColumn'

Description

This field is relevant where the foreign-key is not present in the design model. In this case, we need to be able to specify the database column for the synthetic foreign-key attribute. If you do not specify the foreign key DBMS column, the foreign-key name is used as the DBMS column.

Where the foreign-key property is the name of an attribute in the design model, the foreign key DBMS column property is redundant: the database column to use is specified by the attribute's DBMS column property.

Type

String

14.28.3 Property 'relatedKey'

*Description*	Specifies the corresponding primary key column in the related entity.
*Type*	String
*Required*	true

14.28.4 Property 'uid'

*Description*	The 'uid' is a Unique IDentifier for a methods in the business object model (and derivatives like J2EE). The 'uid' uniquely identifies the method, even if the name or signature of the method changes. This will normally be generated by the modelling tool; if not, it can be entered manually (but make sure it is unique!).
*Type*	String