Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
EclipseLink/Development/DBWS/NamingConventionTransformer
< EclipseLink | Development | DBWS
Revision as of 13:52, 16 September 2008 by Unnamed Poltroon (Talk) (→DBWS utility enhancement: Naming convention of generated schema types)
DBWS Schema Naming Convention Transformers
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 XML1 ==> to_lowercase ==> add suffix 'Type' ==> top-level element type in .xsd file
- column name ==> translate characters ==> to_lowercase ==> element tag name2
1 - same algorithm documented as part of the SQL/X specification (a.k.a. ISO/IEC 9075-14:2003 Part 14)
2 - 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, ATTRIBUTE, NONE }; public String generateSchemaName(String tableName); public String generateElementAlias(String originalElementName); public ElementStyle styleForElement(String originalElementName); } 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 Schema name
- API passes in the name of the table so that it is available for parsing (e.g. remove prefix/suffix, convert to upper/lower/CamelCase, etc), but the NamingConventionTransformer implementation does not have to use it.
- generateElementAlias
- allows one to alter the auto-generated XML schema element names
- API passes in the name of the table's column so that it is available for parsing, but the NamingConventionTransformer implementation does not have to use it
- ElementStyle styleForElement
- allows one to change the XML schema style for a given table column - transform to an XML attribute, an element or neither (which means that the specified table column will not be mapped)