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

Class DatabaseDomain

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.DatabaseDomain

public class DatabaseDomain
extends Reference

POJO for the database_domain asset type in IGC, displayed as 'Database Domain' 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 DatabaseSchema	databaseSchema
protected String	dataType Valid values are: INT8 (displayed in the UI as 'INT8') INT16 (displayed in the UI as 'INT16') INT32 (displayed in the UI as 'INT32') INT64 (displayed in the UI as 'INT64') SFLOAT (displayed in the UI as 'SFLOAT') DFLOAT (displayed in the UI as 'DFLOAT') QFLOAT (displayed in the UI as 'QFLOAT') DECIMAL (displayed in the UI as 'DECIMAL') STRING (displayed in the UI as 'STRING') BINARY (displayed in the UI as 'BINARY') BOOLEAN (displayed in the UI as 'BOOLEAN') DATE (displayed in the UI as 'DATE') TIME (displayed in the UI as 'TIME') DATETIME (displayed in the UI as 'DATETIME') DURATION (displayed in the UI as 'DURATION') CHOICE (displayed in the UI as 'CHOICE') ORDERED_GROUP (displayed in the UI as 'ORDERED_GROUP') UNORDERED_GROUP (displayed in the UI as 'UNORDERED_GROUP') GUID (displayed in the UI as 'GUID') UNKNOWN (displayed in the UI as 'UNKNOWN') JSON (displayed in the UI as 'JSON') XML (displayed in the UI as 'XML')
protected Number	fraction
protected Number	length
protected String	longDescription
protected String	name
protected String	nativeId
protected String	odbcType Valid values are: CHAR (displayed in the UI as 'CHAR') VARCHAR (displayed in the UI as 'VARCHAR') LONGVARCHAR (displayed in the UI as 'LONGVARCHAR') WCHAR (displayed in the UI as 'WCHAR') WVARCHAR (displayed in the UI as 'WVARCHAR') WLONGVARCHAR (displayed in the UI as 'WLONGVARCHAR') DECIMAL (displayed in the UI as 'DECIMAL') NUMERIC (displayed in the UI as 'NUMERIC') SMALLINT (displayed in the UI as 'SMALLINT') INTEGER (displayed in the UI as 'INTEGER') REAL (displayed in the UI as 'REAL') FLOAT (displayed in the UI as 'FLOAT') DOUBLE (displayed in the UI as 'DOUBLE') BIT (displayed in the UI as 'BIT') TINYINT (displayed in the UI as 'TINYINT') BIGINT (displayed in the UI as 'BIGINT') BINARY (displayed in the UI as 'BINARY') VARBINARY (displayed in the UI as 'VARBINARY') LONGVARBINARY (displayed in the UI as 'LONGVARBINARY') DATE (displayed in the UI as 'DATE') TIME (displayed in the UI as 'TIME') TIMESTAMP (displayed in the UI as 'TIMESTAMP') GUID (displayed in the UI as 'GUID') UNKNOWN (displayed in the UI as 'UNKNOWN')
protected String	shortDescription
protected ItemList<DataItem>	usedByDataItems

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
DatabaseDomain()

Method Summary

Modifier and Type	Method and Description
DatabaseSchema	getDatabaseSchema() Retrieve the database_schema property (displayed as 'Database Schema') of the object.
String	getDataType() Retrieve the data_type property (displayed as 'Data Type') of the object.
Number	getFraction() Retrieve the fraction property (displayed as 'Scale') of the object.
Number	getLength() Retrieve the length property (displayed as 'Length') of the object.
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.
String	getOdbcType() Retrieve the odbc_type property (displayed as 'ODBC Type') of the object.
String	getShortDescription() Retrieve the short_description property (displayed as 'Short Description') of the object.
String	getTheName() Retrieve the name property (displayed as 'Name') of the object.
ItemList<DataItem>	getUsedByDataItems() Retrieve the used_by_data_items property (displayed as 'Used by Data Items') of the object.
void	setDatabaseSchema(DatabaseSchema databaseSchema) Set the database_schema property (displayed as Database Schema) of the object.
void	setDataType(String dataType) Set the data_type property (displayed as Data Type) of the object.
void	setFraction(Number fraction) Set the fraction property (displayed as Scale) of the object.
void	setLength(Number length) Set the length property (displayed as Length) 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	setOdbcType(String odbcType) Set the odbc_type property (displayed as ODBC Type) of the object.
void	setShortDescription(String shortDescription) Set the short_description property (displayed as Short Description) of the object.
void	setTheName(String name) Set the name property (displayed as Name) of the object.
void	setUsedByDataItems(ItemList<DataItem> usedByDataItems) Set the used_by_data_items property (displayed as Used by Data Items) 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

dataType

protected String dataType

Valid values are:

• INT8 (displayed in the UI as 'INT8')
• INT16 (displayed in the UI as 'INT16')
• INT32 (displayed in the UI as 'INT32')
• INT64 (displayed in the UI as 'INT64')
• SFLOAT (displayed in the UI as 'SFLOAT')
• DFLOAT (displayed in the UI as 'DFLOAT')
• QFLOAT (displayed in the UI as 'QFLOAT')
• DECIMAL (displayed in the UI as 'DECIMAL')
• STRING (displayed in the UI as 'STRING')
• BINARY (displayed in the UI as 'BINARY')
• BOOLEAN (displayed in the UI as 'BOOLEAN')
• DATE (displayed in the UI as 'DATE')
• TIME (displayed in the UI as 'TIME')
• DATETIME (displayed in the UI as 'DATETIME')
• DURATION (displayed in the UI as 'DURATION')
• CHOICE (displayed in the UI as 'CHOICE')
• ORDERED_GROUP (displayed in the UI as 'ORDERED_GROUP')
• UNORDERED_GROUP (displayed in the UI as 'UNORDERED_GROUP')
• GUID (displayed in the UI as 'GUID')
• UNKNOWN (displayed in the UI as 'UNKNOWN')
• JSON (displayed in the UI as 'JSON')
• XML (displayed in the UI as 'XML')

databaseSchema

protected DatabaseSchema databaseSchema

fraction

protected Number fraction

length

protected Number length

longDescription

protected String longDescription

name

protected String name

nativeId

protected String nativeId

odbcType

protected String odbcType

Valid values are:

• CHAR (displayed in the UI as 'CHAR')
• VARCHAR (displayed in the UI as 'VARCHAR')
• LONGVARCHAR (displayed in the UI as 'LONGVARCHAR')
• WCHAR (displayed in the UI as 'WCHAR')
• WVARCHAR (displayed in the UI as 'WVARCHAR')
• WLONGVARCHAR (displayed in the UI as 'WLONGVARCHAR')
• DECIMAL (displayed in the UI as 'DECIMAL')
• NUMERIC (displayed in the UI as 'NUMERIC')
• SMALLINT (displayed in the UI as 'SMALLINT')
• INTEGER (displayed in the UI as 'INTEGER')
• REAL (displayed in the UI as 'REAL')
• FLOAT (displayed in the UI as 'FLOAT')
• DOUBLE (displayed in the UI as 'DOUBLE')
• BIT (displayed in the UI as 'BIT')
• TINYINT (displayed in the UI as 'TINYINT')
• BIGINT (displayed in the UI as 'BIGINT')
• BINARY (displayed in the UI as 'BINARY')
• VARBINARY (displayed in the UI as 'VARBINARY')
• LONGVARBINARY (displayed in the UI as 'LONGVARBINARY')
• DATE (displayed in the UI as 'DATE')
• TIME (displayed in the UI as 'TIME')
• TIMESTAMP (displayed in the UI as 'TIMESTAMP')
• GUID (displayed in the UI as 'GUID')
• UNKNOWN (displayed in the UI as 'UNKNOWN')

shortDescription

protected String shortDescription

usedByDataItems

protected ItemList<DataItem> usedByDataItems

Constructor Detail

DatabaseDomain

public DatabaseDomain()

Method Detail

getDataType

public String getDataType()

Retrieve the data_type property (displayed as 'Data Type') of the object.

Returns:

String

setDataType

public void setDataType(String dataType)

Set the data_type property (displayed as Data Type) of the object.

Parameters:

dataType - the value to set

getDatabaseSchema

public DatabaseSchema getDatabaseSchema()

Retrieve the database_schema property (displayed as 'Database Schema') of the object.

Returns:

DatabaseSchema

setDatabaseSchema

public void setDatabaseSchema(DatabaseSchema databaseSchema)

Set the database_schema property (displayed as Database Schema) of the object.

Parameters:

databaseSchema - the value to set

getFraction

public Number getFraction()

Retrieve the fraction property (displayed as 'Scale') of the object.

Returns:

Number

setFraction

public void setFraction(Number fraction)

Set the fraction property (displayed as Scale) of the object.

Parameters:

fraction - the value to set

getLength

public Number getLength()

Retrieve the length property (displayed as 'Length') of the object.

Returns:

Number

setLength

public void setLength(Number length)

Set the length property (displayed as Length) of the object.

Parameters:

length - the value to set

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

getOdbcType

public String getOdbcType()

Retrieve the odbc_type property (displayed as 'ODBC Type') of the object.

Returns:

String

setOdbcType

public void setOdbcType(String odbcType)

Set the odbc_type property (displayed as ODBC Type) of the object.

Parameters:

odbcType - 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

getUsedByDataItems

public ItemList<DataItem> getUsedByDataItems()

Retrieve the used_by_data_items property (displayed as 'Used by Data Items') of the object.

Returns:

ItemList<DataItem>

setUsedByDataItems

public void setUsedByDataItems(ItemList<DataItem> usedByDataItems)

Set the used_by_data_items property (displayed as Used by Data Items) of the object.

Parameters:

usedByDataItems - the value to set