Switch from Set to List to maintain order

Author: ngbsn

src/main/java/io/github/ngbsn/generator/BiDirectionalMappingsGenerator.java

@@ -10,7 +10,6 @@
 
 import java.util.ArrayList;
 import java.util.List;
-import java.util.Set;
 
 /**
  * Generate BiDirectional Mappings (many-to-many) for a specific table
@@ -26,7 +25,7 @@ private BiDirectionalMappingsGenerator() {
      * @param table                    The table to be processed
      * @param foreignKeyConstraintList List of generated foreignKeyConstraintList models
      */
-    static void addBiDirectionalMappings(Table table, List<ForeignKeyConstraint> foreignKeyConstraintList) {
+    static void addBiDirectionalMappings(final Table table, final List<ForeignKeyConstraint> foreignKeyConstraintList) {
         Table table1 = ModelGenerator.getTablesMap().get(foreignKeyConstraintList.get(0).getReferencedTableName().replaceAll("[\"']", ""));
         Table table2 = ModelGenerator.getTablesMap().get(foreignKeyConstraintList.get(1).getReferencedTableName().replaceAll("[\"']", ""));
 

src/main/java/io/github/ngbsn/generator/ModelGenerator.java

@@ -25,7 +25,6 @@
 import java.util.*;
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
-import java.util.stream.Collectors;
 
 /**
  * This class will parse the SQL script and generate the Table models for each table in the script
@@ -93,7 +92,7 @@ static List<Table> parse(final String sqlScript) throws SQLParsingException {
     /**
      * Iterate over all the JSQL Create Table  statements and prepare the list of Table Model
      *
-     * @param statements Set of JSQL statements
+     * @param statements List of JSQL statements
      */
     private static void processCreateTableStatements(final List<Statement> statements) {
         statements.forEach(statement -> {
@@ -137,7 +136,7 @@ private static void processCreateTableStatements(final List<Statement> statement
     /**
      * Iterate over all the JSQL Alter Table statements and prepare the list of Table Model
      *
-     * @param statements Set of JSQL statements
+     * @param statements List of JSQL statements
      */
     private static void processAlterTableStatements(final List<Statement> statements) {
         statements.forEach(statement -> {
@@ -194,8 +193,8 @@ private static void extractForeignKeys(final List<Index> foreignKeyIndexes, fina
     private static void extractPrimaryKeys(final Index primaryKeyIndex, final Table table) {
         List<Index.ColumnParams> columnParamsList = primaryKeyIndex != null ? primaryKeyIndex.getColumns() : null;
         if (columnParamsList != null) {
-            Set<Column> primaryKeyColumns = table.getColumns().stream().
-                    filter(column -> columnParamsList.stream().anyMatch(columnParams -> columnParams.getColumnName().replaceAll(REGEX_ALL_QUOTES, "").equals(column.getColumnName()))).collect(Collectors.toSet());
+            List<Column> primaryKeyColumns = table.getColumns().stream().
+                    filter(column -> columnParamsList.stream().anyMatch(columnParams -> columnParams.getColumnName().replaceAll(REGEX_ALL_QUOTES, "").equals(column.getColumnName()))).toList();
 
             if (columnParamsList.size() > 1) {
                 table.setNumOfPrimaryKeyColumns(columnParamsList.size());

src/main/java/io/github/ngbsn/generator/UniDirectionalMappingsGenerator.java

@@ -8,7 +8,10 @@
 import io.github.ngbsn.util.Util;
 import org.apache.commons.text.WordUtils;
 
-import java.util.*;
+import java.util.ArrayList;
+import java.util.HashSet;
+import java.util.List;
+import java.util.Optional;
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
 
@@ -26,7 +29,7 @@ private UniDirectionalMappingsGenerator() {
      * @param table                Table model
      * @param foreignKeyConstraint ForeignKeyConstraint model
      */
-    static void addBothSideUniDirectionalMappings(Table table, ForeignKeyConstraint foreignKeyConstraint) {
+    static void addBothSideUniDirectionalMappings(final Table table, final ForeignKeyConstraint foreignKeyConstraint) {
         Table referencedTable = ModelGenerator.getTablesMap().get(foreignKeyConstraint.getReferencedTableName().replaceAll("[\"']", ""));
 
         //In the Child table, create a new column having field name as Parent(Referenced) Table.
@@ -49,7 +52,7 @@ static void addBothSideUniDirectionalMappings(Table table, ForeignKeyConstraint
         //get EmbeddedId for this table
         Optional<EmbeddableClass> optionalEmbeddableId = table.getEmbeddableClasses().stream().filter(EmbeddableClass::isEmbeddedId).findFirst();
         EmbeddableClass embeddableId = optionalEmbeddableId.orElse(null);
-        Set<Column> allPrimaryKeyColumns = getAllPrimaryKeys(table, embeddableId); //get all primary keys
+        List<Column> allPrimaryKeyColumns = getAllPrimaryKeys(table, embeddableId); //get all primary keys
 
         //Case: Composite Foreign key
         if (foreignKeyConstraint.getColumns().size() > 1) {
@@ -62,7 +65,8 @@ static void addBothSideUniDirectionalMappings(Table table, ForeignKeyConstraint
         }
     }
 
-    private static void handleSingleForeignKey(Table table, ForeignKeyConstraint foreignKeyConstraint, Column parentTableField, Set<Column> allPrimaryKeyColumns) {
+    private static void handleSingleForeignKey(final Table table, final ForeignKeyConstraint foreignKeyConstraint,
+                                               final Column parentTableField, final List<Column> allPrimaryKeyColumns) {
         //Get the foreign key column from the table
         Optional<Column> optionalColumn = table.getColumns().stream().filter(column -> column.getColumnName() != null && column.getColumnName().equals(foreignKeyConstraint.getColumns().get(0))).findFirst();
         if (optionalColumn.isPresent()) {
@@ -85,18 +89,19 @@ private static void handleSingleForeignKey(Table table, ForeignKeyConstraint for
         parentTableField.getAnnotations().add(JoinColumnAnnotation.builder().name(foreignKeyConstraint.getColumns().get(0)).referencedColumnName(foreignKeyConstraint.getReferencedColumns().get(0)).build().toString());
     }
 
-    private static void handleCompositeForeignKey(Table table, ForeignKeyConstraint foreignKeyConstraint, Column parentTableField, EmbeddableClass embeddableId, Set<Column> allPrimaryKeyColumns) {
-        Set<Column> setOfForeignKeyColumns = setOfForeignKeys(table, foreignKeyConstraint);
+    private static void handleCompositeForeignKey(final Table table, final ForeignKeyConstraint foreignKeyConstraint, final Column parentTableField,
+                                                  final EmbeddableClass embeddableId, final List<Column> allPrimaryKeyColumns) {
+        List<Column> listOfForeignKeyColumns = listOfForeignKeys(table, foreignKeyConstraint);
         //Case: Shared Composite Primary Key
         //If composite foreign key is inside the composite primary key, don't remove them from table.
         //This case assumes there is a primary composite key
         //Add a @MapsId annotation to the referenced table field
-        if (embeddableId != null && allPrimaryKeyColumns.containsAll(setOfForeignKeyColumns)) {
-            handleSharedCompositePrimaryKey(table, parentTableField, embeddableId, setOfForeignKeyColumns);
+        if (embeddableId != null && new HashSet<>(allPrimaryKeyColumns).containsAll(listOfForeignKeyColumns)) {
+            handleSharedCompositePrimaryKey(table, parentTableField, embeddableId, listOfForeignKeyColumns);
         } else {
             //There is no primary Composite key
             //If composite foreign key is not inside the composite primary key, then remove it from the table
-            setOfForeignKeyColumns.forEach(column -> table.getColumns().remove(column));
+            listOfForeignKeyColumns.forEach(column -> table.getColumns().remove(column));
         }
 
         List<JoinColumnAnnotation> joinColumns = new ArrayList<>();
@@ -108,7 +113,8 @@ private static void handleCompositeForeignKey(Table table, ForeignKeyConstraint
         parentTableField.getAnnotations().add(JoinColumnsAnnotation.builder().joinColumns(joinColumns).build().toString());
     }
 
-    private static void handleSharedCompositePrimaryKey(Table table, Column parentTableField, EmbeddableClass embeddableId, Set<Column> setOfForeignKeyColumns) {
+    private static void handleSharedCompositePrimaryKey(final Table table, final Column parentTableField,
+                                                        final EmbeddableClass embeddableId, final List<Column> setOfForeignKeyColumns) {
         EmbeddableClass foreignCompositeKeyEmbedded = new EmbeddableClass(); //Create a new embeddable for this foreign composite key
         String embeddableName = setOfForeignKeyColumns.stream().map(Column::getFieldName).collect(Collectors.joining());
         foreignCompositeKeyEmbedded.setClassName(WordUtils.capitalize(embeddableName));
@@ -129,18 +135,18 @@ private static void handleSharedCompositePrimaryKey(Table table, Column parentTa
             parentTableField.getAnnotations().add(MapsIdAnnotation.builder().fieldName(foreignCompositeField.getFieldName()).build().toString());
     }
 
-    private static Set<Column> setOfForeignKeys(Table table, ForeignKeyConstraint foreignKeyConstraint) {
+    private static List<Column> listOfForeignKeys(final Table table, final ForeignKeyConstraint foreignKeyConstraint) {
         Stream<Column> allTableForeignKeyColumns = table.getColumns().stream();
         Stream<Column> allEmbeddedForeignKeyColumns = table.getEmbeddableClasses().stream().flatMap(embeddableClass -> embeddableClass.getColumns().stream());
-        return Stream.concat(allTableForeignKeyColumns, allEmbeddedForeignKeyColumns).filter(column -> foreignKeyConstraint.getColumns().stream().anyMatch(s -> s.equals(column.getColumnName()))).collect(Collectors.toSet());
+        return Stream.concat(allTableForeignKeyColumns, allEmbeddedForeignKeyColumns).filter(column -> foreignKeyConstraint.getColumns().stream().anyMatch(s -> s.equals(column.getColumnName()))).toList();
     }
 
-    private static Set<Column> getAllPrimaryKeys(Table table, EmbeddableClass embeddableId) {
-        //Get set of primary Keys
+    private static List<Column> getAllPrimaryKeys(final Table table, final EmbeddableClass embeddableId) {
+        //Get list of primary Keys
         if (embeddableId != null) {
-            return embeddableId.getColumns().stream().filter(Column::isPrimaryKey).collect(Collectors.toSet());
+            return embeddableId.getColumns().stream().filter(Column::isPrimaryKey).toList();
         } else {
-            return table.getColumns().stream().filter(Column::isPrimaryKey).collect(Collectors.toSet());
+            return table.getColumns().stream().filter(Column::isPrimaryKey).toList();
         }
     }
 

src/main/java/io/github/ngbsn/model/Column.java

@@ -5,7 +5,6 @@
 
 import java.util.ArrayList;
 import java.util.List;
-import java.util.Set;
 
 @Setter
 @Getter

src/main/java/io/github/ngbsn/model/EmbeddableClass.java

@@ -5,7 +5,6 @@
 
 import java.util.ArrayList;
 import java.util.List;
-import java.util.Set;
 
 @Setter
 @Getter

src/main/java/io/github/ngbsn/model/Table.java

@@ -5,7 +5,6 @@
 
 import java.util.ArrayList;
 import java.util.List;
-import java.util.Set;
 
 
 @Setter

src/main/java/io/github/ngbsn/model/annotations/field/JoinColumnsAnnotation.java

@@ -4,7 +4,6 @@
 import lombok.Builder;
 
 import java.util.List;
-import java.util.Set;
 import java.util.stream.Collectors;
 
 @Builder

src/main/java/io/github/ngbsn/model/annotations/field/JoinTableAnnotation.java

@@ -4,7 +4,6 @@
 import lombok.Builder;
 
 import java.util.List;
-import java.util.Set;
 import java.util.stream.Collectors;
 
 @Builder

src/main/java/io/github/ngbsn/util/Util.java

@@ -32,7 +32,7 @@ public static String packageNameToFolderStructure(final String packageName) {
      * @param captializeFirstChar Whether the first char is upper case. This is applicable for Table names
      * @return Field names and class names
      */
-    public static String convertSnakeCaseToCamelCase(String word, boolean captializeFirstChar) {
+    public static String convertSnakeCaseToCamelCase(String word, final boolean captializeFirstChar) {
         word = captializeFirstChar ? WordUtils.capitalize(word) : WordUtils.uncapitalize(word);
         return word.contains("_") ? CaseUtils.toCamelCase(word, captializeFirstChar, '_') : word;
     }