EclipseLink/Development/DBWS/NamingConventionTransformer

Document History

Date	Author	Version Description & Notes
080911	Mike Norman	1.0

DBWS utility enhancement: Naming convention of generated schema types

bug 234677
The DBWSBuilder utility should allow the user to alter the names of the generated schema types.
The algorithm currently in use is very simple:

• table name ==> translate any characters un-supported by XML¹ ==> to_lowercase ==> add suffix 'Type' ==> top-level complex element type in .xsd file
• column name ==> translate characters ==> to_lowercase ==> element tag name²

¹ - same algorithm documented as part of the SQL/X specification (a.k.a. ISO/IEC 9075-14:2003 Part 14)
² - All columns expressed as XML elements

Proposed new Interface org.eclipse.persistence.tools.dbws.NamingConventionTransformer

The proposed fix for bug 234677 is the introduction of a new Interface class:

package org.eclipse.persistence.tools.dbws;
 
public interface NamingConventionTransformer {
 
    public enum ElementStyle {
        ELEMENT, ATTRIBYTE
    };
 
    public String generateTableAlias(String tableName);
 
    public String generateSchemaTypeAlias(String originalSchemaName);
 
    public String generateWrapperElementNameAlias(String originalWrapperElementName);
 
    public String generateElementNameAlias(String originalElementName);
 
    public ElementStyle styleForElement(String elementName);
}
 
public class DefaultNamingConventionTransformer implements NamingConventionTransformer {
    // user-provided transformer must extended this class
   . . .
}

The algorithm above will be converted to a series of transformers (operating as a Chain-of-Responsibility) that cooperate together to transform the database table's metadata
(table name, table columns) into the schema's <xsd:complexType> and <xsd:element>'s.

• generateTableAlias

allows one to alter the auto-generated table name alias; e.g. remove prefix/suffix , camel-case, etc

• generateSchemaTypeAlias

allows one to alter the auto-generated high-level XML schema complexType

• generateWrapperElementNameAlias

allows one to alter the auto-generated high-level XML schema component element name (related to the complexType)

• generateElementNameAlias

allows one to alter the auto-generated XML schema element names (passed in as the table's column names)

• ElementStyle styleForElement

allows one to change the XML schema style for a given element name - is it an XML attribute or an element?