public class ModelInformation extends Object
Constructor and Description |
---|
ModelInformation(String name,
String description,
String timestamp,
List<FieldInformation> fields,
boolean isTargetAnInput,
Status status) |
Modifier and Type | Method and Description |
---|---|
String |
getDescription()
Return the model description.
|
List<FieldInformation> |
getFields()
Return the
List of fields defined in the model. |
List<FieldInformation> |
getFields(FieldInformation.Usage usageType)
Return the
List of fields defined in the model that matches the provided usage type. |
List<FieldInformation> |
getInputFields()
Return the
List of input fields represented by FieldInformation . |
String |
getName()
Return the model name.
|
List<FieldInformation> |
getOutputFields()
Return the
List of output fields represented by FieldInformation . |
Status |
getStatus()
Return the model
Status . |
String |
getTimestamp()
Return the model creation date.
|
boolean |
isActive()
Returns the active flag.
|
void |
setActive(boolean active) |
public ModelInformation(String name, String description, String timestamp, List<FieldInformation> fields, boolean isTargetAnInput, Status status)
name
- the model name.description
- the model description.timestamp
- the model time stamp (creation or upload time).fields
- the List
of model fields.isTargetAnInput
- if true
the target field should be considered an input (e.g. used in computing residuals)status
- the Status
of the model compilation.public final String getName()
public final String getDescription()
public final List<FieldInformation> getFields()
List
of fields defined in the model. When appropriate, this list includes target and derived
fields, in addition to input and output fields.public final List<FieldInformation> getFields(FieldInformation.Usage usageType)
List
of fields defined in the model that matches the provided usage type.usageType
- the usage typeFieldInformation.Usage
public final List<FieldInformation> getInputFields()
List
of input fields represented by FieldInformation
.public final List<FieldInformation> getOutputFields()
List
of output fields represented by FieldInformation
.public final String getTimestamp()
public final boolean isActive()
true
when the model is active, false
otherwise.public final void setActive(boolean active)
active
- flag to setCopyright © 2005–2017 Zementis, Inc.. All rights reserved.