org.dmg.pmml.MiningField Maven / Gradle / Ivy
package org.dmg.pmml;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlAttribute;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlRootElement;
import javax.xml.bind.annotation.XmlTransient;
import javax.xml.bind.annotation.XmlType;
import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter;
import com.sun.xml.bind.Locatable;
import com.sun.xml.bind.annotation.XmlLocation;
import org.jpmml.schema.Added;
import org.jpmml.schema.Version;
import org.xml.sax.Locator;
/**
* Java class for anonymous complex type.
*
*
The following schema fragment specifies the expected content contained within this class.
*
*
* <complexType>
* <complexContent>
* <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
* <sequence>
* <element ref="{http://www.dmg.org/PMML-4_2}Extension" maxOccurs="unbounded" minOccurs="0"/>
* </sequence>
* <attribute name="name" use="required" type="{http://www.dmg.org/PMML-4_2}FIELD-NAME" />
* <attribute name="usageType" type="{http://www.dmg.org/PMML-4_2}FIELD-USAGE-TYPE" default="active" />
* <attribute name="optype" type="{http://www.dmg.org/PMML-4_2}OPTYPE" />
* <attribute name="importance" type="{http://www.dmg.org/PMML-4_2}PROB-NUMBER" />
* <attribute name="outliers" type="{http://www.dmg.org/PMML-4_2}OUTLIER-TREATMENT-METHOD" default="asIs" />
* <attribute name="lowValue" type="{http://www.dmg.org/PMML-4_2}NUMBER" />
* <attribute name="highValue" type="{http://www.dmg.org/PMML-4_2}NUMBER" />
* <attribute name="missingValueReplacement" type="{http://www.w3.org/2001/XMLSchema}string" />
* <attribute name="missingValueTreatment" type="{http://www.dmg.org/PMML-4_2}MISSING-VALUE-TREATMENT-METHOD" />
* <attribute name="invalidValueTreatment" type="{http://www.dmg.org/PMML-4_2}INVALID-VALUE-TREATMENT-METHOD" default="returnInvalid" />
* </restriction>
* </complexContent>
* </complexType>
*
*
*
*/
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "", propOrder = {
"extensions"
})
@XmlRootElement(name = "MiningField")
public class MiningField
extends Field
implements Locatable, HasExtensions
{
@XmlElement(name = "Extension")
protected List extensions;
@XmlAttribute(name = "name", required = true)
@XmlJavaTypeAdapter(FieldNameAdapter.class)
protected FieldName name;
@XmlAttribute(name = "usageType")
protected FieldUsageType usageType;
@XmlAttribute(name = "optype")
protected OpType optype;
@XmlAttribute(name = "importance")
protected Double importance;
@XmlAttribute(name = "outliers")
protected OutlierTreatmentMethodType outlierTreatment;
@XmlAttribute(name = "lowValue")
protected Double lowValue;
@XmlAttribute(name = "highValue")
protected Double highValue;
@XmlAttribute(name = "missingValueReplacement")
protected String missingValueReplacement;
@XmlAttribute(name = "missingValueTreatment")
protected MissingValueTreatmentMethodType missingValueTreatment;
@XmlAttribute(name = "invalidValueTreatment")
@Added(Version.PMML_3_1)
protected InvalidValueTreatmentMethodType invalidValueTreatment;
@XmlLocation
@XmlTransient
protected Locator locator;
public MiningField() {
super();
}
public MiningField(final FieldName name) {
super();
this.name = name;
}
/**
* Gets the value of the extensions 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 extensions property.
*
*
* For example, to add a new item, do as follows:
*
* getExtensions().add(newItem);
*
*
*
*
* Objects of the following type(s) are allowed in the list
* {@link Extension }
*
*
*/
public List getExtensions() {
if (extensions == null) {
extensions = new ArrayList();
}
return this.extensions;
}
/**
* Gets the value of the name property.
*
* @return
* possible object is
* {@link String }
*
*/
public FieldName getName() {
return name;
}
/**
* Sets the value of the name property.
*
* @param value
* allowed object is
* {@link String }
*
*/
public void setName(FieldName value) {
this.name = value;
}
/**
* Gets the value of the usageType property.
*
* @return
* possible object is
* {@link FieldUsageType }
*
*/
public FieldUsageType getUsageType() {
if (usageType == null) {
return FieldUsageType.ACTIVE;
} else {
return usageType;
}
}
/**
* Sets the value of the usageType property.
*
* @param value
* allowed object is
* {@link FieldUsageType }
*
*/
public void setUsageType(FieldUsageType value) {
this.usageType = value;
}
/**
* Gets the value of the optype property.
*
* @return
* possible object is
* {@link OpType }
*
*/
public OpType getOptype() {
return optype;
}
/**
* Sets the value of the optype property.
*
* @param value
* allowed object is
* {@link OpType }
*
*/
public void setOptype(OpType value) {
this.optype = value;
}
/**
* Gets the value of the importance property.
*
* @return
* possible object is
* {@link Double }
*
*/
public Double getImportance() {
return importance;
}
/**
* Sets the value of the importance property.
*
* @param value
* allowed object is
* {@link Double }
*
*/
public void setImportance(Double value) {
this.importance = value;
}
/**
* Gets the value of the outlierTreatment property.
*
* @return
* possible object is
* {@link OutlierTreatmentMethodType }
*
*/
public OutlierTreatmentMethodType getOutlierTreatment() {
if (outlierTreatment == null) {
return OutlierTreatmentMethodType.AS_IS;
} else {
return outlierTreatment;
}
}
/**
* Sets the value of the outlierTreatment property.
*
* @param value
* allowed object is
* {@link OutlierTreatmentMethodType }
*
*/
public void setOutlierTreatment(OutlierTreatmentMethodType value) {
this.outlierTreatment = value;
}
/**
* Gets the value of the lowValue property.
*
* @return
* possible object is
* {@link Double }
*
*/
public Double getLowValue() {
return lowValue;
}
/**
* Sets the value of the lowValue property.
*
* @param value
* allowed object is
* {@link Double }
*
*/
public void setLowValue(Double value) {
this.lowValue = value;
}
/**
* Gets the value of the highValue property.
*
* @return
* possible object is
* {@link Double }
*
*/
public Double getHighValue() {
return highValue;
}
/**
* Sets the value of the highValue property.
*
* @param value
* allowed object is
* {@link Double }
*
*/
public void setHighValue(Double value) {
this.highValue = value;
}
/**
* Gets the value of the missingValueReplacement property.
*
* @return
* possible object is
* {@link String }
*
*/
public String getMissingValueReplacement() {
return missingValueReplacement;
}
/**
* Sets the value of the missingValueReplacement property.
*
* @param value
* allowed object is
* {@link String }
*
*/
public void setMissingValueReplacement(String value) {
this.missingValueReplacement = value;
}
/**
* Gets the value of the missingValueTreatment property.
*
* @return
* possible object is
* {@link MissingValueTreatmentMethodType }
*
*/
public MissingValueTreatmentMethodType getMissingValueTreatment() {
return missingValueTreatment;
}
/**
* Sets the value of the missingValueTreatment property.
*
* @param value
* allowed object is
* {@link MissingValueTreatmentMethodType }
*
*/
public void setMissingValueTreatment(MissingValueTreatmentMethodType value) {
this.missingValueTreatment = value;
}
/**
* Gets the value of the invalidValueTreatment property.
*
* @return
* possible object is
* {@link InvalidValueTreatmentMethodType }
*
*/
public InvalidValueTreatmentMethodType getInvalidValueTreatment() {
if (invalidValueTreatment == null) {
return InvalidValueTreatmentMethodType.RETURN_INVALID;
} else {
return invalidValueTreatment;
}
}
/**
* Sets the value of the invalidValueTreatment property.
*
* @param value
* allowed object is
* {@link InvalidValueTreatmentMethodType }
*
*/
public void setInvalidValueTreatment(InvalidValueTreatmentMethodType value) {
this.invalidValueTreatment = value;
}
public MiningField withExtensions(Extension... values) {
if (values!= null) {
for (Extension value: values) {
getExtensions().add(value);
}
}
return this;
}
public MiningField withExtensions(Collection values) {
if (values!= null) {
getExtensions().addAll(values);
}
return this;
}
public MiningField withName(FieldName value) {
setName(value);
return this;
}
public MiningField withUsageType(FieldUsageType value) {
setUsageType(value);
return this;
}
public MiningField withOptype(OpType value) {
setOptype(value);
return this;
}
public MiningField withImportance(Double value) {
setImportance(value);
return this;
}
public MiningField withOutlierTreatment(OutlierTreatmentMethodType value) {
setOutlierTreatment(value);
return this;
}
public MiningField withLowValue(Double value) {
setLowValue(value);
return this;
}
public MiningField withHighValue(Double value) {
setHighValue(value);
return this;
}
public MiningField withMissingValueReplacement(String value) {
setMissingValueReplacement(value);
return this;
}
public MiningField withMissingValueTreatment(MissingValueTreatmentMethodType value) {
setMissingValueTreatment(value);
return this;
}
public MiningField withInvalidValueTreatment(InvalidValueTreatmentMethodType value) {
setInvalidValueTreatment(value);
return this;
}
public Locator sourceLocation() {
return locator;
}
public void setSourceLocation(Locator newLocator) {
locator = newLocator;
}
/**
* Gets the value of the displayName property.
*
* @throws UnsupportedOperationException
* Always.
*/
@Override
public String getDisplayName() {
throw new UnsupportedOperationException();
}
/**
* Sets the value of the displayName property.
*
* @throws UnsupportedOperationException
* Always.
*/
@Override
public void setDisplayName(String displayName) {
throw new UnsupportedOperationException();
}
/**
* Gets the value of the dataType property.
*
* @throws UnsupportedOperationException
* Always.
*/
@Override
public DataType getDataType() {
throw new UnsupportedOperationException();
}
/**
* Sets the value of the dataType property.
*
* @throws UnsupportedOperationException
* Always.
*/
@Override
public void setDataType(DataType dataType) {
throw new UnsupportedOperationException();
}
@Override
public VisitorAction accept(Visitor visitor) {
VisitorAction status = visitor.visit(this);
for (int i = 0; (((status == VisitorAction.CONTINUE)&&(this.extensions!= null))&&(i