Skip Headers
Oracle TopLink Developer's Guide
10g Release 3 (10.1.3)
B13593-01
  Go To Documentation Library
Home
Go To Product List
Solution Area
Go To Table Of Contents
Contents
Go To Index
Index

Previous
Previous
Next
Next
 

Configuring Mapping Comments

You can define a free-form textual comment for each mapping. You can use these comments however you whish: for example, to record important project implementation details such as the purpose or importance of a mapping.

Comments are stored in the TopLink Workbench project, in the TopLink deployment XML file. There is no Java API for this feature.

Table 35-9 summarizes which mappings support this option.

Table 35-9 Mapping Support for Comments

Mapping Using TopLink Workbench
Using Java

Relational Mappings


Supported.


Unsupported

EIS Mappings


Supported.


Unsupported

XML Mappings


Supported.


Unsupported

Using TopLink Workbench

To add a comment for a mapping, use this procedure.

  1. Select the mapped attribute in the Navigator. Its properties appear in the Editor.

  2. Click the General tab. The General tab appears.

    Figure 35-9 General Tab, Comment

    Description of Figure 35-9  follows
    Description of "Figure 35-9 General Tab, Comment"

Enter a comment that describes this mapping.