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

Class IdocField

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

public class IdocField
extends InformationAsset

POJO for the idoc_field asset type in IGC, displayed as 'IDoc Field' 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	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 ItemList<IdocSegmentType>	idocSegmentType
protected ItemList<IdocType>	idocType
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	type
protected ItemList<AnalyticsObject>	usedByAnalyticsObjects

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

Method Summary

Modifier and Type	Method and Description
String	getDataType() Retrieve the data_type property (displayed as 'Data Type') of the object.
ItemList<IdocSegmentType>	getIdocSegmentType() Retrieve the idoc_segment_type property (displayed as 'IDoc Segment Type') of the object.
ItemList<IdocType>	getIdocType() Retrieve the idoc_type property (displayed as 'IDoc Type') of the object.
String	getOdbcType() Retrieve the odbc_type property (displayed as 'ODBC Type') of the object.
String	getTheType() Retrieve the type property (displayed as 'Native Type') of the object.
ItemList<AnalyticsObject>	getUsedByAnalyticsObjects() Retrieve the used_by_analytics_objects property (displayed as 'Used By Data Science') of the object.
void	setDataType(String dataType) Set the data_type property (displayed as Data Type) of the object.
void	setIdocSegmentType(ItemList<IdocSegmentType> idocSegmentType) Set the idoc_segment_type property (displayed as IDoc Segment Type) of the object.
void	setIdocType(ItemList<IdocType> idocType) Set the idoc_type property (displayed as IDoc Type) of the object.
void	setOdbcType(String odbcType) Set the odbc_type property (displayed as ODBC Type) of the object.
void	setTheType(String type) Set the type property (displayed as Native Type) of the object.
void	setUsedByAnalyticsObjects(ItemList<AnalyticsObject> usedByAnalyticsObjects) Set the used_by_analytics_objects property (displayed as Used By Data Science) 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

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

idocSegmentType

protected ItemList<IdocSegmentType> idocSegmentType

idocType

protected ItemList<IdocType> idocType

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

type

protected String type

usedByAnalyticsObjects

protected ItemList<AnalyticsObject> usedByAnalyticsObjects

Constructor Detail

IdocField

public IdocField()

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

getIdocSegmentType

public ItemList<IdocSegmentType> getIdocSegmentType()

Retrieve the idoc_segment_type property (displayed as 'IDoc Segment Type') of the object.

Returns:

ItemList<IdocSegmentType>

setIdocSegmentType

public void setIdocSegmentType(ItemList<IdocSegmentType> idocSegmentType)

Set the idoc_segment_type property (displayed as IDoc Segment Type) of the object.

Parameters:

idocSegmentType - the value to set

getIdocType

public ItemList<IdocType> getIdocType()

Retrieve the idoc_type property (displayed as 'IDoc Type') of the object.

Returns:

ItemList<IdocType>

setIdocType

public void setIdocType(ItemList<IdocType> idocType)

Set the idoc_type property (displayed as IDoc Type) of the object.

Parameters:

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

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

getUsedByAnalyticsObjects

public ItemList<AnalyticsObject> getUsedByAnalyticsObjects()

Retrieve the used_by_analytics_objects property (displayed as 'Used By Data Science') of the object.

Returns:

ItemList<AnalyticsObject>

setUsedByAnalyticsObjects

public void setUsedByAnalyticsObjects(ItemList<AnalyticsObject> usedByAnalyticsObjects)

Set the used_by_analytics_objects property (displayed as Used By Data Science) of the object.

Parameters:

usedByAnalyticsObjects - the value to set