org.odpi.openmetadata.accessservices.datamanager.metadataelements

Class DatabaseColumnElement

java.lang.Object

org.odpi.openmetadata.accessservices.datamanager.properties.ReferenceableProperties

org.odpi.openmetadata.accessservices.datamanager.properties.SchemaElementProperties

org.odpi.openmetadata.accessservices.datamanager.properties.SchemaAttributeProperties

org.odpi.openmetadata.accessservices.datamanager.properties.TabularColumnProperties

org.odpi.openmetadata.accessservices.datamanager.properties.DatabaseColumnProperties

org.odpi.openmetadata.accessservices.datamanager.metadataelements.DatabaseColumnElement

All Implemented Interfaces:

Serializable, MetadataElement

public class DatabaseColumnElement
extends DatabaseColumnProperties
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 and Description
DatabaseColumnElement() Default constructor
DatabaseColumnElement(DatabaseColumnElement template) Copy/clone constructor

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object objectToCompare) Return comparison result based on the content of the properties.
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	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 org.odpi.openmetadata.accessservices.datamanager.properties.DatabaseColumnProperties

getFormula, getQueries, setFormula, setQueries

Methods inherited from class org.odpi.openmetadata.accessservices.datamanager.properties.TabularColumnProperties

getDataType, getDefaultValue, setDataType, setDefaultValue

Methods inherited from class org.odpi.openmetadata.accessservices.datamanager.properties.SchemaAttributeProperties

getAliases, getAnchorGUID, getDefaultValueOverride, getElementPosition, getLength, getMaxCardinality, getMinCardinality, getMinimumLength, getNativeJavaClass, getSignificantDigits, getSortOrder, isAllowsDuplicateValues, isNullable, isOrderedValues, setAliases, setAllowsDuplicateValues, setAnchorGUID, setDefaultValueOverride, setElementPosition, setLength, setMaxCardinality, setMinCardinality, setMinimumLength, setNativeJavaClass, setNullable, setOrderedValues, setSignificantDigits, setSortOrder

Methods inherited from class org.odpi.openmetadata.accessservices.datamanager.properties.SchemaElementProperties

getDescription, getDisplayName, isDeprecated, setDeprecated, setDescription, setDisplayName

Methods inherited from class org.odpi.openmetadata.accessservices.datamanager.properties.ReferenceableProperties

getAdditionalProperties, getExtendedProperties, getQualifiedName, getTypeName, getVendorProperties, setAdditionalProperties, setExtendedProperties, setQualifiedName, setTypeName, setVendorProperties

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

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 DatabaseColumnProperties

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 DatabaseColumnProperties

Parameters:

objectToCompare - test object

Returns:

result of comparison

hashCode

public int hashCode()

Return hash code for this object

Overrides:

hashCode in class DatabaseColumnProperties

Returns:

int hash code