Package org.hibernate.mapping
Class Column
- java.lang.Object
-
- org.hibernate.mapping.Column
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Cloneable
,Selectable
- Direct Known Subclasses:
ExportableColumn
public class Column extends java.lang.Object implements Selectable, java.io.Serializable, java.lang.Cloneable
A column of a relational database table- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static int
DEFAULT_LENGTH
static int
DEFAULT_PRECISION
static int
DEFAULT_SCALE
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Column
clone()
Shallow copy, the value is not copiedboolean
equals(java.lang.Object object)
boolean
equals(Column column)
java.lang.String
getAlias(Dialect dialect)
java.lang.String
getAlias(Dialect dialect, Table table)
Generate a column alias that is unique across multiple tablesjava.lang.String
getCanonicalName()
java.lang.String
getCheckConstraint()
java.lang.String
getComment()
java.lang.String
getCustomRead()
java.lang.String
getCustomWrite()
java.lang.String
getDefaultValue()
int
getLength()
java.lang.String
getName()
int
getPrecision()
java.lang.String
getQuotedName()
returns quoted name as it would be in the mapping file.java.lang.String
getQuotedName(Dialect d)
java.lang.String
getReadExpr(Dialect dialect)
int
getScale()
java.lang.String
getSqlType()
java.lang.String
getSqlType(Dialect dialect, Mapping mapping)
java.lang.Integer
getSqlTypeCode()
Returns the underlying columns sqltypecode.int
getSqlTypeCode(Mapping mapping)
java.lang.String
getTemplate(Dialect dialect, SQLFunctionRegistry functionRegistry)
java.lang.String
getText()
java.lang.String
getText(Dialect d)
int
getTypeIndex()
Value
getValue()
java.lang.String
getWriteExpr()
boolean
hasCheckConstraint()
boolean
hasCustomRead()
int
hashCode()
boolean
isFormula()
boolean
isNullable()
boolean
isQuoted()
boolean
isUnique()
void
setCheckConstraint(java.lang.String checkConstraint)
void
setComment(java.lang.String comment)
void
setCustomRead(java.lang.String customRead)
void
setCustomWrite(java.lang.String customWrite)
void
setDefaultValue(java.lang.String defaultValue)
void
setLength(int length)
void
setName(java.lang.String name)
void
setNullable(boolean nullable)
void
setPrecision(int scale)
void
setScale(int scale)
void
setSqlType(java.lang.String sqlType)
void
setSqlTypeCode(java.lang.Integer typeCode)
void
setTypeIndex(int typeIndex)
void
setUnique(boolean unique)
void
setValue(Value value)
java.lang.String
toString()
-
-
-
Field Detail
-
DEFAULT_LENGTH
public static final int DEFAULT_LENGTH
- See Also:
- Constant Field Values
-
DEFAULT_PRECISION
public static final int DEFAULT_PRECISION
- See Also:
- Constant Field Values
-
DEFAULT_SCALE
public static final int DEFAULT_SCALE
- See Also:
- Constant Field Values
-
-
Method Detail
-
getLength
public int getLength()
-
setLength
public void setLength(int length)
-
getValue
public Value getValue()
-
setValue
public void setValue(Value value)
-
getName
public java.lang.String getName()
-
setName
public void setName(java.lang.String name)
-
getQuotedName
public java.lang.String getQuotedName()
returns quoted name as it would be in the mapping file.
-
getQuotedName
public java.lang.String getQuotedName(Dialect d)
-
getAlias
public java.lang.String getAlias(Dialect dialect)
- Specified by:
getAlias
in interfaceSelectable
-
getAlias
public java.lang.String getAlias(Dialect dialect, Table table)
Generate a column alias that is unique across multiple tables- Specified by:
getAlias
in interfaceSelectable
-
isNullable
public boolean isNullable()
-
setNullable
public void setNullable(boolean nullable)
-
getTypeIndex
public int getTypeIndex()
-
setTypeIndex
public void setTypeIndex(int typeIndex)
-
isUnique
public boolean isUnique()
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
equals
public boolean equals(java.lang.Object object)
- Overrides:
equals
in classjava.lang.Object
-
equals
public boolean equals(Column column)
-
getSqlTypeCode
public int getSqlTypeCode(Mapping mapping) throws MappingException
- Throws:
MappingException
-
getSqlTypeCode
public java.lang.Integer getSqlTypeCode()
Returns the underlying columns sqltypecode. If null, it is because the sqltype code is unknown. Use #getSqlTypeCode(Mapping) to retrieve the sqltypecode used for the columns associated Value/Type.- Returns:
- sqlTypeCode if it is set, otherwise null.
-
setSqlTypeCode
public void setSqlTypeCode(java.lang.Integer typeCode)
-
getSqlType
public java.lang.String getSqlType(Dialect dialect, Mapping mapping) throws HibernateException
- Throws:
HibernateException
-
getSqlType
public java.lang.String getSqlType()
-
setSqlType
public void setSqlType(java.lang.String sqlType)
-
setUnique
public void setUnique(boolean unique)
-
isQuoted
public boolean isQuoted()
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
getCheckConstraint
public java.lang.String getCheckConstraint()
-
setCheckConstraint
public void setCheckConstraint(java.lang.String checkConstraint)
-
hasCheckConstraint
public boolean hasCheckConstraint()
-
getTemplate
public java.lang.String getTemplate(Dialect dialect, SQLFunctionRegistry functionRegistry)
- Specified by:
getTemplate
in interfaceSelectable
-
hasCustomRead
public boolean hasCustomRead()
-
getReadExpr
public java.lang.String getReadExpr(Dialect dialect)
-
getWriteExpr
public java.lang.String getWriteExpr()
-
isFormula
public boolean isFormula()
- Specified by:
isFormula
in interfaceSelectable
-
getText
public java.lang.String getText(Dialect d)
- Specified by:
getText
in interfaceSelectable
-
getText
public java.lang.String getText()
- Specified by:
getText
in interfaceSelectable
-
getPrecision
public int getPrecision()
-
setPrecision
public void setPrecision(int scale)
-
getScale
public int getScale()
-
setScale
public void setScale(int scale)
-
getComment
public java.lang.String getComment()
-
setComment
public void setComment(java.lang.String comment)
-
getDefaultValue
public java.lang.String getDefaultValue()
-
setDefaultValue
public void setDefaultValue(java.lang.String defaultValue)
-
getCustomWrite
public java.lang.String getCustomWrite()
-
setCustomWrite
public void setCustomWrite(java.lang.String customWrite)
-
getCustomRead
public java.lang.String getCustomRead()
-
setCustomRead
public void setCustomRead(java.lang.String customRead)
-
getCanonicalName
public java.lang.String getCanonicalName()
-
clone
public Column clone()
Shallow copy, the value is not copied- Overrides:
clone
in classjava.lang.Object
-
-