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 intDEFAULT_LENGTHstatic intDEFAULT_PRECISIONstatic intDEFAULT_SCALE
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Columnclone()Shallow copy, the value is not copiedbooleanequals(java.lang.Object object)booleanequals(Column column)java.lang.StringgetAlias(Dialect dialect)java.lang.StringgetAlias(Dialect dialect, Table table)Generate a column alias that is unique across multiple tablesjava.lang.StringgetCanonicalName()java.lang.StringgetCheckConstraint()java.lang.StringgetComment()java.lang.StringgetCustomRead()java.lang.StringgetCustomWrite()java.lang.StringgetDefaultValue()intgetLength()java.lang.StringgetName()intgetPrecision()java.lang.StringgetQuotedName()returns quoted name as it would be in the mapping file.java.lang.StringgetQuotedName(Dialect d)java.lang.StringgetReadExpr(Dialect dialect)intgetScale()java.lang.StringgetSqlType()java.lang.StringgetSqlType(Dialect dialect, Mapping mapping)java.lang.IntegergetSqlTypeCode()Returns the underlying columns sqltypecode.intgetSqlTypeCode(Mapping mapping)java.lang.StringgetTemplate(Dialect dialect, SQLFunctionRegistry functionRegistry)java.lang.StringgetText()java.lang.StringgetText(Dialect d)intgetTypeIndex()ValuegetValue()java.lang.StringgetWriteExpr()booleanhasCheckConstraint()booleanhasCustomRead()inthashCode()booleanisFormula()booleanisNullable()booleanisQuoted()booleanisUnique()voidsetCheckConstraint(java.lang.String checkConstraint)voidsetComment(java.lang.String comment)voidsetCustomRead(java.lang.String customRead)voidsetCustomWrite(java.lang.String customWrite)voidsetDefaultValue(java.lang.String defaultValue)voidsetLength(int length)voidsetName(java.lang.String name)voidsetNullable(boolean nullable)voidsetPrecision(int scale)voidsetScale(int scale)voidsetSqlType(java.lang.String sqlType)voidsetSqlTypeCode(java.lang.Integer typeCode)voidsetTypeIndex(int typeIndex)voidsetUnique(boolean unique)voidsetValue(Value value)java.lang.StringtoString()
-
-
-
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:
getAliasin interfaceSelectable
-
getAlias
public java.lang.String getAlias(Dialect dialect, Table table)
Generate a column alias that is unique across multiple tables- Specified by:
getAliasin 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:
hashCodein classjava.lang.Object
-
equals
public boolean equals(java.lang.Object object)
- Overrides:
equalsin 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:
toStringin 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:
getTemplatein 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:
isFormulain interfaceSelectable
-
getText
public java.lang.String getText(Dialect d)
- Specified by:
getTextin interfaceSelectable
-
getText
public java.lang.String getText()
- Specified by:
getTextin 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:
clonein classjava.lang.Object
-
-