All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.hibernate.tool.api.reveng.RevengStrategy Maven / Gradle / Ivy

There is a newer version: 7.0.0.Beta1
Show newest version
package org.hibernate.tool.api.reveng;

import java.util.List;
import java.util.Map;
import java.util.Properties;

import org.hibernate.mapping.ForeignKey;
import org.hibernate.mapping.MetaAttribute;
import org.hibernate.mapping.Table;

public interface RevengStrategy {
	
	interface SchemaSelection {
		String getMatchCatalog();
		String getMatchSchema();
		String getMatchTable();
	}

	/**
	 * Generic method used to initialize the reverse engineering strategy.
	 * 
	 * @param settings used for this
	 */
	public void  setSettings(RevengSettings settings);
	
	/**
	 * Close any resources this strategy might have used. Called after reverse engineering has been completed.
	 */
	public void close();

	/**
	 * 
	 * @return a fully-qualified class name  
	 */
	public String tableToClassName(TableIdentifier tableIdentifier);

	/**
	 * Return a property name for a Column.
	 * @param column a columnname
	 * @return a property name
	 */
	public String columnToPropertyName(TableIdentifier table, String column);
	   
	public boolean excludeTable(TableIdentifier ti);
	
	public boolean excludeColumn(TableIdentifier identifier, String columnName);
	
	/**
	 * Gets the preferred Hibernate type for an SQL type.
	 * @param table name of the table, can be null
	 * @param columnName name of the column, can be null
	 * @param sqlType The sql type.
	 * @param length The length of the column.
	 * @param precision The number of decimal digits, if applicable.
	 * @param scale The scale, if applicable.
	 * @param nullable The nullability of the column
	 * @param generatedIdentifier true if for a column used in an identifier that is not "assigned", false otherwise.
	 * @return The Preferred hibernate type name.
	 */
	public String columnToHibernateTypeName(TableIdentifier table, String columnName, int sqlType, int length, int precision, int scale, boolean nullable, boolean generatedIdentifier);

	/**
	 * Gets the user defined foreign keys.
	 * @param referencedTable the table to get the foreign keys for
	 * @return a list of ForeignKey's
	 */
	public List getForeignKeys(TableIdentifier referencedTable);

	/** 
	 * @param identifier the table to look up for
	 * @return the identifier strategy name wanted for a specific table, null if use what the database metadata can tell. 
	 */
	public String getTableIdentifierStrategyName(TableIdentifier identifier);

	public Properties getTableIdentifierProperties(TableIdentifier identifier);

	/** 
	 * If a table does not have any primarykey columns reported, this method is called. 
	 * @return list of strings for each column name that is part of the primary key 
	 **/
	public List getPrimaryKeyColumnNames(TableIdentifier identifier);

	/**
	 * Given a class name return the name for its composite id if it will have one.
	 * 
	 * @param className
	 * @return
	 */
	public String classNameToCompositeIdName(String className);

	
	/** Return explicit which column name should be used for optimistic lock */
	public String getOptimisticLockColumnName(TableIdentifier identifier);

	public boolean useColumnForOptimisticLock(TableIdentifier identifier, String column);

	/** 
	 * Return list of SchemaSelctors to be used when asking {@link RevengDialect} for metadata. 
	 * 
	 * @return list of {@link SchemaSelection} instances 
	 */
	public List getSchemaSelections();

	/**
	 * Given a table name, return the wanted name for the identifier. 
	 * @param tableIdentifier
	 * @return name to be used for identification
	 */
	public String tableToIdentifierPropertyName(TableIdentifier tableIdentifier);

	/**
	 * Given a table name, return the wanted name for a composite identifier.
	 * @param identifier
	 * @return
	 */
	public String tableToCompositeIdName(TableIdentifier identifier);

	/**
	 * Return the list of metaattributes to assign to classes created based on the given table 
	 * @param tableIdentifier
	 * @return a Map from String to {@link MetaAttribute}
	 */
	public Map tableToMetaAttributes(TableIdentifier tableIdentifier);
	
	/**
	 * Return the list of metaattributes to assign to properties created based on the given column 
	 * @param tableIdentifier
	 * @param column
	 * @return a Map from String to {@link MetaAttribute}
	 */
	public Map columnToMetaAttributes(TableIdentifier identifier, String column);
	
	/** Should this foreignkey be excluded as a oneToMany */
	public boolean excludeForeignKeyAsCollection(String keyname, TableIdentifier fromTable, List fromColumns, TableIdentifier referencedTable, List referencedColumns);

	/** Should this foreignkey be excluded as a many-to-one */
	public boolean excludeForeignKeyAsManytoOne(String keyname, TableIdentifier fromTable, List fromColumns, TableIdentifier referencedTable, List referencedColumns);
	
	/** is the collection lazy or not ? */
	public boolean isForeignKeyCollectionLazy(String name, TableIdentifier foreignKeyTable, List columns, TableIdentifier foreignKeyReferencedTable, List referencedColumns);
	
    /**
     * Return a collection role name for a Collection based on the foreignkey.
     * @param fromColumns list of Column instances on the fromTable. Only col.getName() should be assumed to be correct 
     * @param referencedColumns list of Column instances on the referenced Table. Only col.getName() should be assumed to be correct
     * @param uniqueReference true if there is no other references to the same table
     * @return
     */
    public String foreignKeyToCollectionName(String keyname, TableIdentifier fromTable, List fromColumns, TableIdentifier referencedTable, List referencedColumns, boolean uniqueReference);
	
    /**
     * 
     * @param fromColumns list of Column instances on the fromTable. Only col.getName() should be assumed to be correct 
     * @param referencedColumns list of Column instances on the referenced Table. Only col.getName() should be assumed to be correct
     * @param uniqueReference true if there is no other references to the same table
     * @return
     */
    public String foreignKeyToEntityName(String keyname, TableIdentifier fromTable, List fromColumns, TableIdentifier referencedTable, List referencedColumns, boolean uniqueReference);

    /**
     * Used to rename the inverse one-to-one properties.
     * 
     * @param fromColumns list of Column instances on the fromTable. Only col.getName() should be assumed to be correct 
     * @param referencedColumns list of Column instances on the referenced Table. Only col.getName() should be assumed to be correct
     * @param uniqueReference true if there is no other references to the same table
     * @return null if use defaults or non-empty String with a specific name 
     */
    public String foreignKeyToInverseEntityName(String keyname, TableIdentifier fromTable, List fromColumns, TableIdentifier referencedTable, List referencedColumns, boolean uniqueReference);
    
	/**
	 * @param table
	 * @return true if this table is considered to be a many-to-many table.
	 */
	public boolean isManyToManyTable(Table table);

    /**
     * 
     * @param middleTable 
     * @param uniqueReference true if there is no other references to the same table
     * @param fromColumns list of Column instances on the fromTable. Only col.getName() should be assumed to be correct 
     * @param referencedColumns list of Column instances on the referenced Table. Only col.getName() should be assumed to be correct
     * @return
     */
    public String foreignKeyToManyToManyName(ForeignKey fromKey, TableIdentifier middleTable, ForeignKey toKey, boolean uniqueReference);

	public boolean isOneToOne(ForeignKey foreignKey);

	public boolean isForeignKeyCollectionInverse(String name, Table foreignKeyTable, List columns, Table foreignKeyReferencedTable, List referencedColumns);
	

	public AssociationInfo foreignKeyToAssociationInfo(ForeignKey foreignKey);
	public AssociationInfo foreignKeyToInverseAssociationInfo(ForeignKey foreignKey);
		
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy