org.dmg.pmml

Class MiningField

java.lang.Object

org.dmg.pmml.PMMLObject

org.dmg.pmml.Field

org.dmg.pmml.MiningField

All Implemented Interfaces:

Serializable, HasExtensions, HasLocator, HasName, Visitable

public class MiningField
extends Field
implements HasExtensions

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>
 

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
MiningField()
MiningField(FieldName name)

Method Summary

Methods

Modifier and Type	Method and Description
VisitorAction	accept(Visitor visitor)
MiningField	addExtensions(Extension... extensions)
DataType	getDataType() Gets the value of the dataType property.
String	getDisplayName() Gets the value of the displayName property.
List<Extension>	getExtensions() Gets the value of the extensions property.
Double	getHighValue() Gets the value of the highValue property.
Double	getImportance() Gets the value of the importance property.
InvalidValueTreatmentMethodType	getInvalidValueTreatment() Gets the value of the invalidValueTreatment property.
Double	getLowValue() Gets the value of the lowValue property.
String	getMissingValueReplacement() Gets the value of the missingValueReplacement property.
MissingValueTreatmentMethodType	getMissingValueTreatment() Gets the value of the missingValueTreatment property.
FieldName	getName() Gets the value of the name property.
OpType	getOpType() Gets the value of the opType property.
OutlierTreatmentMethodType	getOutlierTreatment() Gets the value of the outlierTreatment property.
FieldUsageType	getUsageType() Gets the value of the usageType property.
boolean	hasExtensions()
MiningField	setDataType(DataType dataType) Sets the value of the dataType property.
MiningField	setDisplayName(String displayName) Sets the value of the displayName property.
MiningField	setHighValue(Double highValue) Sets the value of the highValue property.
MiningField	setImportance(Double importance) Sets the value of the importance property.
MiningField	setInvalidValueTreatment(InvalidValueTreatmentMethodType invalidValueTreatment) Sets the value of the invalidValueTreatment property.
MiningField	setLowValue(Double lowValue) Sets the value of the lowValue property.
MiningField	setMissingValueReplacement(String missingValueReplacement) Sets the value of the missingValueReplacement property.
MiningField	setMissingValueTreatment(MissingValueTreatmentMethodType missingValueTreatment) Sets the value of the missingValueTreatment property.
MiningField	setName(FieldName name) Sets the value of the name property.
MiningField	setOpType(OpType opType) Sets the value of the opType property.
MiningField	setOutlierTreatment(OutlierTreatmentMethodType outlierTreatment) Sets the value of the outlierTreatment property.
MiningField	setUsageType(FieldUsageType usageType) Sets the value of the usageType property.

Methods inherited from class org.dmg.pmml.PMMLObject

getLocator, setLocator

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MiningField

public MiningField()

MiningField

public MiningField(FieldName name)

Method Detail

getName

public FieldName getName()

Gets the value of the name property.

Specified by:

getName in interface HasName

Specified by:

getName in class Field

Returns:

possible object is String

setName

public MiningField setName(FieldName name)

Sets the value of the name property.

Specified by:

setName in interface HasName

Specified by:

setName in class Field

Parameters:

name - allowed object is String

getUsageType

public FieldUsageType getUsageType()

Gets the value of the usageType property.

Returns:

possible object is FieldUsageType

setUsageType

public MiningField setUsageType(FieldUsageType usageType)

Sets the value of the usageType property.

Parameters:

usageType - allowed object is FieldUsageType

getOpType

public OpType getOpType()

Gets the value of the opType property.

Specified by:

getOpType in class Field

Returns:

possible object is OpType

setOpType

public MiningField setOpType(OpType opType)

Sets the value of the opType property.

Specified by:

setOpType in class Field

Parameters:

opType - allowed object is OpType

getImportance

public Double getImportance()

Gets the value of the importance property.

Returns:

possible object is String

setImportance

public MiningField setImportance(Double importance)

Sets the value of the importance property.

Parameters:

importance - allowed object is String

getOutlierTreatment

public OutlierTreatmentMethodType getOutlierTreatment()

Gets the value of the outlierTreatment property.

Returns:

possible object is OutlierTreatmentMethodType

setOutlierTreatment

public MiningField setOutlierTreatment(OutlierTreatmentMethodType outlierTreatment)

Sets the value of the outlierTreatment property.

Parameters:

outlierTreatment - allowed object is OutlierTreatmentMethodType

getLowValue

public Double getLowValue()

Gets the value of the lowValue property.

Returns:

possible object is Double

setLowValue

public MiningField setLowValue(Double lowValue)

Sets the value of the lowValue property.

Parameters:

lowValue - allowed object is Double

getHighValue

public Double getHighValue()

Gets the value of the highValue property.

Returns:

possible object is Double

setHighValue

public MiningField setHighValue(Double highValue)

Sets the value of the highValue property.

Parameters:

highValue - allowed object is Double

getMissingValueReplacement

public String getMissingValueReplacement()

Gets the value of the missingValueReplacement property.

Returns:

possible object is String

setMissingValueReplacement

public MiningField setMissingValueReplacement(String missingValueReplacement)

Sets the value of the missingValueReplacement property.

Parameters:

missingValueReplacement - allowed object is String

getMissingValueTreatment

public MissingValueTreatmentMethodType getMissingValueTreatment()

Gets the value of the missingValueTreatment property.

Returns:

possible object is MissingValueTreatmentMethodType

setMissingValueTreatment

public MiningField setMissingValueTreatment(MissingValueTreatmentMethodType missingValueTreatment)

Sets the value of the missingValueTreatment property.

Parameters:

missingValueTreatment - allowed object is MissingValueTreatmentMethodType

getInvalidValueTreatment

public InvalidValueTreatmentMethodType getInvalidValueTreatment()

Gets the value of the invalidValueTreatment property.

Returns:

possible object is InvalidValueTreatmentMethodType

setInvalidValueTreatment

public MiningField setInvalidValueTreatment(InvalidValueTreatmentMethodType invalidValueTreatment)

Sets the value of the invalidValueTreatment property.

Parameters:

invalidValueTreatment - allowed object is InvalidValueTreatmentMethodType

getExtensions

public List<Extension> getExtensions()

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 Extension

Specified by:

getExtensions in interface HasExtensions

hasExtensions

public boolean hasExtensions()

Specified by:

hasExtensions in interface HasExtensions

addExtensions

public MiningField addExtensions(Extension... extensions)

getDisplayName

public String getDisplayName()

Gets the value of the displayName property.

Specified by:

getDisplayName in class Field

Throws:

UnsupportedOperationException - Always.

setDisplayName

public MiningField setDisplayName(String displayName)

Sets the value of the displayName property.

Specified by:

setDisplayName in class Field

Throws:

UnsupportedOperationException - Always.

getDataType

public DataType getDataType()

Gets the value of the dataType property.

Specified by:

getDataType in class Field

Throws:

UnsupportedOperationException - Always.

setDataType

public MiningField setDataType(DataType dataType)

Sets the value of the dataType property.

Specified by:

setDataType in class Field

Throws:

UnsupportedOperationException - Always.

accept

public VisitorAction accept(Visitor visitor)

Specified by:

accept in interface Visitable