Column (hibernate-core JavaDocs)

java.lang.Object
- org.hibernate.mapping.Column

All Implemented Interfaces:

Serializable, Cloneable, Selectable

Direct Known Subclasses:

ExportableColumn
```
public class Column
extends Object
implements Selectable, Serializable, Cloneable
```
A column of a relational database table

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

Column()

Column(String columnName)

Constructors
Constructor and Description
`Column()`
`Column(String columnName)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`checkConstraint()`
`Column`	`clone()` Shallow copy, the value is not copied
`boolean`	`equals(Column column)`
`boolean`	`equals(Object object)`
`String`	`getAlias(Dialect dialect)`
`String`	`getAlias(Dialect dialect, Table table)` Generate a column alias that is unique across multiple tables
`String`	`getCanonicalName()`
`String`	`getCheckConstraint()`
`String`	`getComment()`
`String`	`getCustomRead()`
`String`	`getCustomReadExpression()` Any custom read expression for this selectable.
`String`	`getCustomWrite()`
`String`	`getCustomWriteExpression()` Any custom write expression for this selectable.
`String`	`getDefaultValue()`
`Long`	`getLength()`
`String`	`getName()`
`Integer`	`getPrecision()`
`String`	`getQuotedName()` returns quoted name as it would be in the mapping file.
`String`	`getQuotedName(Dialect d)`
`String`	`getReadExpr(Dialect dialect)`
`Integer`	`getScale()`
`String`	`getSqlType()`
`String`	`getSqlType(Dialect dialect, Mapping mapping)`
`Integer`	`getSqlTypeCode()` Returns the underlying columns SqlTypeCode.
`int`	`getSqlTypeCode(Mapping mapping)`
`String`	`getTemplate(Dialect dialect, SqmFunctionRegistry functionRegistry)`
`String`	`getText()` The selectable's "canonical" text representation
`String`	`getText(Dialect d)` The selectable's text representation accounting for the Dialect's quoting, if quoted
`int`	`getTypeIndex()`
`Value`	`getValue()`
`String`	`getWriteExpr()`
`boolean`	`hasCheckConstraint()`
`boolean`	`hasCustomRead()`
`int`	`hashCode()`
`boolean`	`isFormula()` Does this selectable represent a formula? `true` indicates it is a formula; `false` indicates it is a physical column
`boolean`	`isNullable()`
`boolean`	`isQuoted()`
`boolean`	`isUnique()`
`void`	`setCheckConstraint(String checkConstraint)`
`void`	`setComment(String comment)`
`void`	`setCustomRead(String customRead)`
`void`	`setCustomWrite(String customWrite)`
`void`	`setDefaultValue(String defaultValue)`
`void`	`setLength(Integer length)`
`void`	`setLength(Long length)`
`void`	`setName(String name)`
`void`	`setNullable(boolean nullable)`
`void`	`setPrecision(Integer precision)`
`void`	`setResolvedCustomRead(String customRead)`
`void`	`setScale(Integer scale)`
`void`	`setSqlType(String sqlType)`
`void`	`setSqlTypeCode(Integer typeCode)`
`void`	`setTypeIndex(int typeIndex)`
`void`	`setUnique(boolean unique)`
`void`	`setValue(Value value)`
`String`	`toString()`

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Column
```
public Column()
```

Column
```
public Column(String columnName)
```

Method Detail

getLength
```
public Long getLength()
```

setLength
```
public void setLength(Long length)
```

setLength

public void setLength(Integer length)

getValue
```
public Value getValue()
```

setValue
```
public void setValue(Value value)
```

getName
```
public String getName()
```

setName
```
public void setName(String name)
```

getQuotedName
```
public String getQuotedName()
```
returns quoted name as it would be in the mapping file.

getQuotedName

public String getQuotedName(Dialect d)

getAlias
```
public String getAlias(Dialect dialect)
```
Specified by:

getAlias in interface Selectable

getAlias
```
public String getAlias(Dialect dialect,
                       Table table)
```
Generate a column alias that is unique across multiple tables

Specified by:

getAlias in interface Selectable

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 class Object

equals
```
public boolean equals(Object object)
```
Overrides:

equals in class Object

equals
```
public boolean equals(Column column)
```

getSqlTypeCode

public int getSqlTypeCode(Mapping mapping)
                   throws MappingException

Throws:: MappingException

getSqlTypeCode
```
public Integer getSqlTypeCode()
```
Returns the underlying columns SqlTypeCode. If null, it is because the SqlTypeCode 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(Integer typeCode)

getSqlType

public String getSqlType(Dialect dialect,
                         Mapping mapping)
                  throws HibernateException

Throws:: HibernateException

getSqlType
```
public String getSqlType()
```

setSqlType

public void setSqlType(String sqlType)

setUnique

public void setUnique(boolean unique)

isQuoted
```
public boolean isQuoted()
```

toString
```
public String toString()
```
Overrides:

toString in class Object

getCheckConstraint
```
public String getCheckConstraint()
```

setCheckConstraint

public void setCheckConstraint(String checkConstraint)

hasCheckConstraint
```
public boolean hasCheckConstraint()
```

checkConstraint
```
public String checkConstraint()
```

getTemplate

public String getTemplate(Dialect dialect,
                          SqmFunctionRegistry functionRegistry)

Specified by:: getTemplate in interface Selectable

hasCustomRead
```
public boolean hasCustomRead()
```

getReadExpr

public String getReadExpr(Dialect dialect)

getWriteExpr
```
public String getWriteExpr()
```

isFormula
```
public boolean isFormula()
```
Description copied from interface: Selectable

Does this selectable represent a formula? true indicates it is a formula; false indicates it is a physical column

Specified by:

isFormula in interface Selectable

getText
```
public String getText(Dialect d)
```
Description copied from interface: Selectable

The selectable's text representation accounting for the Dialect's quoting, if quoted

Specified by:

getText in interface Selectable

getText
```
public String getText()
```
Description copied from interface: Selectable

The selectable's "canonical" text representation

Specified by:

getText in interface Selectable

getCustomReadExpression
```
public String getCustomReadExpression()
```
Description copied from interface: Selectable

Any custom read expression for this selectable. Only pertinent for physical columns (not formulas)

Specified by:

getCustomReadExpression in interface Selectable

See Also:

ColumnTransformer

getCustomWriteExpression
```
public String getCustomWriteExpression()
```
Description copied from interface: Selectable

Any custom write expression for this selectable. Only pertinent for physical columns (not formulas)

Specified by:

getCustomWriteExpression in interface Selectable

See Also:

ColumnTransformer

getPrecision
```
public Integer getPrecision()
```

setPrecision

public void setPrecision(Integer precision)

getScale
```
public Integer getScale()
```

setScale
```
public void setScale(Integer scale)
```

getComment
```
public String getComment()
```

setComment

public void setComment(String comment)

getDefaultValue
```
public String getDefaultValue()
```

setDefaultValue

public void setDefaultValue(String defaultValue)

getCustomWrite
```
public String getCustomWrite()
```

setCustomWrite

public void setCustomWrite(String customWrite)

getCustomRead
```
public String getCustomRead()
```

setResolvedCustomRead

public void setResolvedCustomRead(String customRead)

setCustomRead

public void setCustomRead(String customRead)

getCanonicalName
```
public String getCanonicalName()
```

clone
```
public Column clone()
```
Shallow copy, the value is not copied

Overrides:

clone in class Object

Class Column

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Column

Column

Method Detail

getLength

setLength

setLength

getValue

setValue

getName

setName

getQuotedName

getQuotedName

getAlias

getAlias

isNullable

setNullable

getTypeIndex

setTypeIndex

isUnique

hashCode

equals

equals

getSqlTypeCode

getSqlTypeCode

setSqlTypeCode

getSqlType

getSqlType

setSqlType

setUnique

isQuoted

toString

getCheckConstraint

setCheckConstraint

hasCheckConstraint

checkConstraint

getTemplate

hasCustomRead

getReadExpr

getWriteExpr

isFormula

getText

getText

getCustomReadExpression

getCustomWriteExpression

getPrecision

setPrecision

getScale

setScale

getComment

setComment

getDefaultValue

setDefaultValue

getCustomWrite

setCustomWrite

getCustomRead

setResolvedCustomRead

setCustomRead

getCanonicalName

clone