org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.base

Class InferredForeignKey

java.lang.Object

org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.common.ObjectPrinter

org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.common.Reference

org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.base.InferredForeignKey

public class InferredForeignKey
extends Reference

POJO for the inferred_foreign_key asset type in IGC, displayed as 'Inferred Foreign Key' in the IGC UI.

(this code has been created based on out-of-the-box IGC metadata types. If modifications are needed, eg. to handle custom attributes, extending from this class in your own custom class is the best approach.)

Field Summary

Fields

Modifier and Type	Field and Description
protected String	longDescription
protected String	name
protected String	nativeId
protected InferredKey	referencesInferredKeys
protected String	shortDescription
protected MainObject	tableAnalysis
protected Number	totalRecords
protected ItemList<DatabaseColumn>	usesDatabaseFields

Fields inherited from class org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.common.Reference

_context, _id, _name, _type, _url, createdBy, createdOn, modifiedBy, modifiedOn, notes

Constructor Summary

Constructors

Constructor and Description
InferredForeignKey()

Method Summary

Modifier and Type	Method and Description
String	getLongDescription() Retrieve the long_description property (displayed as 'Long Description') of the object.
String	getNativeId() Retrieve the native_id property (displayed as 'Native ID') of the object.
InferredKey	getReferencesInferredKeys() Retrieve the references_inferred_keys property (displayed as 'References Inferred Keys') of the object.
String	getShortDescription() Retrieve the short_description property (displayed as 'Short Description') of the object.
MainObject	getTableAnalysis() Retrieve the table_analysis property (displayed as 'Table Analysis') of the object.
String	getTheName() Retrieve the name property (displayed as 'Name') of the object.
Number	getTotalRecords() Retrieve the total_records property (displayed as 'Total Records') of the object.
ItemList<DatabaseColumn>	getUsesDatabaseFields() Retrieve the uses_database_fields property (displayed as 'Uses Database Fields') of the object.
void	setLongDescription(String longDescription) Set the long_description property (displayed as Long Description) of the object.
void	setNativeId(String nativeId) Set the native_id property (displayed as Native ID) of the object.
void	setReferencesInferredKeys(InferredKey referencesInferredKeys) Set the references_inferred_keys property (displayed as References Inferred Keys) of the object.
void	setShortDescription(String shortDescription) Set the short_description property (displayed as Short Description) of the object.
void	setTableAnalysis(MainObject tableAnalysis) Set the table_analysis property (displayed as Table Analysis) of the object.
void	setTheName(String name) Set the name property (displayed as Name) of the object.
void	setTotalRecords(Number totalRecords) Set the total_records property (displayed as Total Records) of the object.
void	setUsesDatabaseFields(ItemList<DatabaseColumn> usesDatabaseFields) Set the uses_database_fields property (displayed as Uses Database Fields) of the object.

Methods inherited from class org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.common.Reference

areModificationDetailsPopulated, getContext, getCreatedBy, getCreatedOn, getId, getIdentity, getModifiedBy, getModifiedOn, getName, getNotes, getType, getUrl, isEmbeddedAsset, isFullyRetrieved, isIdentityPopulated, isSimpleType, isVirtualAsset, setContext, setCreatedBy, setCreatedOn, setFullyRetrieved, setId, setModifiedBy, setModifiedOn, setName, setNotes, setType, setUrl

Methods inherited from class org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.common.ObjectPrinter

toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

longDescription

protected String longDescription

name

protected String name

nativeId

protected String nativeId

referencesInferredKeys

protected InferredKey referencesInferredKeys

shortDescription

protected String shortDescription

tableAnalysis

protected MainObject tableAnalysis

totalRecords

protected Number totalRecords

usesDatabaseFields

protected ItemList<DatabaseColumn> usesDatabaseFields

Constructor Detail

InferredForeignKey

public InferredForeignKey()

Method Detail

getLongDescription

public String getLongDescription()

Retrieve the long_description property (displayed as 'Long Description') of the object.

Returns:

String

setLongDescription

public void setLongDescription(String longDescription)

Set the long_description property (displayed as Long Description) of the object.

Parameters:

longDescription - the value to set

getTheName

public String getTheName()

Retrieve the name property (displayed as 'Name') of the object.

Returns:

String

setTheName

public void setTheName(String name)

Set the name property (displayed as Name) of the object.

Parameters:

name - the value to set

getNativeId

public String getNativeId()

Retrieve the native_id property (displayed as 'Native ID') of the object.

Returns:

String

setNativeId

public void setNativeId(String nativeId)

Set the native_id property (displayed as Native ID) of the object.

Parameters:

nativeId - the value to set

getReferencesInferredKeys

public InferredKey getReferencesInferredKeys()

Retrieve the references_inferred_keys property (displayed as 'References Inferred Keys') of the object.

Returns:

InferredKey

setReferencesInferredKeys

public void setReferencesInferredKeys(InferredKey referencesInferredKeys)

Set the references_inferred_keys property (displayed as References Inferred Keys) of the object.

Parameters:

referencesInferredKeys - the value to set

getShortDescription

public String getShortDescription()

Retrieve the short_description property (displayed as 'Short Description') of the object.

Returns:

String

setShortDescription

public void setShortDescription(String shortDescription)

Set the short_description property (displayed as Short Description) of the object.

Parameters:

shortDescription - the value to set

getTableAnalysis

public MainObject getTableAnalysis()

Retrieve the table_analysis property (displayed as 'Table Analysis') of the object.

Returns:

MainObject

setTableAnalysis

public void setTableAnalysis(MainObject tableAnalysis)

Set the table_analysis property (displayed as Table Analysis) of the object.

Parameters:

tableAnalysis - the value to set

getTotalRecords

public Number getTotalRecords()

Retrieve the total_records property (displayed as 'Total Records') of the object.

Returns:

Number

setTotalRecords

public void setTotalRecords(Number totalRecords)

Set the total_records property (displayed as Total Records) of the object.

Parameters:

totalRecords - the value to set

getUsesDatabaseFields

public ItemList<DatabaseColumn> getUsesDatabaseFields()

Retrieve the uses_database_fields property (displayed as 'Uses Database Fields') of the object.

Returns:

ItemList<DatabaseColumn>

setUsesDatabaseFields

public void setUsesDatabaseFields(ItemList<DatabaseColumn> usesDatabaseFields)

Set the uses_database_fields property (displayed as Uses Database Fields) of the object.

Parameters:

usesDatabaseFields - the value to set