java.lang.Object
- org.odpi.openmetadata.accessservices.datamanager.metadataelements.DatabaseColumnElement

All Implemented Interfaces:

Serializable, MetadataElement
```
public class DatabaseColumnElement
extends Object
implements MetadataElement, Serializable
```
DatabaseColumnElement contains the properties and header for a database column entity retrieved from the metadata repository.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor Description

DatabaseColumnElement()
Default constructor

DatabaseColumnElement(DatabaseColumnElement template)
Copy/clone constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`equals(Object objectToCompare)`	Return comparison result based on the content of the properties.
`DatabaseColumnProperties`	`getDatabaseColumnProperties()`	Return the principle properties for the database column.
`ElementHeader`	`getElementHeader()`	Return the element header associated with the properties.
`DatabaseForeignKeyProperties`	`getForeignKeyProperties()`	When this column contains the primary key of another table (ie it is a foreign key) return the properties associated with the relationship.
`DatabasePrimaryKeyProperties`	`getPrimaryKeyProperties()`	When this column is a primary key, return the properties of the primary key value; otherwise null
`String`	`getReferencedColumnGUID()`	Return the unique identifier of the column in another table that this column references through a foreign key relationship.
`String`	`getReferencedColumnQualifiedName()`	Return the unique name of the column in another table that this column references through a foreign key relationship.
`int`	`hashCode()`	Return hash code for this object
`void`	`setDatabaseColumnProperties(DatabaseColumnProperties databaseColumnProperties)`	Set up the principle properties for the database column.
`void`	`setElementHeader(ElementHeader elementHeader)`	Set up the element header associated with the properties.
`void`	`setForeignKeyProperties(DatabaseForeignKeyProperties foreignKeyProperties)`	Set up the properties that indicate that this column is a foreign key.
`void`	`setPrimaryKeyProperties(DatabasePrimaryKeyProperties primaryKeyProperties)`	Set up the properties that indicate this column is a primary key
`void`	`setReferencedColumnGUID(String referencedColumnGUID)`	Set up the unique identifier of the column in another table that this column references through a foreign key relationship.
`void`	`setReferencedColumnQualifiedName(String referencedColumnQualifiedName)`	Set up the unique name of the column in another table that this column references through a foreign key relationship.
`String`	`toString()`	JSON-style toString

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

- Constructor Detail
  - DatabaseColumnElement
```
public DatabaseColumnElement()
```
    Default constructor
  - DatabaseColumnElement
```
public DatabaseColumnElement(DatabaseColumnElement template)
```
    Copy/clone constructor
    
    Parameters:
    
    template - object to copy
- Method Detail
  - getElementHeader
```
public ElementHeader getElementHeader()
```
    Return the element header associated with the properties.
    
    Specified by:
    
    getElementHeader in interface MetadataElement
    
    Returns:
    
    element header object
  - setElementHeader
```
public void setElementHeader(ElementHeader elementHeader)
```
    Set up the element header associated with the properties.
    
    Specified by:
    
    setElementHeader in interface MetadataElement
    
    Parameters:
    
    elementHeader - element header object
  - getDatabaseColumnProperties
```
public DatabaseColumnProperties getDatabaseColumnProperties()
```
    Return the principle properties for the database column.
    
    Returns:
    
    properties bean
  - setDatabaseColumnProperties
```
public void setDatabaseColumnProperties(DatabaseColumnProperties databaseColumnProperties)
```
    Set up the principle properties for the database column.
    
    Parameters:
    
    databaseColumnProperties - properties bean
  - getPrimaryKeyProperties
```
public DatabasePrimaryKeyProperties getPrimaryKeyProperties()
```
    When this column is a primary key, return the properties of the primary key value; otherwise null
    
    Returns:
    
    primary key properties
  - setPrimaryKeyProperties
```
public void setPrimaryKeyProperties(DatabasePrimaryKeyProperties primaryKeyProperties)
```
    Set up the properties that indicate this column is a primary key
    
    Parameters:
    
    primaryKeyProperties - primary key properties
  - getForeignKeyProperties
```
public DatabaseForeignKeyProperties getForeignKeyProperties()
```
    When this column contains the primary key of another table (ie it is a foreign key) return the properties associated with the relationship.
    
    Returns:
    
    foreign key properties
  - setForeignKeyProperties
```
public void setForeignKeyProperties(DatabaseForeignKeyProperties foreignKeyProperties)
```
    Set up the properties that indicate that this column is a foreign key. This is null if the column is not a foreign key.
    
    Parameters:
    
    foreignKeyProperties - foreign key properties
  - getReferencedColumnGUID
```
public String getReferencedColumnGUID()
```
    Return the unique identifier of the column in another table that this column references through a foreign key relationship. This is null if the column is not a foreign key.
    
    Returns:
    
    string unique identifier
  - setReferencedColumnGUID
```
public void setReferencedColumnGUID(String referencedColumnGUID)
```
    Set up the unique identifier of the column in another table that this column references through a foreign key relationship. This is null if the column is not a foreign key.
    
    Parameters:
    
    referencedColumnGUID - string unique identifier
  - getReferencedColumnQualifiedName
```
public String getReferencedColumnQualifiedName()
```
    Return the unique name of the column in another table that this column references through a foreign key relationship. This is null if the column is not a foreign key.
    
    Returns:
    
    string unique identifier
  - setReferencedColumnQualifiedName
```
public void setReferencedColumnQualifiedName(String referencedColumnQualifiedName)
```
    Set up the unique name of the column in another table that this column references through a foreign key relationship. This is null if the column is not a foreign key.
    
    Parameters:
    
    referencedColumnQualifiedName - string unique identifier
  - toString
```
public String toString()
```
    JSON-style toString
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    return string containing the property names and values
  - equals
```
public boolean equals(Object objectToCompare)
```
    Return comparison result based on the content of the properties.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    objectToCompare - test object
    
    Returns:
    
    result of comparison
  - hashCode
```
public int hashCode()
```
    Return hash code for this object
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    int hash code

Constructor	Description
`DatabaseColumnElement()`	Default constructor
`DatabaseColumnElement(DatabaseColumnElement template)`	Copy/clone constructor

Class DatabaseColumnElement

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DatabaseColumnElement

DatabaseColumnElement

Method Detail

getElementHeader

setElementHeader

getDatabaseColumnProperties

setDatabaseColumnProperties

getPrimaryKeyProperties

setPrimaryKeyProperties

getForeignKeyProperties

setForeignKeyProperties

getReferencedColumnGUID

setReferencedColumnGUID

getReferencedColumnQualifiedName

setReferencedColumnQualifiedName

toString

equals

hashCode