5 Using TopLink Workbench

5.3.1.1 Using Menu Bar Menus

The menu bar, located at the top of the TopLink Workbench window, provides menus for each TopLink Workbench function. Some menus (such as Selected) are context-sensitive; the available options may vary, depending on the currently selected object.

Figure 5-2 Sample Menu Bar Menu

Description of "Figure 5-2 Sample Menu Bar Menu"

5.3.1.2 Using Context Menus

When you right-click objects in the Navigator window, a context menu appears with functions specific to the selected object.

Figure 5-3 Sample Context Menu

Description of "Figure 5-3 Sample Context Menu"

5.3.2.1 Using Standard Toolbar

The standard toolbar furnishes quick access to the standard menu options (File, Edit, Selected, and so on).

Table 5-1 Standard Toolbar Buttons

Button	Description	Available for...
	New	All
	Open	All
	Save	All
	Save as	All
	Save all	All
	Close	All
	Close all	All
	Help topics	All
	Export deployment XML for the selected projects	Projects
	Refreshes selected classes	Projects
	Add or refresh classes	Projects
	Create new class	Projects

5.3.2.2 Using Context Toolbar

The context toolbar provides quick access to functions for the currently selected object in the Navigator (see Section 5.3.3, "How to Use the Navigator"). The available buttons will vary, depending on which item you have selected.

You can also right-click the item and choose the appropriate option from the context menu.

Table 5-2 Context Toolbar Buttons

Button	Description	Available for...
	Login to database	Databases
	Logout of database	Databases
	Add new table	Databases
	Add or update existing tables from database	Databases
	Refresh from database	Database tables
	Remove table or selected item	Database tables
	Rename table or selected item	Database tables
	Import schema	Schemas
	Relational aggregate descriptor	Descriptors
	Relational class descriptor	Descriptors
	Relational EJB descriptor	Descriptors
	EIS composite descriptor	Descriptors
	EIS root descriptor	Descriptors
	EIS EJB descriptor	Descriptors
	XML descriptor	Descriptors
	Direct-to-field mapping	Attributes in relational descriptors
	Object type mappingFoot 1	Attributes in relational descriptors
	Type conversion mappingFootref 1	Attributes in relational descriptors
	Serialized object mappingFootref 1	Attributes in relational descriptors
	Direct-to-XMLType mapping	Attributes in relational descriptors
	Direct collection mapping	Attributes in relational descriptors
	Direct map mapping	Attributes in relational descriptors
	Aggregate mapping	Attributes in relational descriptors
	One-to-one mapping	Attributes in relational descriptors
	Variable one-to-one mapping	Attributes in relational descriptors
	One-to-many mapping	Attributes in relational descriptors
	Many-to-many mapping	Attributes in relational descriptors
	Direct mapping	Attributes in EIS descriptors
	Direct collection mapping	Attributes in EIS descriptors
	Composite object mapping	Attributes in EIS descriptors
	Composite collection mapping	Attributes in EIS descriptors
	One-to-one mapping	Attributes in EIS descriptors
	One-to-many mapping	Attributes in EIS descriptors
	Direct-to-XML mapping	Attributes in XML descriptors
	Direct collection mapping	Attributes in XML descriptors
	Composite object mapping	Attributes in XML descriptors
	Composite collection mapping	Attributes in XML descriptors
	Any object mapping	Attributes in XML descriptors
	Any collection mapping	Attributes in XML descriptors
	Transformation mapping	Attributes in all descriptors
	Unmap	Attributes in all descriptors
	Session	Sessions configurations
	Session Broker	Sessions configurations
	Named connection pool	Server sessions
	Sequence connection pool	Server sessions
	Write connection pool	Server sessions
	Rename	Database sessions, session brokers
	Delete session	Database sessions, session brokers

^Footnote 1 Deprecated. For more information, see Section 27.2.2.2, "Using a Converter Mapping"

5.5.1.1 Logging In and Out of a Database

To log in or out of a relational database, do the following:

1. Create a database login (see Section 98.1, "Introduction to Database Login Configuration").

2. To log in to a relational database, right-click the database object in the Navigator, and choose Log In to Database from the context menu or choose Selected > Log In to Database from the menu.

3. To log out of a relational database, right-click the database object in the Navigator and choose Log Out of Database from the context menu or choose Selected > Log Out of Database from the menu.

5.5.1.2 Creating New Tables

To create a new database table within TopLink Workbench, use the following procedure:

1. 
   Select the database object in the Navigator window and click Add New Table. The New Table dialog box appears.

   You can also right-click the database object and choose Add New Table from the context menu, or choose Selected > Add New Table from the menu.

   Figure 5-19 New Table Dialog Box

   
   Description of "Figure 5-19 New Table Dialog Box"
   
   

Use the following information to enter data in each field:

TopLink Workbench adds the database table to the project.

Although the database table has been added to the project, it has not been written to the actual database. See Section 5.5.3.4, "Generating Tables on the Database" for more information on creating the table in the database.

Continue with Section 5.5.2, "How to Use Database Tables in the Editor Window" to use these tables in your project.

5.5.1.3 Importing Tables from a Database

TopLink Workbench can automatically read the schema for a relational database and import the table data into the project as long as your JDBC driver supports the following JDBC methods:

• getTables

• getTableTypes

• getImportedKeys

• getCatalogs

• getPrimaryKeys

The JDBC driver must be on the TopLink Workbench classpath (see Section 5.2, "Configuring the TopLink Workbench Environment").

To import tables from the database, use the following procedure:

1. 
   Select the database object in the Navigator, and click Add or Update Existing Tables from Database. The Import Tables from Database dialog box appears.

   You can also right-click on the database object in the Navigator and choose Add or Update Existing Tables from Database from the context menu or choose Selected > Add or Update Existing Tables from Database from the menu.

   Figure 5-20 Import Tables from Database Dialog Box

   
   Description of "Figure 5-20 Import Tables from Database Dialog Box"
   
   

   Figure 5-20 numbered callouts identify the following user interface components:

   1. Filters

   2. Database tables that match the filters

Use the following information to enter data in each field of the dialog box:

Examine each table's properties to verify that the imported tables contain the correct information. See Section 5.5.2, "How to Use Database Tables in the Editor Window" for more information.

5.5.1.4 Removing Tables

To remove a database table from the project, use the following procedure:

1. 
   Select a database table in the Navigator, and click Remove Selected Item on the toolbar. TopLink Workbench prompts for confirmation.

   You can also right-click on the database object and choose Remove from the context menu or choose Selected > Remove from the menu.

2. Click OK. TopLink Workbench removes the table from the project.

   Note:

   Although you have removed the table from the TopLink Workbench project, the table remains in the database.

5.5.1.5 Renaming Tables

To rename a database table in the TopLink Workbench project, use the following procedure:

1. Select a database table in the Navigator, and click Rename on the toolbar. The Rename dialog box appears.

   You can also right-click on the table and choose Rename from the context menu or choose Selected > Rename from the menu.

2. Enter a new name and click OK. TopLink Workbench renames the table.

   Note:

   Although you have renamed the table in the TopLink Workbench project, the original table name remains in the database.

5.5.1.6 Refreshing Tables from the Database

To refresh (that is, reload) the database tables in the TopLink Workbench project, use this procedure:

Select a database table in the Navigator, and click Refresh from Database on the toolbar.

You can also right-click on the table and choose Refresh from Database from the context menu or choose Selected > Refresh from Database from the menu. TopLink Workbench reloads the database table.

When refreshing tables from the database, if there are multiple database tables with similar names, the Duplicate Tables dialog box appears.

Figure 5-21 Duplicate Table Dialog Box

Description of "Figure 5-21 Duplicate Table Dialog Box"

Select the specific database table to update, and then click OK.

5.5.2.1 Working with Column Properties

Use the database table's Column tab to specify properties for the database table's fields.

To specify a table's column properties, use this procedure:

1. Select a database table in the Navigator. The table's property sheet displays in the Editor.

2. Click the Columns tab.

   Figure 5-22 Fields Properties

   
   Description of "Figure 5-22 Fields Properties"
   
   

3. Enter data in each field on the Columns tab. Use the scroll bar to display the additional field.

Use the following information to fill each column on the Columns tab:

To add a new field, click Add.

To remove a field, select the field and click Remove.

To rename a field, select the field and click Rename.

5.5.2.2 Setting a Primary Key for Database Tables

To set a primary key(s) for a database table, use this procedure:

1. Select a database table in the Navigator. Its property sheet appears in the Editor.

2. Click the Columns tab.

   Figure 5-23 Setting Primary Key for a Database Table

   
   Description of "Figure 5-23 Setting Primary Key for a Database Table"
   
   

3. Select the Primary Key field(s) for the table.

5.5.2.3 Creating Table References

References are table properties that contain the foreign key; they may or may not correspond to an actual constraint that exists on the database. TopLink Workbench uses these references when you define relationship mappings and multiple table associations.

When importing tables from the database, TopLink Workbench can automatically create references (if the driver supports this), or you can define references from the workbench. See Section 5.5.1.3, "Importing Tables from a Database".

To create a new table reference, use this procedure:

1. Select a database table in the Navigator. The table's properties display in the Editor.

2. Click the References tab.

   Figure 5-24 References Tab

   
   Description of "Figure 5-24 References Tab"
   
   

   Figure 5-26 numbered callouts identify the following user interface components:

   1. Table References area

   2. Key Pairs area

3. In the References area, click Add. The New Reference dialog box appears.

   Figure 5-25 New Reference Dialog Box

   
   Description of "Figure 5-25 New Reference Dialog Box"
   
   

Use the following information to enter data in each field of the dialog box:

Continue with Section 5.5.2.4, "Creating Field Associations".

5.5.2.4 Creating Field Associations

For each table reference, you can specify one or more field associations that define how fields in the source table relate to fields in the target table. See Section 5.5.2.3, "Creating Table References".

To create new field references, use this procedure:

1. Select a database table in the Navigator. The table's properties display in the Editor.

2. Click the References tab.

   Figure 5-26 References Tab

   
   Description of "Figure 5-26 References Tab"
   
   

   Figure 5-26 numbered callouts identify the following user interface components:

   1. Table references area

   2. Key pairs area

3. Select a table reference from the references area.

4. To create a new key pair, click Add in the key pairs area and complete each field in the key pairs area using the following information:

To create a new key pair, click Add in the key pairs area and complete each field in the key pairs area using the following information.

5.5.3.1 Generating SQL Creation Scripts

Using the TopLink Workbench, you can generate SQL scripts that you can use to create tables in a relational database.

To automatically generate SQL scripts to create the tables in a project, use this procedure:

1. Select the database table(s) in the Navigator.

2. Right-click the table(s) and choose Generate Creation Script for > Selected Tables or All Tables from the context menu. The SQL Creation Script dialog box appears.

   You can also choose Selected > Generate Creation Script for > Selected Tables or All Tables from the menu.

   Figure 5-27 SQL Creation Script Dialog Box

   
   Description of "Figure 5-27 SQL Creation Script Dialog Box"
   
   

Copy the script and paste it into a file. You may need to edit the file to include additional SQL information that TopLink Workbench could not generate. If the database table or column name is an SQL reserved word, you must edit the SQL script and enclose the database table or column in quotes. See "Oracle Database Reserved Words" in the Oracle Database SQL Reference Guide for more information.

5.5.3.2 Generating Classes and Descriptors from Database Tables

TopLink Workbench can automatically generate Java class definitions, descriptor definitions, and associated mappings from the information in database tables. You can later edit the generated information if necessary.

For each table, TopLink Workbench does the following:

• Creates a class definition and a descriptor definition.

• Adds attributes to the class for each column in the table.

• Automatically generates access methods, if specified.

• Creates direct-to-field mappings for all direct (nonforeign key) fields in the table.

• Creates relationship mappings (one-to-one and one-to-many) if there is sufficient foreign key information. You may be required to determine the exact mapping type.

  Note:

  Class and attribute names are generated based on the table and column names. You can edit the class properties to change their names.

To generate classes and descriptors from database tables, use the following procedure:

1. Select the database table(s) in the Navigator.

2. Right-click the table(s) and choose Generate Classes and Descriptors from > Selected Tables or All Tables from the context menu. TopLink Workbench prompts you to save your project.

   You can also choose Selected > Generate Classes and Descriptors from > Selected Tables or All Tables from the menu.

3. Click Yes. The Generate Classes and Descriptors dialog box appears.

   Figure 5-28 Generate Classes and Descriptors Dialog Box

   
   Description of "Figure 5-28 Generate Classes and Descriptors Dialog Box"
   
   

   Use the following information to enter data in each field:

   Field	Description
   Package Name	Specify the name of package to generate. The package name must comply with Java naming standards.
   Generate Accessing Methods	Specify if TopLink Workbench generates accessing methods for each class and descriptor.

   
   

If the table contains foreign key fields that may represent relationship mappings, then the Choose Relationships to Generate dialog box appears.

Figure 5-29 Choose Relationships to Generate Dialog Box

Description of "Figure 5-29 Choose Relationships to Generate Dialog Box"

Select an entry from Potential Relationships and click the 1:1 Mapping or 1:M Mapping button, located between the Potential Relationships and Selected Relationships windows. See Chapter 27, "Introduction to Relational Mappings" for more information on mappings.

You can also specify whether the relationships are bidirectional. See Section 121.18, "Configuring Bidirectional Relationship" for more information.

Click OK to automatically create the relationships.

The newly created descriptors appear in the Navigator of TopLink Workbench.

5.5.3.3 Generating EJB Entity Beans and Descriptors from Database Tables

Using TopLink Workbench, you can automatically generate EJB entity beans and descriptors for each database table, including the following:

• One EJB descriptor that implements the <javax.ejb.EntityBean> and entity bean classes

• Bean relation attributes (CMP or BMP)

• Java source for each class

• EJB-compliant method stubs

  Note:

  This option is available only for projects with container-managed or bean-managed persistence. See Section 117.5, "Configuring Persistence Type" for more information.

To automatically generate EJB entity beans and descriptors for each database table, use this procedure:

1. Select the database table(s) in the Navigator.

2. Right-click the table(s) and choose Generate EJB Entities and Descriptors from > Selected Table or All Tables from the context menu. TopLink Workbench prompts you to save your project.

   You can also choose Selected > Generate EJB Entities and Descriptors from > Selected Table or All Tables from the menu.

3. Click Yes to save your project before generating EJB entities. The Generate EJB Entity Classes and Descriptors dialog box appears.

   Figure 5-30 Generate EJB Entity Classes and Descriptors Dialog Box

   
   Description of "Figure 5-30 Generate EJB Entity Classes and Descriptors Dialog Box"
   
   

Use the following information to enter data in each field on the Generate EJB Entity Classes and Descriptors dialog box:

^Footnote 1 For CMP and BMP projects only. See Section 119.18, "Configuring a Descriptor with EJB CMP and BMP Information" for more information.

If the table contains foreign key fields that may represent relationship mappings, then the Choose Relationships to Generate dialog box appears. Select a potential relationship and click the 1:1 Mapping or 1:M Mapping button, located between the Potential Relationships and Selected Relationships windows.

You can also specify if the relationships are bidirectional (see Section 121.18, "Configuring Bidirectional Relationship").

Repeat for all appropriate sets of tables.

Click OK to generate the relationship mappings.

The system creates the remote primary key, home, and bean classes for each bean and adds this information to the project.

5.5.3.4 Generating Tables on the Database

To create a table in the database, based on the information in TopLink Workbench, use this procedure:

1. Select the database table(s) in the Navigator.

2. Right-click the table(s) and choose Create on Database > Selected Table or All Tables from the context menu.

   You can also create tables by selecting Selected > Create on Database > Selected Table or All Tables from the menu.

TopLink Workbench creates the tables on the database.

Alternatively, you can generate tables at run time by exporting the information in TopLink Workbench to a TableCreator class (see Section 6.1, "Introduction to the Schema Manager").

5.6.4.1 How to Configure an XML Schema Reference Using TopLink Workbench

To specify the source of a schema, use this procedure:

1. Select a schema element in the Navigator. Its properties appear in the Editor.

2. Click the Schema Document Info tab. The Schema Document Info tab appears.

   Figure 5-34 Schema Document Info Tab–Source Field

   
   Description of "Figure 5-34 Schema Document Info Tab–Source Field"
   
   

3. Click Edit to select a new source for the selected schema. The Schema Properties dialog box appears.

   Figure 5-35 Schema Properties Dialog Box

   
   Description of "Figure 5-35 Schema Properties Dialog Box"
   
   

Use the following information to complete each field in the Schema Properties dialog box:

5.6.4.2 How to Configure an XML Schema Reference Using Java

Use Java to configure schema reference. Create a descriptor amendment method (see Section 119.35, "Configuring Amendment Methods") that instantiates the appropriate type of XMLSchemaReference (XMLSchemaClassPathReference, XMLSchemaFileReference, or XMLSchemaURLReference) and configures the descriptor with it, as follows:

• If you are using EISDescriptors, the TopLink runtime does not use the schema reference; no further configuration is required.

• If you are using XMLDescriptors, configure the descriptor with the XMLSchemaReference using XMLDescriptor method setSchemaReference.

5.6.5.1 How to Configure XML Schema Namespace Using TopLink Workbench

To specify the namespaces of a schema, use this procedure:

1. Select a schema element in the Navigator. Its properties appear in the Editor.

2. Click the Schema Document Info tab. The Schema Document Info tab appears.

   Figure 5-36 Schema Document Info Tab–Namespaces Field

   
   Description of "Figure 5-36 Schema Document Info Tab–Namespaces Field"
   
   

Use the following information to complete each Namespaces field in the tab:

5.6.5.2 How to Configure XML Schema Namespace Using Java

Using Java, to configure XML schema namespaces for an EIS descriptor (with XML records) or an XML descriptor, create a descriptor amendment method (see Section 119.35, "Configuring Amendment Methods") that uses EISDescriptor or XMLDescriptor method getNamespaceResolver to configure the descriptor's NamespaceResolver accordingly, as Example 5-4 shows.

public void addToDescriptor(ClassDescriptor descriptor) {
    descriptor.getNamespaceResolver.put(
        prefix,
        namespaceURI
    );
}

5.7.1.1 How to Create Classes Using TopLink Workbench

To create new classes and packages from within TopLink Workbench, use this procedure:

1. 
   Select the project in the Navigator and click Create New Class.

   You can also right-click the project in the Navigator and choose Create New Class from the context menu or choose Selected > Create New Class from the menu.

   Figure 5-37 Add Class Dialog Box

   
   Description of "Figure 5-37 Add Class Dialog Box"
   
   

Use the following information to enter data in each field on the Add Class dialog box:

For more information on using TopLink Workbench to edit classes, see Section 5.7.2, "How to Configure Classes".

5.7.2.1 Configuring Class Information

This section includes information on Using TopLink Workbench to configure class information.

5.7.2.2 Configuring Class Modifiers

This section includes information on Using TopLink Workbench to configure class modifiers.

5.7.2.3 Configuring Class Interfaces

This section includes information on Using TopLink Workbench to specify the interfaces implemented by a class. You can choose any interface in the TopLink Workbench classpath (see Section 117.3, "Configuring Project Classpath").

Although you may add interfaces to a project directly (see Section 5.7.3, "How to Import and Update Classes"), you do not need to do so in order to configure a class to implement an interface.

5.7.2.4 Adding Attributes

This section includes information on Using TopLink Workbench to add an attribute to a class.

5.7.2.5 Configuring Attribute Modifiers

This section includes information on Using TopLink Workbench to configure attribute modifiers.

5.7.2.6 Configuring Attribute Type Declaration

This section includes information on Using TopLink Workbench to configure attribute type declaration.

5.7.2.7 Configuring Attribute Accessing Methods

This section includes information on Using TopLink Workbench to configure attribute accessing methods. If you change an attribute and regenerate the accessing methods, TopLink does not remove any previously generated methods.

5.7.2.8 Adding Methods

This section includes information on Using TopLink Workbench to add a method to a class.

5.7.2.9 Configuring Method Modifiers

This section includes information on Using TopLink Workbench to configure method modifiers.

5.7.2.10 Configuring Method Return Type

This section includes information on Using TopLink Workbench to configure method return type.

5.7.2.11 Configuring Method Parameters

This section includes information on Using TopLink Workbench to configure method parameters.

5.7.3.1 Importing and Updating Classes Using TopLink Workbench

Use this procedure to update or refresh the classes in the TopLink Workbench project.

1. Define the available classes and packages for the project on the General tab. See Section 117.3, "Configuring Project Classpath" for information on classes and packages.

2. 
   Click Add or Refresh Class. The Select Classes dialog box appears.

   You can also update the classes by choosing Selected > Add or Refresh Classes from the menu.

   Figure 5-48 Select Classes Dialog Box

   
   Description of "Figure 5-48 Select Classes Dialog Box"
   
   

Select the packages or classes (or both) to import into the project and click OK. TopLink Workbench adds the new classes to your project in the Navigator.

By default, TopLink Workbench creates the following descriptor types for each package and class (depending on your project type):

• Relational projects–Relational class descriptors (see Section 22.2.1.1, "Creating Relational Class Descriptors")

• EIS projects–EIS composite descriptors (see Section 75.2.1.2, "EIS Composite Descriptors")

• XML projects–XML descriptors (see Section 50.1.1.1, "Composite Descriptors in XML Projects")

See Chapter 118, "Creating a Descriptor" for more information.

To Remove a Class from a Project, do the following:

Select the descriptor and click Remove, or choose Selected > Remove from the menu.

5.7.5.1 Renaming Packages Using TopLink Workbench

To change the package of an existing class in TopLink Workbench, use this procedure:

1. Right-click the package in the Navigator and select Rename.

   You can also select the package and choose Selected > Rename from the menu.

   Figure 5-50 Rename Package Dialog Box

   
   Description of "Figure 5-50 Rename Package Dialog Box"
   
   

Enter the package name and click OK. TopLink Workbench changes the name of the package in the Navigator window.

For more information on using TopLink Workbench to edit classes, see Section 5.7.2, "How to Configure Classes".

5.8.1.1 Creating Library Dependencies

In addition to the Ant library dependencies (see http://ant.apache.org/manual/install.html#librarydependencies), Table 5-4 lists the TopLink-specific JAR files that must be in your Ant classpath.

5.8.1.2 Declaring TopLink Workbench Tasks

After you declare the TopLink Workbench task definitions (see Table 5-6) and data definitions (see Table 5-4) in the toplink-ant-lib.xml file (see Example 5-5), you can use a TopLink Workbench task in a build.xml file, as Example 5-6 shows:

<?xml version="1.0"?>
<antlib>
    <taskdef name="mappings.export"
        classname="oracle.toplink.workbench.ant.taskdefs.ExportDeploymentXMLTask" />

    <taskdef name="mappings.validate"
        classname="oracle.toplink.workbench.ant.taskdefs.MappingsValidateTask" />

    <taskdef name="session.validate"
        classname="oracle.toplink.workbench.ant.taskdefs.SessionValidateTask" />
 
    <typedef name="ignoreerror"
        classname="oracle.toplink.workbench.ant.typedefs.IgnoreError" />

    <typedef name="ignoreerrorset"
        classname="oracle.toplink.workbench.ant.typedefs.IgnoreErrorSet" />

    <typedef name="loginspec"
        classname="oracle.toplink.workbench.ant.typedefs.LoginSpec" />
</antlib>

<project name="MyBuild" default="validate.session" basedir="." xmlns:toplink="toplinklib">

    <typedef file = "toplink-ant-lib.xml" classpathref = "mw.classpath" uri = "toplinklib" />
...
</project>

5.8.4.1 Using Parameters

5.8.4.2 Specifying Parameters Specified as Nested Elements

You can specify the following parameters as nested elements of this task:

• classpath

• ignoreerror (see Section 5.8.8, "How to Create the ignoreerror Task")

• ignorerrorset (see Section 5.8.9, "How to Create the ignoreerrorset Task")

5.8.4.3 Examples

Example 5-8 shows a typical mappings.validate task.

<toplink:mappings.validate
    projectfile = "${toplink.mwp.dir}/myProject.mwp"
    reportfile = "${toplink.mwp.dir}/problem-report.html"
    reportformat = "html"
    property = "mw-valid"
    classpath = "${mwplatforms.classpath}" >

    <toplink:classpath refid = "mw.classpath" />
    <toplink:classpath refid = "toplink.classpath" />

    <toplink:ignoreerrorset refid = "ignoreErrors"/>
    <toplink:ignoreerror code = "0555" />
</toplink:mappings.validate>

5.8.5.1 Using Parameters

5.8.5.2 Specifying Parameters Specified as Nested Elements

You can specify the following parameters as nested elements of this task:

• classpath;

• loginspec (see Section 5.8.10, "How to Create the loginspec Task").

5.8.5.3 Examples

Example 5-9 shows a typical session.validate task.

<toplink:session.validate      
    sessionsfile = "${toplink.sessions.dir}/sessions.xml"
    sessionname = "ThreeTierEmployee"
    property = "session-valid"
    classpathref = "toplink.classpath"
    classpath = "${ myProject.classes}" >

    <toplink:classpath refid = "mw.classpath" />
    <toplink:classpath refid = " database.classpath" />

    <toplink:loginspec refid = "loginSpec" />
</toplink:session.validate>

5.8.6.1 Using Parameters

5.8.6.2 Specifying Parameters Specified as Nested Elements

You can specify the following parameters as nested elements of this task:

• classpath;

• loginspec (see Section 5.8.10, "How to Create the loginspec Task");

• ignorerror (see Section 5.8.8, "How to Create the ignoreerror Task");

• ignorerrorset (see Section 5.8.9, "How to Create the ignoreerrorset Task").

5.8.6.3 Examples

Example 5-10 shows a typical mappings.export task.

<toplink:mappings.export 
    projectfile = "${toplink.mwp.dir}/myProject.mwp"
    deploymentfile = "${toplink.sessions.dir}/sessions.xml"
    property = "export-completed"
    failonerror = "true"
    classpathref = "toplink.classpath">

    <toplink:classpath refid = "mw.classpath" />
    <toplink:classpath refid = "mwplatforms.classpath" />

    <toplink:ignoreerrorset refid = "ignoreErrors"/>
    <toplink:ignoreerror code = "0545" />
    <toplink:loginspec
            url = "jdbc:cloudscape:stagedb;create=true"
            driverclass = "COM.cloudscape.core.JDBCDriver"
            user = "scott" 
            password="tiger" />
</toplink:mappings.export>

5.8.7.1 Using Parameters

5.8.7.2 Specifying Parameters Specified as Nested Elements

You can specify the following parameters as nested elements of this task:

• pathelement

• fileset

• dirset

• filelist

5.8.7.3 Examples

Example 5-11 shows a typical classpath element.

<classpath>
    <pathelement path="${classpath}"/>
        <fileset dir="lib">
            <include name="**/*.jar"/>
        </fileset>
    <pathelement location="classes"/>
        <dirset dir="${build.dir}">
            <include name="apps/**/classes"/>
            <exclude name="apps/**/*Test*"/>
        </dirset>
    <filelist refid="third-party_jars"/>
</classpath>

5.8.8.1 Using Parameters

5.8.8.2 Specifying Parameters Specified as Nested Elements

You cannot specify parameters as nested elements of this element.

5.8.8.3 Examples

Example 5-12 shows a typical ignoreerror element. This element instructs a mappings.export task to ignore TopLink Workbench error code 0545.

<toplink:mappings.export 
    projectfile = "${toplink.mwp.dir}/myProject.mwp"
    deploymentfile = "${toplink.sessions.dir}/sessions.xml"
    classpathref = "toplink.classpath">

    <toplink:classpath refid = "mw.classpath" />
    <toplink:classpath refid = "mwplatforms.classpath" />
    <toplink:ignoreerror code = "0545" />

</toplink:mappings.export>

5.8.9.1 Using Parameters

5.8.9.2 Specifying Parameters Specified as Nested Elements

You can specify the following parameter as nested elements of this element:

• ignorerror (see Section 5.8.8, "How to Create the ignoreerror Task")

5.8.9.3 Examples

Example 5-13 shows a typical ignoreerrorset element. This element instructs a mappings.export task to ignore all of TopLink Workbench error codes 0402 and 0570. Note that the mappings.export task also uses an explicitly ignoreerror element: this means that the mappings.export task will ignore all of error codes 0402, 0570, and 0545.

<toplink:ignoreerrorset id = "ignoreErrors">
    <toplink:ignoreerror code = "0402" />
    <toplink:ignoreerror code = "0570" />
</toplink:ignoreerrorset>
...
<toplink:mappings.export 
    projectfile = "${toplink.mwp.dir}/myProject.mwp"
    deploymentfile = "${toplink.sessions.dir}/sessions.xml"
    classpathref = "toplink.classpath">

    <toplink:classpath refid = "mw.classpath" />    <toplink:classpath refid = "mwplatforms.classpath" />
    <toplink:ignoreerrorset refid = "ignoreErrors"/>
    <toplink:ignoreerror code = "0545" />

</toplink:mappings.export>

5.8.10.1 Using Parameters

5.8.10.2 Specifying Parameters Specified as Nested Elements

You cannot specify parameters as nested elements of this element.

5.8.10.3 Examples

Example 5-14 shows a typical loginspec element.

<toplink:mappings.export 
    projectfile = "${toplink.mwp.dir}/myProject.mwp"
    deploymentfile = "${toplink.sessions.dir}/sessions.xml"
    classpathref = "toplink.classpath">

    <toplink:classpath refid = "mw.classpath" />
    <toplink:classpath refid = "mwplatforms.classpath" />

    <toplink:loginspec
        url = "jdbc:cloudscape:stagedb;create=true"
        driverclass = "COM.cloudscape.core.JDBCDriver"
        user = "scott" 
        password="tiger" />
</toplink:mappings.export>