Package org.hibernate.mapping

Class UserDefinedType

java.lang.Object

org.hibernate.mapping.UserDefinedType

All Implemented Interfaces:

Serializable, ContributableDatabaseObject, Exportable, Contributable

public class UserDefinedType
extends Object
implements Serializable, ContributableDatabaseObject

A mapping model object representing a relational database UDT.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
UserDefinedType(String contributor, Namespace namespace, Identifier physicalTypeName)

Method Summary

Modifier and Type	Method	Description
void	addColumn(Column column)
boolean	containsColumn(Column column)
boolean	equals(Object object)
boolean	equals(UserDefinedType table)
String	getCatalog()
Column	getColumn(int n)
Column	getColumn(Identifier name)
Column	getColumn(Column column)	Return the column which is identified by column provided as argument.
Collection<Column>	getColumns()
int	getColumnSpan()
String	getComment()
String	getContributor()	The name of the contributor which contributed this
String	getExportIdentifier()	Get a unique identifier to make sure we are not exporting the same database structure multiple times.
String	getName()
Identifier	getNameIdentifier()
int[]	getOrderMapping()
String	getQualifiedName(SqlStringGenerationContext context)
QualifiedTableName	getQualifiedTableName()
String	getQuotedCatalog()
String	getQuotedCatalog(Dialect dialect)
String	getQuotedName()
String	getQuotedName(Dialect dialect)
String	getQuotedSchema()
String	getQuotedSchema(Dialect dialect)
String	getSchema()
int	hashCode()
boolean	isCatalogQuoted()
boolean	isQuoted()
boolean	isSchemaQuoted()
void	reorderColumns(List<Column> columns)
void	setCatalog(String catalog)
void	setComment(String comment)
void	setName(String name)
void	setQuoted(boolean quoted)
void	setSchema(String schema)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UserDefinedType

public UserDefinedType(String contributor,
                       Namespace namespace,
                       Identifier physicalTypeName)

Method Detail

getContributor

public String getContributor()

Description copied from interface: Contributable

The name of the contributor which contributed this

Specified by:

getContributor in interface Contributable

getQualifiedName

public String getQualifiedName(SqlStringGenerationContext context)

setName

public void setName(String name)

getName

public String getName()

getNameIdentifier

public Identifier getNameIdentifier()

getQuotedName

public String getQuotedName()

getQuotedName

public String getQuotedName(Dialect dialect)

getQualifiedTableName

public QualifiedTableName getQualifiedTableName()

isQuoted

public boolean isQuoted()

setQuoted

public void setQuoted(boolean quoted)

setSchema

public void setSchema(String schema)

getSchema

public String getSchema()

getQuotedSchema

public String getQuotedSchema()

getQuotedSchema

public String getQuotedSchema(Dialect dialect)

isSchemaQuoted

public boolean isSchemaQuoted()

setCatalog

public void setCatalog(String catalog)

getCatalog

public String getCatalog()

getQuotedCatalog

public String getQuotedCatalog()

getQuotedCatalog

public String getQuotedCatalog(Dialect dialect)

isCatalogQuoted

public boolean isCatalogQuoted()

getColumn

public Column getColumn(Column column)

Return the column which is identified by column provided as argument.

Parameters:

column - column with at least a name.

Returns:

the underlying column or null if not inside this table. Note: the instance *can* be different than the input parameter, but the name will be the same.

getColumn

public Column getColumn(Identifier name)

getColumn

public Column getColumn(int n)

addColumn

public void addColumn(Column column)

getColumnSpan

public int getColumnSpan()

getColumns

public Collection<Column> getColumns()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object object)

Overrides:

equals in class Object

equals

public boolean equals(UserDefinedType table)

containsColumn

public boolean containsColumn(Column column)

toString

public String toString()

Overrides:

toString in class Object

getComment

public String getComment()

setComment

public void setComment(String comment)

getExportIdentifier

public String getExportIdentifier()

Description copied from interface: Exportable

Get a unique identifier to make sure we are not exporting the same database structure multiple times.

Specified by:

getExportIdentifier in interface Exportable

Returns:

The exporting identifier.

reorderColumns

@Internal
public void reorderColumns(List<Column> columns)

getOrderMapping

@Internal
public int[] getOrderMapping()