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

Class AnalyticsModel

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

public class AnalyticsModel
extends InformationAsset

POJO for the analytics_model asset type in IGC, displayed as 'Data Science Model' 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 AnalyticsProject	analyticsProject
protected ItemList<ModelEvalMetric>	evalMetric
protected Date	firstPublishedDate
protected ItemList<DataField>	inputTrainingColumn
protected ItemList<Notebook>	inputTrainingNotebook
protected ItemList<AnalyticsScript>	inputTrainingScript
protected ItemList<DataField>	labelTrainingColumn
protected String	logicalName
protected String	modelQuality
protected String	modelType
protected String	packageName
protected String	systemEquivId
protected String	url
protected Number	version

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

Method Summary

Modifier and Type	Method and Description
AnalyticsProject	getAnalyticsProject() Retrieve the analytics_project property (displayed as 'Data Science Project') of the object.
ItemList<ModelEvalMetric>	getEvalMetric() Retrieve the eval_metric property (displayed as 'Eval Metric') of the object.
Date	getFirstPublishedDate() Retrieve the first_published_date property (displayed as 'First Published Date') of the object.
ItemList<DataField>	getInputTrainingColumn() Retrieve the input_training_column property (displayed as 'Input Data Assets') of the object.
ItemList<Notebook>	getInputTrainingNotebook() Retrieve the input_training_notebook property (displayed as 'Notebooks') of the object.
ItemList<AnalyticsScript>	getInputTrainingScript() Retrieve the input_training_script property (displayed as 'Scripts') of the object.
ItemList<DataField>	getLabelTrainingColumn() Retrieve the label_training_column property (displayed as 'Output Data Assets') of the object.
String	getLogicalName() Retrieve the logical_name property (displayed as 'Logical Name') of the object.
String	getModelQuality() Retrieve the model_quality property (displayed as 'Quality') of the object.
String	getModelType() Retrieve the model_type property (displayed as 'Type') of the object.
String	getPackageName() Retrieve the package_name property (displayed as 'Package Name') of the object.
String	getSystemEquivId() Retrieve the system_equiv_id property (displayed as 'System Equiv Id') of the object.
String	getTheUrl() Retrieve the url property (displayed as 'URL') of the object.
Number	getVersion() Retrieve the version property (displayed as 'Version') of the object.
void	setAnalyticsProject(AnalyticsProject analyticsProject) Set the analytics_project property (displayed as Data Science Project) of the object.
void	setEvalMetric(ItemList<ModelEvalMetric> evalMetric) Set the eval_metric property (displayed as Eval Metric) of the object.
void	setFirstPublishedDate(Date firstPublishedDate) Set the first_published_date property (displayed as First Published Date) of the object.
void	setInputTrainingColumn(ItemList<DataField> inputTrainingColumn) Set the input_training_column property (displayed as Input Data Assets) of the object.
void	setInputTrainingNotebook(ItemList<Notebook> inputTrainingNotebook) Set the input_training_notebook property (displayed as Notebooks) of the object.
void	setInputTrainingScript(ItemList<AnalyticsScript> inputTrainingScript) Set the input_training_script property (displayed as Scripts) of the object.
void	setLabelTrainingColumn(ItemList<DataField> labelTrainingColumn) Set the label_training_column property (displayed as Output Data Assets) of the object.
void	setLogicalName(String logicalName) Set the logical_name property (displayed as Logical Name) of the object.
void	setModelQuality(String modelQuality) Set the model_quality property (displayed as Quality) of the object.
void	setModelType(String modelType) Set the model_type property (displayed as Type) of the object.
void	setPackageName(String packageName) Set the package_name property (displayed as Package Name) of the object.
void	setSystemEquivId(String systemEquivId) Set the system_equiv_id property (displayed as System Equiv Id) of the object.
void	setTheUrl(String url) Set the url property (displayed as URL) of the object.
void	setVersion(Number version) Set the version property (displayed as Version) 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

analyticsProject

protected AnalyticsProject analyticsProject

evalMetric

protected ItemList<ModelEvalMetric> evalMetric

firstPublishedDate

protected Date firstPublishedDate

inputTrainingColumn

protected ItemList<DataField> inputTrainingColumn

inputTrainingNotebook

protected ItemList<Notebook> inputTrainingNotebook

inputTrainingScript

protected ItemList<AnalyticsScript> inputTrainingScript

labelTrainingColumn

protected ItemList<DataField> labelTrainingColumn

logicalName

protected String logicalName

modelQuality

protected String modelQuality

modelType

protected String modelType

packageName

protected String packageName

systemEquivId

protected String systemEquivId

url

protected String url

version

protected Number version

Constructor Detail

AnalyticsModel

public AnalyticsModel()

Method Detail

getAnalyticsProject

public AnalyticsProject getAnalyticsProject()

Retrieve the analytics_project property (displayed as 'Data Science Project') of the object.

Returns:

AnalyticsProject

setAnalyticsProject

public void setAnalyticsProject(AnalyticsProject analyticsProject)

Set the analytics_project property (displayed as Data Science Project) of the object.

Parameters:

analyticsProject - the value to set

getEvalMetric

public ItemList<ModelEvalMetric> getEvalMetric()

Retrieve the eval_metric property (displayed as 'Eval Metric') of the object.

Returns:

ItemList<ModelEvalMetric>

setEvalMetric

public void setEvalMetric(ItemList<ModelEvalMetric> evalMetric)

Set the eval_metric property (displayed as Eval Metric) of the object.

Parameters:

evalMetric - the value to set

getFirstPublishedDate

public Date getFirstPublishedDate()

Retrieve the first_published_date property (displayed as 'First Published Date') of the object.

Returns:

Date

setFirstPublishedDate

public void setFirstPublishedDate(Date firstPublishedDate)

Set the first_published_date property (displayed as First Published Date) of the object.

Parameters:

firstPublishedDate - the value to set

getInputTrainingColumn

public ItemList<DataField> getInputTrainingColumn()

Retrieve the input_training_column property (displayed as 'Input Data Assets') of the object.

Returns:

ItemList<DataField>

setInputTrainingColumn

public void setInputTrainingColumn(ItemList<DataField> inputTrainingColumn)

Set the input_training_column property (displayed as Input Data Assets) of the object.

Parameters:

inputTrainingColumn - the value to set

getInputTrainingNotebook

public ItemList<Notebook> getInputTrainingNotebook()

Retrieve the input_training_notebook property (displayed as 'Notebooks') of the object.

Returns:

ItemList<Notebook>

setInputTrainingNotebook

public void setInputTrainingNotebook(ItemList<Notebook> inputTrainingNotebook)

Set the input_training_notebook property (displayed as Notebooks) of the object.

Parameters:

inputTrainingNotebook - the value to set

getInputTrainingScript

public ItemList<AnalyticsScript> getInputTrainingScript()

Retrieve the input_training_script property (displayed as 'Scripts') of the object.

Returns:

ItemList<AnalyticsScript>

setInputTrainingScript

public void setInputTrainingScript(ItemList<AnalyticsScript> inputTrainingScript)

Set the input_training_script property (displayed as Scripts) of the object.

Parameters:

inputTrainingScript - the value to set

getLabelTrainingColumn

public ItemList<DataField> getLabelTrainingColumn()

Retrieve the label_training_column property (displayed as 'Output Data Assets') of the object.

Returns:

ItemList<DataField>

setLabelTrainingColumn

public void setLabelTrainingColumn(ItemList<DataField> labelTrainingColumn)

Set the label_training_column property (displayed as Output Data Assets) of the object.

Parameters:

labelTrainingColumn - the value to set

getLogicalName

public String getLogicalName()

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

Returns:

String

setLogicalName

public void setLogicalName(String logicalName)

Set the logical_name property (displayed as Logical Name) of the object.

Parameters:

logicalName - the value to set

getModelQuality

public String getModelQuality()

Retrieve the model_quality property (displayed as 'Quality') of the object.

Returns:

String

setModelQuality

public void setModelQuality(String modelQuality)

Set the model_quality property (displayed as Quality) of the object.

Parameters:

modelQuality - the value to set

getModelType

public String getModelType()

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

Returns:

String

setModelType

public void setModelType(String modelType)

Set the model_type property (displayed as Type) of the object.

Parameters:

modelType - the value to set

getPackageName

public String getPackageName()

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

Returns:

String

setPackageName

public void setPackageName(String packageName)

Set the package_name property (displayed as Package Name) of the object.

Parameters:

packageName - the value to set

getSystemEquivId

public String getSystemEquivId()

Retrieve the system_equiv_id property (displayed as 'System Equiv Id') of the object.

Returns:

String

setSystemEquivId

public void setSystemEquivId(String systemEquivId)

Set the system_equiv_id property (displayed as System Equiv Id) of the object.

Parameters:

systemEquivId - the value to set

getTheUrl

public String getTheUrl()

Retrieve the url property (displayed as 'URL') of the object.

Returns:

String

setTheUrl

public void setTheUrl(String url)

Set the url property (displayed as URL) of the object.

Parameters:

url - the value to set

getVersion

public Number getVersion()

Retrieve the version property (displayed as 'Version') of the object.

Returns:

Number

setVersion

public void setVersion(Number version)

Set the version property (displayed as Version) of the object.

Parameters:

version - the value to set