Skip to content

Commit 0678f91

Browse files
koentsjekoentsje
committed
HHH-19879: Move Hibernate Tools' reveng module to Hibernate ORM and merge the relevant ant/gradle/maven plugins
 - Add the Reverse Engineering module
1 parent 23c5fb3 commit 0678f91

File tree

233 files changed

+26203
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

233 files changed

+26203
-0
lines changed

‎settings.gradle‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -359,6 +359,9 @@ project(':hibernate-maven-plugin').projectDir = new File(rootProject.projectDir,
359359
include 'hibernate-ant'
360360
project(':hibernate-ant').projectDir = new File(rootProject.projectDir, "tooling/hibernate-ant")
361361

362+
include 'hibernate-reveng'
363+
project(':hibernate-reveng').projectDir = new File(rootProject.projectDir, "tooling/hibernate-reveng")
364+
362365
rootProject.children.each { project ->
363366
project.buildFileName = "${project.name}.gradle"
364367
assert project.projectDir.isDirectory()

‎tooling/hibernate-reveng/hibernate-reveng.gradle‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
plugins {
2+
id "local.java-module"
3+
}
4+
5+
description = "Library providing functionality to perform reverse engineering Hibernate related artefacts from an existing database"
6+
7+
dependencies {
8+
implementation project( ':hibernate-core' )
9+
implementation project( ':hibernate-ant' )
10+
implementation "org.apache.commons:commons-collections4:4.5.0"
11+
implementation "com.google.googlejavaformat:google-java-format:1.27.0"
12+
implementation "org.freemarker:freemarker:2.3.34"
13+
implementation "org.antlr:antlr4-runtime:4.13.2"
14+
}

‎tooling/hibernate-reveng/src/main/java/org/hibernate/tool/reveng/api/core/AssociationInfo.java‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
/*
2+
* Hibernate Tools, Tooling for your Hibernate Projects
3+
*
4+
* Copyright 2010-2025 Red Hat, Inc.
5+
*
6+
* Licensed under the Apache License, Version 2.0 (the "License");
7+
* you may not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" basis,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*/
18+
package org.hibernate.tool.reveng.api.core;
19+
20+
public interface AssociationInfo {
21+
22+
String getCascade();
23+
String getFetch();
24+
Boolean getUpdate();
25+
Boolean getInsert();
26+
27+
}

‎tooling/hibernate-reveng/src/main/java/org/hibernate/tool/reveng/api/core/RevengDialect.java‎

Lines changed: 126 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,126 @@
1+
/*
2+
* Hibernate Tools, Tooling for your Hibernate Projects
3+
*
4+
* Copyright 2010-2025 Red Hat, Inc.
5+
*
6+
* Licensed under the Apache License, Version 2.0 (the "License");
7+
* you may not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" basis,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*/
18+
package org.hibernate.tool.reveng.api.core;
19+
20+
import org.hibernate.engine.jdbc.connections.spi.ConnectionProvider;
21+
22+
import java.util.Iterator;
23+
import java.util.Map;
24+
25+
/**
26+
* Interface for fetching metadata from databases.
27+
* The dialect is configured with a ConnectionProvider but is not
28+
* required to actually use any connections.
29+
*
30+
* The metadata methods all returns Iterator and allows for more efficient and partial reads
31+
* for those databases that has "flakey" JDBC metadata implementions.
32+
*
33+
* @author Max Rydahl Andersen
34+
*
35+
*/
36+
public interface RevengDialect {
37+
38+
/**
39+
* Configure the metadatadialect.
40+
* @param connectionProvider a {@link ConnectionProvider}
41+
*/
42+
public void configure(ConnectionProvider connectionProvider);
43+
44+
/**
45+
* Return iterator over the tables that mathces catalog, schema and table
46+
*
47+
* @param catalog name or null
48+
* @param schema name or null
49+
* @param table name or null
50+
* @return iterator with map elements that has "TABLE_NAME", "TABLE_SCHEMA", "TABLE_CAT", "TABLE_TYPE" keys.
51+
*/
52+
Iterator<Map<String,Object>> getTables(String catalog, String schema, String table);
53+
54+
/**
55+
* Close the iterator.
56+
* @param iterator an iterator returned from one of methods on this dialect
57+
*/
58+
void close(Iterator<?> iterator);
59+
60+
/**
61+
* Return iterator over the indexes that mathces catalog, schema and table
62+
*
63+
* @param catalog name or null
64+
* @param schema name or null
65+
* @param table name or null
66+
* @return iterator with map elements that has "TABLE_NAME", "TABLE_SCHEMA", "TABLE_CAT", "INDEX_NAME", "COLUMN_NAME", "NON_UNIQUE", "TYPE" keys.
67+
*/
68+
Iterator<Map<String, Object>> getIndexInfo(String catalog, String schema, String table);
69+
70+
/**
71+
* Return iterator over the columns that mathces catalog, schema and table
72+
*
73+
* @param catalog name or null
74+
* @param schema name or null
75+
* @param table name or null
76+
* @param column name or null
77+
* @return iterator with map elements that has "TABLE_NAME", "TABLE_SCHEMA", "TABLE_CAT", "DATA_TYPE", "TYPE_NAME", "COLUMN_NAME", "NULLABLE", "COLUMN_SIZE", "DECIMAL_DIGITS"
78+
*/
79+
Iterator<Map<String, Object>> getColumns(String catalog, String schema, String table, String column);
80+
81+
/**
82+
* Return iterator over the columns that mathces catalog, schema and table
83+
*
84+
* @param catalog name or null
85+
* @param schema name or null
86+
* @param table name or null
87+
* @return iterator with map elements that has "TABLE_NAME", "TABLE_SCHEMA", "TABLE_CAT", "COLUMN_NAME", "KEY_SEQ", "PK_NAME",
88+
*/
89+
Iterator<Map<String, Object>> getPrimaryKeys(String catalog, String schema, String name);
90+
91+
92+
/**
93+
* Return iterator over the exported foreign keys that mathces catalog, schema and table
94+
*
95+
* @param catalog name or null
96+
* @param schema name or null
97+
* @param table name or null
98+
* @return iterator with map elements that has "TABLE_NAME", "TABLE_SCHEMA", "TABLE_CAT", "FKTABLE_CAT", "FKTABLE_SCHEM", "FKTABLE_NAME", "FK_NAME", "KEY_SEQ"
99+
*/
100+
Iterator<Map<String, Object>> getExportedKeys(String catalog, String schema, String table);
101+
102+
/**
103+
* Does this name need quoting
104+
*
105+
* @param name
106+
* @return
107+
*/
108+
boolean needQuote(String name);
109+
110+
/**
111+
* Close any resources this dialect might have used.
112+
*/
113+
void close();
114+
115+
/**
116+
* Use database (possible native) metadata to suggest identifier strategy.
117+
*
118+
* @param catalog
119+
* @param schema
120+
* @param name
121+
* @return iterator with map elements that has "TABLE_NAME", "TABLE_SCHEMA", "TABLE_CAT", "HIBERNATE_STRATEGY" (null if no possible to determine strategy, otherwise return hibernate identifier strategy name/classname)
122+
*/
123+
public Iterator<Map<String, Object>> getSuggestedPrimaryKeyStrategyName(String catalog, String schema, String table);
124+
125+
126+
}

‎tooling/hibernate-reveng/src/main/java/org/hibernate/tool/reveng/api/core/RevengDialectFactory.java‎

Lines changed: 112 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,112 @@
1+
/*
2+
* Hibernate Tools, Tooling for your Hibernate Projects
3+
*
4+
* Copyright 2010-2025 Red Hat, Inc.
5+
*
6+
* Licensed under the Apache License, Version 2.0 (the "License");
7+
* you may not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" basis,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*/
18+
package org.hibernate.tool.reveng.api.core;
19+
20+
import org.hibernate.dialect.Dialect;
21+
import org.hibernate.dialect.H2Dialect;
22+
import org.hibernate.dialect.HSQLDialect;
23+
import org.hibernate.dialect.MySQLDialect;
24+
import org.hibernate.dialect.OracleDialect;
25+
import org.hibernate.dialect.SQLServerDialect;
26+
import org.hibernate.internal.util.ReflectHelper;
27+
import org.hibernate.tool.reveng.internal.core.dialect.H2MetaDataDialect;
28+
import org.hibernate.tool.reveng.internal.core.dialect.HSQLMetaDataDialect;
29+
import org.hibernate.tool.reveng.internal.core.dialect.JDBCMetaDataDialect;
30+
import org.hibernate.tool.reveng.internal.core.dialect.MySQLMetaDataDialect;
31+
import org.hibernate.tool.reveng.internal.core.dialect.OracleMetaDataDialect;
32+
import org.hibernate.tool.reveng.internal.core.dialect.SQLServerMetaDataDialect;
33+
34+
import java.lang.reflect.Constructor;
35+
import java.util.Properties;
36+
37+
public class RevengDialectFactory {
38+
39+
private RevengDialectFactory() {}
40+
41+
public static RevengDialect createMetaDataDialect(Dialect dialect, Properties cfg) {
42+
String property = cfg.getProperty( "hibernatetool.metadatadialect" );
43+
RevengDialect mdd = fromClassName(property);
44+
if(mdd==null) {
45+
mdd = fromDialect(dialect);
46+
}
47+
if(mdd==null) {
48+
mdd = fromDialectName(dialect.getClass().getName());
49+
}
50+
if(mdd==null) {
51+
mdd = new JDBCMetaDataDialect();
52+
}
53+
return mdd;
54+
}
55+
56+
public static RevengDialect fromClassName(String property) {
57+
if ( property != null ) {
58+
try {
59+
Class<?> revengDialectClass = ReflectHelper.classForName(
60+
property,
61+
RevengDialectFactory.class );
62+
Constructor<?> revengDialectConstructor = revengDialectClass.getConstructor(
63+
new Class[] {});
64+
return (RevengDialect)revengDialectConstructor.newInstance();
65+
}
66+
catch (Throwable e) {
67+
throw new RuntimeException(
68+
"Could not load MetaDataDialect: " + property, e );
69+
}
70+
} else {
71+
return null;
72+
}
73+
}
74+
75+
public static RevengDialect fromDialect(Dialect dialect) {
76+
if(dialect!=null) {
77+
if(dialect instanceof OracleDialect) {
78+
return new OracleMetaDataDialect();
79+
} else if (dialect instanceof H2Dialect) {
80+
return new H2MetaDataDialect();
81+
} else if (dialect instanceof MySQLDialect) {
82+
return new MySQLMetaDataDialect();
83+
} else if (dialect instanceof HSQLDialect) {
84+
return new HSQLMetaDataDialect();
85+
}else if (dialect instanceof SQLServerDialect) {
86+
return new SQLServerMetaDataDialect();
87+
}
88+
}
89+
return null;
90+
}
91+
92+
public static RevengDialect fromDialectName(String dialect) {
93+
if (dialect.toLowerCase().contains("oracle")) {
94+
return new OracleMetaDataDialect();
95+
}
96+
if (dialect.toLowerCase().contains("mysql")) {
97+
return new MySQLMetaDataDialect();
98+
}
99+
if (dialect.toLowerCase().contains("h2")) {
100+
return new H2MetaDataDialect();
101+
}
102+
if (dialect.toLowerCase().contains("hsql")) {
103+
return new HSQLMetaDataDialect();
104+
}
105+
if (dialect.toLowerCase().contains("sqlserver")) {
106+
return new SQLServerMetaDataDialect();
107+
}
108+
return null;
109+
}
110+
111+
112+
}

0 commit comments

Comments
 (0)