Package com.onenetwork.platform.common

Class MLModel

java.lang.Object
com.onenetwork.platform.common.Model
com.onenetwork.platform.common.MLModel
All Implemented Interfaces:
Model, java.io.Serializable
public class MLModel
extends com.onenetwork.platform.common.Model
implements java.io.Serializable
The machine learning model that contains the model id, version and an attachment to the trained model. This model is used to perform the prediction of output value against the provided input

Java class for MLModel complex type.

The following schema fragment specifies the expected content contained within this class. 

 <complexType name="MLModel">
   <complexContent>
     <extension base="{http://www.onenetwork.com/Platform}Model">
       <sequence>
         <element name="ActionExecTime" type="{http://www.onenetwork.com/Platform}DateTime" minOccurs="0"/>
         <element name="ActionName" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="InputRefId" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="Error" type="{http://www.onenetwork.com/Platform}Error" minOccurs="0"/>
         <element name="CreationUser" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="CreationDate" type="{http://www.onenetwork.com/Platform}DateTime" minOccurs="0"/>
         <element name="LastModifiedUser" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="LastModifiedDate" type="{http://www.onenetwork.com/Platform}DateTime" minOccurs="0"/>
         <element name="LevelModifiedDate" type="{http://www.onenetwork.com/Platform}DateTime" minOccurs="0"/>
         <element name="ValueChainId" type="{http://www.w3.org/2001/XMLSchema}long"/>
         <element name="ModelId" type="{http://www.w3.org/2001/XMLSchema}string"/>
         <element name="ModelVersion" type="{http://www.onenetwork.com/Platform}NullableInteger"/>
         <element name="OwningOrgName" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="OwningOrgEnterpriseName" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="Description" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="SupervisionType" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="MLModelType" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="ModelImplementation" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="InputFieldAdapter" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="TrainedDate" type="{http://www.onenetwork.com/Platform}DateTime" minOccurs="0"/>
         <element name="NEOLearningNetworkID" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="TrainedBy" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="InputSchema" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="OutputType" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="Udfs" type="{http://www.onenetwork.com/Platform}NameValuePairList" minOccurs="0"/>
         <element name="Issue" type="{http://www.onenetwork.com/Platform}Issue" maxOccurs="unbounded" minOccurs="0"/>
         <element ref="{http://www.onenetwork.com/Platform}MDFs" maxOccurs="unbounded" minOccurs="0"/>
         <element name="Attribute" type="{http://www.onenetwork.com/Platform}AttributeValue" maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
     </extension>
   </complexContent>
 </complexType>
See Also:
Serialized Form

  • Field Details

    • actionExecTime

      protected java.util.Calendar actionExecTime

    • actionName

      protected java.lang.String actionName

    • inputRefId

      protected java.lang.String inputRefId

    • error

      protected StatusMessage error

    • creationUser

      protected java.lang.String creationUser

    • creationDate

      protected java.util.Calendar creationDate

    • lastModifiedUser

      protected java.lang.String lastModifiedUser

    • lastModifiedDate

      protected java.util.Calendar lastModifiedDate

    • levelModifiedDate

      protected java.util.Calendar levelModifiedDate

    • valueChainId

      protected long valueChainId

    • modelId

      protected java.lang.String modelId

    • modelVersion

      protected java.lang.Integer modelVersion

    • owningOrgName

      protected java.lang.String owningOrgName

    • owningOrgEnterpriseName

      protected java.lang.String owningOrgEnterpriseName

    • description

      protected java.lang.String description

    • supervisionType

      protected java.lang.String supervisionType

    • mlModelType

      protected java.lang.String mlModelType

    • modelImplementation

      protected java.lang.String modelImplementation

    • inputFieldAdapter

      protected java.lang.String inputFieldAdapter

    • trainedDate

      protected java.util.Calendar trainedDate

    • neoLearningNetworkID

      protected java.lang.String neoLearningNetworkID

    • trainedBy

      protected java.lang.String trainedBy

    • inputSchema

      protected java.lang.String inputSchema

    • outputType

      protected java.lang.String outputType

    • udfs

      protected com.onenetwork.platform.common.NameValuePairList udfs

    • issues

      protected java.util.List<Issue> issues

    • mdFsList

      protected java.util.List<javax.xml.bind.JAXBElement<? extends com.onenetwork.platform.common.MDFs>> mdFsList

    • attributes

      protected java.util.List<AttributeValue> attributes

    • MODEL_TYPE

      public static final com.onenetwork.platform.data.model.impl.ModelType MODEL_TYPE
      Constant reference to the ModelType for this JAXB.

    • MODEL_LEVEL_TYPE

      public static final com.onenetwork.platform.data.model.impl.ModelLevelType MODEL_LEVEL_TYPE
      Constant reference to the ModelLevelType for this JAXB.

    • STANDARD_MODEL_NAME

      public static final java.lang.String STANDARD_MODEL_NAME
      Constant reference to the standard model name for this JAXB.

    • sysOwningOrgId

      protected java.lang.Long sysOwningOrgId

  • Constructor Details

  • Method Details

    • getActionExecTime

      public java.util.Calendar getActionExecTime()
      Gets the value of the actionExecTime property.
      Returns:
      possible object is String

    • setActionExecTime

      public void setActionExecTime​(java.util.Calendar value)
      Sets the value of the actionExecTime property.
      Parameters:
      value - allowed object is String

    • isSetActionExecTime

      public boolean isSetActionExecTime()

    • getActionName

      public java.lang.String getActionName()
      Gets the value of the actionName property.
      Overrides:
      getActionName in class com.onenetwork.platform.common.Model
      Returns:
      possible object is String

    • setActionName

      public void setActionName​(java.lang.String value)
      Sets the value of the actionName property.
      Overrides:
      setActionName in class com.onenetwork.platform.common.Model
      Parameters:
      value - allowed object is String

    • isSetActionName

      public boolean isSetActionName()

    • getInputRefId

      public java.lang.String getInputRefId()
      Gets the value of the inputRefId property.
      Returns:
      possible object is String

    • setInputRefId

      public void setInputRefId​(java.lang.String value)
      Sets the value of the inputRefId property.
      Parameters:
      value - allowed object is String

    • isSetInputRefId

      public boolean isSetInputRefId()

    • getError

      public StatusMessage getError()
      Gets the value of the error property.
      Specified by:
      getError in interface Model
      Overrides:
      getError in class com.onenetwork.platform.common.Model
      Returns:
      possible object is ErrorDef

    • setError

      public void setError​(StatusMessage value)
      Sets the value of the error property.
      Specified by:
      setError in interface Model
      Overrides:
      setError in class com.onenetwork.platform.common.Model
      Parameters:
      value - allowed object is ErrorDef

    • isSetError

      public boolean isSetError()

    • getCreationUser

      public java.lang.String getCreationUser()
      Gets the value of the creationUser property.
      Returns:
      possible object is String

    • setCreationUser

      public void setCreationUser​(java.lang.String value)
      Sets the value of the creationUser property.
      Parameters:
      value - allowed object is String

    • isSetCreationUser

      public boolean isSetCreationUser()

    • getCreationDate

      public java.util.Calendar getCreationDate()
      Gets the value of the creationDate property.
      Returns:
      possible object is String

    • setCreationDate

      public void setCreationDate​(java.util.Calendar value)
      Sets the value of the creationDate property.
      Parameters:
      value - allowed object is String

    • isSetCreationDate

      public boolean isSetCreationDate()

    • getLastModifiedUser

      public java.lang.String getLastModifiedUser()
      Gets the value of the lastModifiedUser property.
      Specified by:
      getLastModifiedUser in interface Model
      Overrides:
      getLastModifiedUser in class com.onenetwork.platform.common.Model
      Returns:
      possible object is String

    • setLastModifiedUser

      public void setLastModifiedUser​(java.lang.String value)
      Sets the value of the lastModifiedUser property.
      Specified by:
      setLastModifiedUser in interface Model
      Overrides:
      setLastModifiedUser in class com.onenetwork.platform.common.Model
      Parameters:
      value - allowed object is String

    • isSetLastModifiedUser

      public boolean isSetLastModifiedUser()

    • getLastModifiedDate

      public java.util.Calendar getLastModifiedDate()
      Gets the value of the lastModifiedDate property.
      Specified by:
      getLastModifiedDate in interface Model
      Overrides:
      getLastModifiedDate in class com.onenetwork.platform.common.Model
      Returns:
      possible object is String

    • setLastModifiedDate

      public void setLastModifiedDate​(java.util.Calendar value)
      Sets the value of the lastModifiedDate property.
      Specified by:
      setLastModifiedDate in interface Model
      Overrides:
      setLastModifiedDate in class com.onenetwork.platform.common.Model
      Parameters:
      value - allowed object is String

    • isSetLastModifiedDate

      public boolean isSetLastModifiedDate()

    • getLevelModifiedDate

      public java.util.Calendar getLevelModifiedDate()
      Gets the value of the levelModifiedDate property.
      Returns:
      possible object is String

    • setLevelModifiedDate

      public void setLevelModifiedDate​(java.util.Calendar value)
      Sets the value of the levelModifiedDate property.
      Parameters:
      value - allowed object is String

    • isSetLevelModifiedDate

      public boolean isSetLevelModifiedDate()

    • getValueChainId

      public long getValueChainId()
      Gets the value of the valueChainId property.

    • setValueChainId

      public void setValueChainId​(long value)
      Sets the value of the valueChainId property.

    • isSetValueChainId

      public boolean isSetValueChainId()

    • getModelId

      public java.lang.String getModelId()
      Gets the value of the modelId property.
      Returns:
      possible object is String

    • setModelId

      public void setModelId​(java.lang.String value)
      Sets the value of the modelId property.
      Parameters:
      value - allowed object is String

    • isSetModelId

      public boolean isSetModelId()

    • setModelVersion

      public void setModelVersion​(int value)
      Sets the value of the modelVersion property.
      Parameters:
      value - allowed object is String

    • isSetModelVersion

      public boolean isSetModelVersion()

    • getOwningOrgName

      public java.lang.String getOwningOrgName()
      Gets the value of the owningOrgName property.
      Returns:
      possible object is String

    • isSetOwningOrgName

      public boolean isSetOwningOrgName()

    • getOwningOrgEnterpriseName

      public java.lang.String getOwningOrgEnterpriseName()
      Gets the value of the owningOrgEnterpriseName property.
      Returns:
      possible object is String

    • isSetOwningOrgEnterpriseName

      public boolean isSetOwningOrgEnterpriseName()

    • getDescription

      public java.lang.String getDescription()
      Gets the value of the description property.
      Returns:
      possible object is String

    • setDescription

      public void setDescription​(java.lang.String value)
      Sets the value of the description property.
      Parameters:
      value - allowed object is String

    • isSetDescription

      public boolean isSetDescription()

    • getSupervisionType

      public java.lang.String getSupervisionType()
      Gets the value of the supervisionType property.
      Returns:
      possible object is String

    • setSupervisionType

      public void setSupervisionType​(java.lang.String value)
      Sets the value of the supervisionType property.
      Parameters:
      value - allowed object is String

    • isSetSupervisionType

      public boolean isSetSupervisionType()

    • getMLModelType

      public java.lang.String getMLModelType()
      Gets the value of the mlModelType property.
      Returns:
      possible object is String

    • setMLModelType

      public void setMLModelType​(java.lang.String value)
      Sets the value of the mlModelType property.
      Parameters:
      value - allowed object is String

    • isSetMLModelType

      public boolean isSetMLModelType()

    • getModelImplementation

      public java.lang.String getModelImplementation()
      Gets the value of the modelImplementation property.
      Returns:
      possible object is String

    • setModelImplementation

      public void setModelImplementation​(java.lang.String value)
      Sets the value of the modelImplementation property.
      Parameters:
      value - allowed object is String

    • isSetModelImplementation

      public boolean isSetModelImplementation()

    • getInputFieldAdapter

      public java.lang.String getInputFieldAdapter()
      Gets the value of the inputFieldAdapter property.
      Returns:
      possible object is String

    • setInputFieldAdapter

      public void setInputFieldAdapter​(java.lang.String value)
      Sets the value of the inputFieldAdapter property.
      Parameters:
      value - allowed object is String

    • isSetInputFieldAdapter

      public boolean isSetInputFieldAdapter()

    • getTrainedDate

      public java.util.Calendar getTrainedDate()
      Gets the value of the trainedDate property.
      Returns:
      possible object is String

    • setTrainedDate

      public void setTrainedDate​(java.util.Calendar value)
      Sets the value of the trainedDate property.
      Parameters:
      value - allowed object is String

    • isSetTrainedDate

      public boolean isSetTrainedDate()

    • getNEOLearningNetworkID

      public java.lang.String getNEOLearningNetworkID()
      Gets the value of the neoLearningNetworkID property.
      Returns:
      possible object is String

    • setNEOLearningNetworkID

      public void setNEOLearningNetworkID​(java.lang.String value)
      Sets the value of the neoLearningNetworkID property.
      Parameters:
      value - allowed object is String

    • isSetNEOLearningNetworkID

      public boolean isSetNEOLearningNetworkID()

    • getTrainedBy

      public java.lang.String getTrainedBy()
      Gets the value of the trainedBy property.
      Returns:
      possible object is String

    • setTrainedBy

      public void setTrainedBy​(java.lang.String value)
      Sets the value of the trainedBy property.
      Parameters:
      value - allowed object is String

    • isSetTrainedBy

      public boolean isSetTrainedBy()

    • getInputSchema

      public java.lang.String getInputSchema()
      Gets the value of the inputSchema property.
      Returns:
      possible object is String

    • setInputSchema

      public void setInputSchema​(java.lang.String value)
      Sets the value of the inputSchema property.
      Parameters:
      value - allowed object is String

    • isSetInputSchema

      public boolean isSetInputSchema()

    • getOutputType

      public java.lang.String getOutputType()
      Gets the value of the outputType property.
      Returns:
      possible object is String

    • setOutputType

      public void setOutputType​(java.lang.String value)
      Sets the value of the outputType property.
      Parameters:
      value - allowed object is String

    • isSetOutputType

      public boolean isSetOutputType()

    • getUdfs

      public com.onenetwork.platform.common.NameValuePairList getUdfs()
      Gets the value of the udfs property.
      Overrides:
      getUdfs in class com.onenetwork.platform.common.Model
      Returns:
      possible object is NameValuePairList

    • setUdfs

      public void setUdfs​(com.onenetwork.platform.common.NameValuePairList value)
      Sets the value of the udfs property.
      Overrides:
      setUdfs in class com.onenetwork.platform.common.Model
      Parameters:
      value - allowed object is NameValuePairList

    • isSetUdfs

      public boolean isSetUdfs()
      Overrides:
      isSetUdfs in class com.onenetwork.platform.common.Model

    • getIssues

      public java.util.List<Issue> getIssues()
      Gets the value of the issues property.

      This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the issues property.

      For example, to add a new item, do as follows: 

          getIssues().add(newItem);

      Objects of the following type(s) are allowed in the list Issue

    • isSetIssues

      public boolean isSetIssues()

    • unsetIssues

      public void unsetIssues()

    • getMDFsList

      public java.util.List<javax.xml.bind.JAXBElement<? extends com.onenetwork.platform.common.MDFs>> getMDFsList()
      Gets the value of the mdFsList property.

      This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the mdFsList property.

      For example, to add a new item, do as follows: 

          getMDFsList().add(newItem);

      Objects of the following type(s) are allowed in the list JAXBElement<DummyMDFs> JAXBElement<MDFs>

      Overrides:
      getMDFsList in class com.onenetwork.platform.common.Model

    • isSetMDFsList

      public boolean isSetMDFsList()

    • unsetMDFsList

      public void unsetMDFsList()

    • getAttributes

      public java.util.List<AttributeValue> getAttributes()
      Gets the value of the attributes property.

      This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the attributes property.

      For example, to add a new item, do as follows: 

          getAttributes().add(newItem);

      Objects of the following type(s) are allowed in the list AttributeValue

      Overrides:
      getAttributes in class com.onenetwork.platform.common.Model

    • isSetAttributes

      public boolean isSetAttributes()

    • unsetAttributes

      public void unsetAttributes()

    • setOwningOrgName

      public void setOwningOrgName​(java.lang.String value)
      Sets the value of OwningOrgName, and also nullifies the following surrogate ids: SysOwningOrgId. This nullification is done to ensure that a client can set either natural keys or sys id as desired. If you as a client wish to populate *both* natural and surrogate ids, you should set the natural keys first, then set the surrogate ids passing 'false' as the second parameter
      Parameters:
      value - new value for OwningOrgName - the following will also be nullified: SysOwningOrgId

    • setOwningOrgEnterpriseName

      public void setOwningOrgEnterpriseName​(java.lang.String value)
      Sets the value of OwningOrgEnterpriseName, and also nullifies the following surrogate ids: SysOwningOrgId. This nullification is done to ensure that a client can set either natural keys or sys id as desired. If you as a client wish to populate *both* natural and surrogate ids, you should set the natural keys first, then set the surrogate ids passing 'false' as the second parameter
      Parameters:
      value - new value for OwningOrgEnterpriseName - the following will also be nullified: SysOwningOrgId

    • getModelVersion

      public int getModelVersion()

    • unsetModelVersion

      public void unsetModelVersion()

    • getSerializedModel

      public java.util.List<ModelAttachment> getSerializedModel()
      Attachment updates for SerializedModel. These are XmlTransient and will not be marshalled to XML nor unmarshalled from XML. They are provided for insert/update/delete only and are not populated by Model read operations.

    • issueOn

      public com.onenetwork.platform.common.Issue issueOn​(java.lang.String issueName, IssueSeverity issueSeverity)
      Utility method to create an issue and set it on JAXB

    • issueOff

      public com.onenetwork.platform.common.Issue issueOff​(java.lang.String issueName)
      Utility method to create an issue and set it on JAXB

    • equals

      public boolean equals​(java.lang.Object obj)
      Description copied from interface: Model
      A Model object is considered "equal" to another Model object if it is a Model of the same type and its Natural Key fields are identical.
      Specified by:
      equals in interface Model
      Overrides:
      equals in class java.lang.Object
      Parameters:
      obj - object to compare
      Returns:
      true if the object is the same type of Model with identical Natural Key fields

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class java.lang.Object

    • internalToString

      protected java.lang.String internalToString()
      Overrides:
      internalToString in class com.onenetwork.platform.common.Model

    • toStrContrib

      public java.lang.String toStrContrib()
      Not intended for use by Clients

    • getModelType

      public com.onenetwork.platform.data.model.impl.ModelType getModelType()
      methods to get ModelType for this JAXB.
      Overrides:
      getModelType in class com.onenetwork.platform.common.Model

    • getModelLevelType

      public com.onenetwork.platform.data.model.impl.ModelLevelType getModelLevelType()
      methods to get ModelLevelType for this JAXB.
      Overrides:
      getModelLevelType in class com.onenetwork.platform.common.Model

    • getStandardModelName

      public java.lang.String getStandardModelName()
      method to get standard model name for this JAXB.
      Overrides:
      getStandardModelName in class com.onenetwork.platform.common.Model

    • getSysOwningOrgId

      public java.lang.Long getSysOwningOrgId()
      Returns the surrogate id value for SysOwningOrgId. After reading a model, this will always match with the corresponding natural keys, which are: owningOrgName, owningOrgEnterpriseName

    • setSysOwningOrgId

      public void setSysOwningOrgId​(java.lang.Long value, boolean nullifyNaturalKeys)
      Sets the surrogate id value for SysOwningOrgId. As a client, when you want to update the model in the database, you may set values either by natural key or by sys id, or by both. Calling this method with 'true' will nullify the natural keys for this surrogate key: owningOrgName, owningOrgEnterpriseName. This ensures the values don't conflict. If you are 'populating' an object and want to set both natural and surrogate keys, you should set the natural keys first, then call this method with 'false' for nullifyNaturalKeys.
      Parameters:
      value - new value for SysOwningOrgId
      nullifyNaturalKeys - true to nullify the related natural keys (owningOrgName, owningOrgEnterpriseName), or false to leave as is - please note that you can pass either surrogate id or natural keys to the server write API, or both