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

Class DataItem

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

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

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

Direct Known Subclasses:

DataField, DataItemDefinition, Parameter, RoutineArgument, StageColumn, StageTypeDetail, StageVariable, TransformArgument

public class DataItem
extends InformationAsset

POJO for the data_item asset type in IGC, displayed as 'Data Item' 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	allowNullValues
protected Boolean	allowsEmptyValue
protected Boolean	allowsNullValues
protected String	basedOn
protected String	calendar
protected DataItemDefinition	dataItemDefinition
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 String	defaultValue
protected Number	displaySize
protected Number	fraction
protected ItemList<Array>	hasDimension
protected Boolean	isComputed
protected Boolean	isSigned
protected String	itemKind
protected List<Number>	length
protected Number	level
protected Number	minimumLength
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 Number	position
protected String	type
protected Boolean	unique
protected ItemList<DataItemValue>	validatedByDataValues

Fields inherited from class org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.base.InformationAsset

blueprintElements, impactedBy, impactsOn, inCollections, nativeId, readByDesign, readByOperational, readByStatic, readByUserDefined, writtenByDesign, writtenByOperational, writtenByStatic, writtenByUserDefined

Fields inherited from class org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.base.MainObject

assignedToTerms, governedByRules, implementsRules, labels, longDescription, name, shortDescription, stewards

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

Method Summary

Modifier and Type	Method and Description
String	getAllowNullValues() Retrieve the allow_null_values property (displayed as 'Null Value') of the object.
Boolean	getAllowsEmptyValue() Retrieve the allows_empty_value property (displayed as 'Allows Empty Value') of the object.
Boolean	getAllowsNullValues() Retrieve the allows_null_values property (displayed as 'Allow Null Values') of the object.
String	getBasedOn() Retrieve the based_on property (displayed as 'Based On') of the object.
String	getCalendar() Retrieve the calendar property (displayed as 'Calendar') of the object.
DataItemDefinition	getDataItemDefinition() Retrieve the data_item_definition property (displayed as 'Data Item Definition') of the object.
String	getDataType() Retrieve the data_type property (displayed as 'Type Code') of the object.
String	getDefaultValue() Retrieve the default_value property (displayed as 'Default Value') of the object.
Number	getDisplaySize() Retrieve the display_size property (displayed as 'Display Size') of the object.
Number	getFraction() Retrieve the fraction property (displayed as 'Scale') of the object.
ItemList<Array>	getHasDimension() Retrieve the has_dimension property (displayed as 'Has Dimension') of the object.
Boolean	getIsComputed() Retrieve the is_computed property (displayed as 'Is Computed') of the object.
Boolean	getIsSigned() Retrieve the is_signed property (displayed as 'Is Signed') of the object.
String	getItemKind() Retrieve the item_kind property (displayed as 'Item Kind') of the object.
List<Number>	getLength() Retrieve the length property (displayed as 'Maximum Length') of the object.
Number	getLevel() Retrieve the level property (displayed as 'Level Number') of the object.
Number	getMinimumLength() Retrieve the minimum_length property (displayed as 'Minimum Length') of the object.
String	getOdbcType() Retrieve the odbc_type property (displayed as 'ODBC Type') of the object.
Number	getPosition() Retrieve the position property (displayed as 'Position') of the object.
String	getTheType() Retrieve the type property (displayed as 'Native Type') of the object.
Boolean	getUnique() Retrieve the unique property (displayed as 'Unique') of the object.
ItemList<DataItemValue>	getValidatedByDataValues() Retrieve the validated_by_data_values property (displayed as 'Validated By Data Values') of the object.
void	setAllowNullValues(String allowNullValues) Set the allow_null_values property (displayed as Null Value) of the object.
void	setAllowsEmptyValue(Boolean allowsEmptyValue) Set the allows_empty_value property (displayed as Allows Empty Value) of the object.
void	setAllowsNullValues(Boolean allowsNullValues) Set the allows_null_values property (displayed as Allow Null Values) of the object.
void	setBasedOn(String basedOn) Set the based_on property (displayed as Based On) of the object.
void	setCalendar(String calendar) Set the calendar property (displayed as Calendar) of the object.
void	setDataItemDefinition(DataItemDefinition dataItemDefinition) Set the data_item_definition property (displayed as Data Item Definition) of the object.
void	setDataType(String dataType) Set the data_type property (displayed as Type Code) of the object.
void	setDefaultValue(String defaultValue) Set the default_value property (displayed as Default Value) of the object.
void	setDisplaySize(Number displaySize) Set the display_size property (displayed as Display Size) of the object.
void	setFraction(Number fraction) Set the fraction property (displayed as Scale) of the object.
void	setHasDimension(ItemList<Array> hasDimension) Set the has_dimension property (displayed as Has Dimension) of the object.
void	setIsComputed(Boolean isComputed) Set the is_computed property (displayed as Is Computed) of the object.
void	setIsSigned(Boolean isSigned) Set the is_signed property (displayed as Is Signed) of the object.
void	setItemKind(String itemKind) Set the item_kind property (displayed as Item Kind) of the object.
void	setLength(List<Number> length) Set the length property (displayed as Maximum Length) of the object.
void	setLevel(Number level) Set the level property (displayed as Level Number) of the object.
void	setMinimumLength(Number minimumLength) Set the minimum_length property (displayed as Minimum Length) of the object.
void	setOdbcType(String odbcType) Set the odbc_type property (displayed as ODBC Type) of the object.
void	setPosition(Number position) Set the position property (displayed as Position) of the object.
void	setTheType(String type) Set the type property (displayed as Native Type) of the object.
void	setUnique(Boolean unique) Set the unique property (displayed as Unique) of the object.
void	setValidatedByDataValues(ItemList<DataItemValue> validatedByDataValues) Set the validated_by_data_values property (displayed as Validated By Data Values) of the object.

Methods inherited from class org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.base.InformationAsset

getBlueprintElements, getImpactedBy, getImpactsOn, getInCollections, getNativeId, getReadByDesign, getReadByOperational, getReadByStatic, getReadByUserDefined, getWrittenByDesign, getWrittenByOperational, getWrittenByStatic, getWrittenByUserDefined, setBlueprintElements, setImpactedBy, setImpactsOn, setInCollections, setNativeId, setReadByDesign, setReadByOperational, setReadByStatic, setReadByUserDefined, setWrittenByDesign, setWrittenByOperational, setWrittenByStatic, setWrittenByUserDefined

Methods inherited from class org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.base.MainObject

getAssignedToTerms, getGovernedByRules, getImplementsRules, getLabels, getLongDescription, getShortDescription, getStewards, getTheName, setAssignedToTerms, setGovernedByRules, setImplementsRules, setLabels, setLongDescription, setShortDescription, setStewards, setTheName

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

allowNullValues

protected String allowNullValues

allowsEmptyValue

protected Boolean allowsEmptyValue

allowsNullValues

protected Boolean allowsNullValues

basedOn

protected String basedOn

calendar

protected String calendar

dataItemDefinition

protected DataItemDefinition dataItemDefinition

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')

defaultValue

protected String defaultValue

displaySize

protected Number displaySize

fraction

protected Number fraction

hasDimension

protected ItemList<Array> hasDimension

isComputed

protected Boolean isComputed

isSigned

protected Boolean isSigned

itemKind

protected String itemKind

length

protected List<Number> length

level

protected Number level

minimumLength

protected Number minimumLength

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')

position

protected Number position

type

protected String type

unique

protected Boolean unique

validatedByDataValues

protected ItemList<DataItemValue> validatedByDataValues

Constructor Detail

DataItem

public DataItem()

Method Detail

getAllowNullValues

public String getAllowNullValues()

Retrieve the allow_null_values property (displayed as 'Null Value') of the object.

Returns:

String

setAllowNullValues

public void setAllowNullValues(String allowNullValues)

Set the allow_null_values property (displayed as Null Value) of the object.

Parameters:

allowNullValues - the value to set

getAllowsEmptyValue

public Boolean getAllowsEmptyValue()

Retrieve the allows_empty_value property (displayed as 'Allows Empty Value') of the object.

Returns:

Boolean

setAllowsEmptyValue

public void setAllowsEmptyValue(Boolean allowsEmptyValue)

Set the allows_empty_value property (displayed as Allows Empty Value) of the object.

Parameters:

allowsEmptyValue - the value to set

getAllowsNullValues

public Boolean getAllowsNullValues()

Retrieve the allows_null_values property (displayed as 'Allow Null Values') of the object.

Returns:

Boolean

setAllowsNullValues

public void setAllowsNullValues(Boolean allowsNullValues)

Set the allows_null_values property (displayed as Allow Null Values) of the object.

Parameters:

allowsNullValues - the value to set

getBasedOn

public String getBasedOn()

Retrieve the based_on property (displayed as 'Based On') of the object.

Returns:

String

setBasedOn

public void setBasedOn(String basedOn)

Set the based_on property (displayed as Based On) of the object.

Parameters:

basedOn - the value to set

getCalendar

public String getCalendar()

Retrieve the calendar property (displayed as 'Calendar') of the object.

Returns:

String

setCalendar

public void setCalendar(String calendar)

Set the calendar property (displayed as Calendar) of the object.

Parameters:

calendar - the value to set

getDataItemDefinition

public DataItemDefinition getDataItemDefinition()

Retrieve the data_item_definition property (displayed as 'Data Item Definition') of the object.

Returns:

DataItemDefinition

setDataItemDefinition

public void setDataItemDefinition(DataItemDefinition dataItemDefinition)

Set the data_item_definition property (displayed as Data Item Definition) of the object.

Parameters:

dataItemDefinition - the value to set

getDataType

public String getDataType()

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

Returns:

String

setDataType

public void setDataType(String dataType)

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

Parameters:

dataType - the value to set

getDefaultValue

public String getDefaultValue()

Retrieve the default_value property (displayed as 'Default Value') of the object.

Returns:

String

setDefaultValue

public void setDefaultValue(String defaultValue)

Set the default_value property (displayed as Default Value) of the object.

Parameters:

defaultValue - the value to set

getDisplaySize

public Number getDisplaySize()

Retrieve the display_size property (displayed as 'Display Size') of the object.

Returns:

Number

setDisplaySize

public void setDisplaySize(Number displaySize)

Set the display_size property (displayed as Display Size) of the object.

Parameters:

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

getHasDimension

public ItemList<Array> getHasDimension()

Retrieve the has_dimension property (displayed as 'Has Dimension') of the object.

Returns:

ItemList<Array>

setHasDimension

public void setHasDimension(ItemList<Array> hasDimension)

Set the has_dimension property (displayed as Has Dimension) of the object.

Parameters:

hasDimension - the value to set

getIsComputed

public Boolean getIsComputed()

Retrieve the is_computed property (displayed as 'Is Computed') of the object.

Returns:

Boolean

setIsComputed

public void setIsComputed(Boolean isComputed)

Set the is_computed property (displayed as Is Computed) of the object.

Parameters:

isComputed - the value to set

getIsSigned

public Boolean getIsSigned()

Retrieve the is_signed property (displayed as 'Is Signed') of the object.

Returns:

Boolean

setIsSigned

public void setIsSigned(Boolean isSigned)

Set the is_signed property (displayed as Is Signed) of the object.

Parameters:

isSigned - the value to set

getItemKind

public String getItemKind()

Retrieve the item_kind property (displayed as 'Item Kind') of the object.

Returns:

String

setItemKind

public void setItemKind(String itemKind)

Set the item_kind property (displayed as Item Kind) of the object.

Parameters:

itemKind - the value to set

getLength

public List<Number> getLength()

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

Returns:

List<Number>

setLength

public void setLength(List<Number> length)

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

Parameters:

length - the value to set

getLevel

public Number getLevel()

Retrieve the level property (displayed as 'Level Number') of the object.

Returns:

Number

setLevel

public void setLevel(Number level)

Set the level property (displayed as Level Number) of the object.

Parameters:

level - the value to set

getMinimumLength

public Number getMinimumLength()

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

Returns:

Number

setMinimumLength

public void setMinimumLength(Number minimumLength)

Set the minimum_length property (displayed as Minimum Length) of the object.

Parameters:

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

getPosition

public Number getPosition()

Retrieve the position property (displayed as 'Position') of the object.

Returns:

Number

setPosition

public void setPosition(Number position)

Set the position property (displayed as Position) of the object.

Parameters:

position - the value to set

getTheType

public String getTheType()

Retrieve the type property (displayed as 'Native Type') of the object.

Returns:

String

setTheType

public void setTheType(String type)

Set the type property (displayed as Native Type) of the object.

Parameters:

type - the value to set

getUnique

public Boolean getUnique()

Retrieve the unique property (displayed as 'Unique') of the object.

Returns:

Boolean

setUnique

public void setUnique(Boolean unique)

Set the unique property (displayed as Unique) of the object.

Parameters:

unique - the value to set

getValidatedByDataValues

public ItemList<DataItemValue> getValidatedByDataValues()

Retrieve the validated_by_data_values property (displayed as 'Validated By Data Values') of the object.

Returns:

ItemList<DataItemValue>

setValidatedByDataValues

public void setValidatedByDataValues(ItemList<DataItemValue> validatedByDataValues)

Set the validated_by_data_values property (displayed as Validated By Data Values) of the object.

Parameters:

validatedByDataValues - the value to set