MiningField (JPMML class model 1.3.2 API)

java.lang.Object
- org.dmg.pmml.PMMLObject
- - org.dmg.pmml.MiningField

All Implemented Interfaces:: Serializable, HasExtensions, HasLocator, Indexable<FieldName>, Visitable

public class MiningField
extends PMMLObject
implements HasExtensions, Indexable<FieldName>

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_3}Extension" maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
       <attribute name="name" use="required" type="{http://www.dmg.org/PMML-4_3}FIELD-NAME" />
       <attribute name="usageType" default="active">
         <simpleType>
           <restriction base="{http://www.w3.org/2001/XMLSchema}string">
             <enumeration value="active"/>
             <enumeration value="predicted"/>
             <enumeration value="target"/>
             <enumeration value="supplementary"/>
             <enumeration value="group"/>
             <enumeration value="order"/>
             <enumeration value="frequencyWeight"/>
             <enumeration value="analysisWeight"/>
           </restriction>
         </simpleType>
       </attribute>
       <attribute name="optype" type="{http://www.dmg.org/PMML-4_3}OPTYPE" />
       <attribute name="importance" type="{http://www.dmg.org/PMML-4_3}PROB-NUMBER" />
       <attribute name="outliers" type="{http://www.dmg.org/PMML-4_3}OUTLIER-TREATMENT-METHOD" default="asIs" />
       <attribute name="lowValue" type="{http://www.dmg.org/PMML-4_3}NUMBER" />
       <attribute name="highValue" type="{http://www.dmg.org/PMML-4_3}NUMBER" />
       <attribute name="missingValueReplacement" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="missingValueTreatment" type="{http://www.dmg.org/PMML-4_3}MISSING-VALUE-TREATMENT-METHOD" />
       <attribute name="invalidValueTreatment" type="{http://www.dmg.org/PMML-4_3}INVALID-VALUE-TREATMENT-METHOD" default="returnInvalid" />
     </restriction>
   </complexContent>
 </complexType>

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class MiningField.UsageType
Java class for null.

Nested Classes
Modifier and Type	Class and Description
`static class`	`MiningField.UsageType` Java class for null.

Constructor Summary

Constructors
Constructor and Description

MiningField()

MiningField(FieldName name)

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)`
`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.
`InvalidValueTreatmentMethod`	`getInvalidValueTreatment()` Gets the value of the invalidValueTreatment property.
`FieldName`	`getKey()`
`Double`	`getLowValue()` Gets the value of the lowValue property.
`String`	`getMissingValueReplacement()` Gets the value of the missingValueReplacement property.
`MissingValueTreatmentMethod`	`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.
`OutlierTreatmentMethod`	`getOutlierTreatment()` Gets the value of the outlierTreatment property.
`MiningField.UsageType`	`getUsageType()` Gets the value of the usageType property.
`boolean`	`hasExtensions()`
`MiningField`	`setHighValue(Double highValue)` Sets the value of the highValue property.
`MiningField`	`setImportance(Double importance)` Sets the value of the importance property.
`MiningField`	`setInvalidValueTreatment(InvalidValueTreatmentMethod 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(MissingValueTreatmentMethod 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(OutlierTreatmentMethod outlierTreatment)` Sets the value of the outlierTreatment property.
`MiningField`	`setUsageType(MiningField.UsageType usageType)` Sets the value of the usageType property.

Methods inherited from class org.dmg.pmml.PMMLObject
getLocator, setLocator, traverse, traverse, traverse, traverse, traverseMixed

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.
    
    Returns:
    possible object is String
  - setName
```
public MiningField setName(FieldName name)
```
    Sets the value of the name property.
    
    Parameters:
    name - allowed object is String
  - getUsageType
```
public MiningField.UsageType getUsageType()
```
    Gets the value of the usageType property.
    
    Returns:
    possible object is MiningField.UsageType
  - setUsageType
```
public MiningField setUsageType(MiningField.UsageType usageType)
```
    Sets the value of the usageType property.
    
    Parameters:
    usageType - allowed object is MiningField.UsageType
  - getOpType
```
public OpType getOpType()
```
    Gets the value of the opType property.
    
    Returns:
    possible object is OpType
  - setOpType
```
public MiningField setOpType(OpType opType)
```
    Sets the value of the opType property.
    
    Parameters:
    opType - allowed object is OpType
  - getImportance
```
public Double getImportance()
```
    Gets the value of the importance property.
    
    Returns:
    possible object is Double
  - setImportance
```
public MiningField setImportance(Double importance)
```
    Sets the value of the importance property.
    
    Parameters:
    importance - allowed object is Double
  - getOutlierTreatment
```
public OutlierTreatmentMethod getOutlierTreatment()
```
    Gets the value of the outlierTreatment property.
    
    Returns:
    possible object is OutlierTreatmentMethod
  - setOutlierTreatment
```
public MiningField setOutlierTreatment(OutlierTreatmentMethod outlierTreatment)
```
    Sets the value of the outlierTreatment property.
    
    Parameters:
    outlierTreatment - allowed object is OutlierTreatmentMethod
  - 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 MissingValueTreatmentMethod getMissingValueTreatment()
```
    Gets the value of the missingValueTreatment property.
    
    Returns:
    possible object is MissingValueTreatmentMethod
  - setMissingValueTreatment
```
public MiningField setMissingValueTreatment(MissingValueTreatmentMethod missingValueTreatment)
```
    Sets the value of the missingValueTreatment property.
    
    Parameters:
    missingValueTreatment - allowed object is MissingValueTreatmentMethod
  - getInvalidValueTreatment
```
public InvalidValueTreatmentMethod getInvalidValueTreatment()
```
    Gets the value of the invalidValueTreatment property.
    
    Returns:
    possible object is InvalidValueTreatmentMethod
  - setInvalidValueTreatment
```
public MiningField setInvalidValueTreatment(InvalidValueTreatmentMethod invalidValueTreatment)
```
    Sets the value of the invalidValueTreatment property.
    
    Parameters:
    invalidValueTreatment - allowed object is InvalidValueTreatmentMethod
  - 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
  - getKey
```
public FieldName getKey()
```
    Specified by:
    
    getKey in interface Indexable<FieldName>
    
    Returns:
    The value of the primary key-like attribute. Could be null.
  - hasExtensions
```
public boolean hasExtensions()
```
    Specified by:
    
    hasExtensions in interface HasExtensions
  - addExtensions
```
public MiningField addExtensions(Extension... extensions)
```
  - accept
```
public VisitorAction accept(Visitor visitor)
```
    Specified by:
    
    accept in interface Visitable

Class MiningField

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class org.dmg.pmml.PMMLObject

Methods inherited from class java.lang.Object

Constructor Detail

MiningField

MiningField

Method Detail

getName

setName

getUsageType

setUsageType

getOpType

setOpType

getImportance

setImportance

getOutlierTreatment

setOutlierTreatment

getLowValue

setLowValue

getHighValue

setHighValue

getMissingValueReplacement

setMissingValueReplacement

getMissingValueTreatment

setMissingValueTreatment

getInvalidValueTreatment

setInvalidValueTreatment

getExtensions

getKey

hasExtensions

addExtensions

accept