org.hibernate.envers.configuration.metadata

Class MetadataTools

java.lang.Object

org.hibernate.envers.configuration.metadata.MetadataTools

public class MetadataTools
extends Object

Author:

Adam Warski (adam at warski dot org), Lukasz Antoniak (lukasz dot antoniak at gmail dot com), Michal Skowronek (mskowr at o2 dot pl)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MetadataTools.ColumnNameIterator An iterator over column names.

Constructor Summary

Constructors

Constructor and Description
MetadataTools()

Method Summary

Methods

Modifier and Type	Method and Description
static void	addColumn(Element any_mapping, Column column) Adds column element with the following attributes (unless empty): name, length, scale, precision, sql-type, read and write.
static Element	addColumn(Element parent, String name, Integer length, Integer scale, Integer precision, String sqlType, String customRead, String customWrite) Adds new column element.
static Element	addColumn(Element parent, String name, Integer length, Integer scale, Integer precision, String sqlType, String customRead, String customWrite, boolean quoted)
static void	addColumns(Element any_mapping, Iterator<Column> columns)
static void	addColumnsOrFormulas(Element element, Iterator columnIterator) Adds all column or formula elements.
static void	addFormula(Element element, Formula formula) Adds formula element.
static Element	addModifiedFlagProperty(Element parent, String propertyName, String suffix)
static Element	addNativelyGeneratedId(Element parent, String name, String type)
static Element	addOrModifyColumn(Element parent, String name) Column name shall be wrapped with '`' signs if quotation required.
static Element	addProperty(Element parent, String name, String type, boolean insertable, boolean key)
static Element	addProperty(Element parent, String name, String type, boolean insertable, boolean updateable, boolean key)
static Element	createEntity(Document document, AuditTableData auditTableData, String discriminatorValue)
static Element	createJoin(Element parent, String tableName, String schema, String catalog)
static Element	createSubclassEntity(Document document, String subclassType, AuditTableData auditTableData, String extendsEntityName, String discriminatorValue)
static MetadataTools.ColumnNameIterator	getColumnNameIterator(Iterator<Column> columnIterator)
static MetadataTools.ColumnNameIterator	getColumnNameIterator(JoinColumn[] joinColumns)
static String	getModifiedFlagPropertyName(String propertyName, String suffix)
static void	prefixNamesInPropertyElement(Element element, String prefix, MetadataTools.ColumnNameIterator columnNameIterator, boolean changeToKey, boolean insertable)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MetadataTools

public MetadataTools()

Method Detail

addNativelyGeneratedId

public static Element addNativelyGeneratedId(Element parent,
                             String name,
                             String type)

addProperty

public static Element addProperty(Element parent,
                  String name,
                  String type,
                  boolean insertable,
                  boolean updateable,
                  boolean key)

addProperty

public static Element addProperty(Element parent,
                  String name,
                  String type,
                  boolean insertable,
                  boolean key)

addModifiedFlagProperty

public static Element addModifiedFlagProperty(Element parent,
                              String propertyName,
                              String suffix)

getModifiedFlagPropertyName

public static String getModifiedFlagPropertyName(String propertyName,
                                 String suffix)

addOrModifyColumn

public static Element addOrModifyColumn(Element parent,
                        String name)

Column name shall be wrapped with '`' signs if quotation required.

addColumn

public static Element addColumn(Element parent,
                String name,
                Integer length,
                Integer scale,
                Integer precision,
                String sqlType,
                String customRead,
                String customWrite)

Adds new column element. Method assumes that the value of name attribute is already wrapped with '`' signs if quotation required. It shall be invoked when column name is taken directly from configuration file and not from PersistentClass descriptor.

addColumn

public static Element addColumn(Element parent,
                String name,
                Integer length,
                Integer scale,
                Integer precision,
                String sqlType,
                String customRead,
                String customWrite,
                boolean quoted)

createEntity

public static Element createEntity(Document document,
                   AuditTableData auditTableData,
                   String discriminatorValue)

createSubclassEntity

public static Element createSubclassEntity(Document document,
                           String subclassType,
                           AuditTableData auditTableData,
                           String extendsEntityName,
                           String discriminatorValue)

createJoin

public static Element createJoin(Element parent,
                 String tableName,
                 String schema,
                 String catalog)

addColumns

public static void addColumns(Element any_mapping,
              Iterator<Column> columns)

addColumn

public static void addColumn(Element any_mapping,
             Column column)

Adds column element with the following attributes (unless empty): name, length, scale, precision, sql-type, read and write.

Parameters:

any_mapping - Parent element.

column - Column descriptor.

prefixNamesInPropertyElement

public static void prefixNamesInPropertyElement(Element element,
                                String prefix,
                                MetadataTools.ColumnNameIterator columnNameIterator,
                                boolean changeToKey,
                                boolean insertable)

addFormula

public static void addFormula(Element element,
              Formula formula)

Adds formula element.

Parameters:

element - Parent element.

formula - Formula descriptor.

addColumnsOrFormulas

public static void addColumnsOrFormulas(Element element,
                        Iterator columnIterator)

Adds all column or formula elements.

Parameters:

element - Parent element.

columnIterator - Iterator pointing at Column and/or Formula objects.

getColumnNameIterator

public static MetadataTools.ColumnNameIterator getColumnNameIterator(Iterator<Column> columnIterator)

getColumnNameIterator

public static MetadataTools.ColumnNameIterator getColumnNameIterator(JoinColumn[] joinColumns)