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

Class DataFileDefinitionField

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

public class DataFileDefinitionField
extends InformationAsset

POJO for the data_file_definition_field asset type in IGC, displayed as 'Data File Definition 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 Boolean	allowsNullValues
protected DataFileDefinitionRecord	dataFileDefinitionRecord
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 String	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

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

Method Summary

Modifier and Type	Method and Description
Boolean	getAllowsNullValues() Retrieve the allows_null_values property (displayed as 'Allow Null Values') of the object.
DataFileDefinitionRecord	getDataFileDefinitionRecord() Retrieve the data_file_definition_record property (displayed as 'Data File Definition Record') 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.
String	getLength() Retrieve the length property (displayed as '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 Constraint') of the object.
void	setAllowsNullValues(Boolean allowsNullValues) Set the allows_null_values property (displayed as Allow Null Values) of the object.
void	setDataFileDefinitionRecord(DataFileDefinitionRecord dataFileDefinitionRecord) Set the data_file_definition_record property (displayed as Data File Definition Record) 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(String length) Set the length property (displayed as 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 Constraint) 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

allowsNullValues

protected Boolean allowsNullValues

dataFileDefinitionRecord

protected DataFileDefinitionRecord dataFileDefinitionRecord

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

fraction

protected Number fraction

length

protected String 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

Constructor Detail

DataFileDefinitionField

public DataFileDefinitionField()

Method Detail

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

getDataFileDefinitionRecord

public DataFileDefinitionRecord getDataFileDefinitionRecord()

Retrieve the data_file_definition_record property (displayed as 'Data File Definition Record') of the object.

Returns:

DataFileDefinitionRecord

setDataFileDefinitionRecord

public void setDataFileDefinitionRecord(DataFileDefinitionRecord dataFileDefinitionRecord)

Set the data_file_definition_record property (displayed as Data File Definition Record) of the object.

Parameters:

dataFileDefinitionRecord - the value to set

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

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 String getLength()

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

Returns:

String

setLength

public void setLength(String length)

Set the length property (displayed as 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 Constraint') of the object.

Returns:

Boolean

setUnique

public void setUnique(Boolean unique)

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

Parameters:

unique - the value to set