org.dmg.pmml

Class MiningField

java.lang.Object

org.dmg.pmml.PMMLObject

org.dmg.pmml.Field

org.dmg.pmml.MiningField

All Implemented Interfaces:

com.sun.xml.bind.Locatable, Serializable, HasExtensions, HasName, Visitable

public class MiningField
extends Field
implements com.sun.xml.bind.Locatable, 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_1}Extension" maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
       <attribute name="name" use="required" type="{http://www.dmg.org/PMML-4_1}FIELD-NAME" />
       <attribute name="usageType" type="{http://www.dmg.org/PMML-4_1}FIELD-USAGE-TYPE" default="active" />
       <attribute name="optype" type="{http://www.dmg.org/PMML-4_1}OPTYPE" />
       <attribute name="importance" type="{http://www.dmg.org/PMML-4_1}PROB-NUMBER" />
       <attribute name="outliers" type="{http://www.dmg.org/PMML-4_1}OUTLIER-TREATMENT-METHOD" default="asIs" />
       <attribute name="lowValue" type="{http://www.dmg.org/PMML-4_1}NUMBER" />
       <attribute name="highValue" type="{http://www.dmg.org/PMML-4_1}NUMBER" />
       <attribute name="missingValueReplacement" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="missingValueTreatment" type="{http://www.dmg.org/PMML-4_1}MISSING-VALUE-TREATMENT-METHOD" />
       <attribute name="invalidValueTreatment" type="{http://www.dmg.org/PMML-4_1}INVALID-VALUE-TREATMENT-METHOD" default="returnInvalid" />
     </restriction>
   </complexContent>
 </complexType>
 

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected List<Extension>	extensions
protected Double	highValue
protected Double	importance
protected InvalidValueTreatmentMethodType	invalidValueTreatment
protected Locator	locator
protected Double	lowValue
protected String	missingValueReplacement
protected MissingValueTreatmentMethodType	missingValueTreatment
protected FieldName	name
protected OpType	optype
protected OutlierTreatmentMethodType	outlierTreatment
protected FieldUsageType	usageType

Constructor Summary

Constructors

Constructor and Description
MiningField() Deprecated.
MiningField(FieldName name)

Method Summary

Methods

Modifier and Type	Method and Description
VisitorAction	accept(Visitor visitor)
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.
void	setDataType(DataType dataType) Sets the value of the dataType property.
void	setDisplayName(String displayName) Sets the value of the displayName property.
void	setHighValue(Double value) Sets the value of the highValue property.
void	setImportance(Double value) Sets the value of the importance property.
void	setInvalidValueTreatment(InvalidValueTreatmentMethodType value) Sets the value of the invalidValueTreatment property.
void	setLowValue(Double value) Sets the value of the lowValue property.
void	setMissingValueReplacement(String value) Sets the value of the missingValueReplacement property.
void	setMissingValueTreatment(MissingValueTreatmentMethodType value) Sets the value of the missingValueTreatment property.
void	setName(FieldName value) Sets the value of the name property.
void	setOptype(OpType value) Sets the value of the optype property.
void	setOutlierTreatment(OutlierTreatmentMethodType value) Sets the value of the outlierTreatment property.
void	setSourceLocation(Locator newLocator)
void	setUsageType(FieldUsageType value) Sets the value of the usageType property.
Locator	sourceLocation()
MiningField	withExtensions(Collection<Extension> values)
MiningField	withExtensions(Extension... values)
MiningField	withHighValue(Double value)
MiningField	withImportance(Double value)
MiningField	withInvalidValueTreatment(InvalidValueTreatmentMethodType value)
MiningField	withLowValue(Double value)
MiningField	withMissingValueReplacement(String value)
MiningField	withMissingValueTreatment(MissingValueTreatmentMethodType value)
MiningField	withName(FieldName value)
MiningField	withOptype(OpType value)
MiningField	withOutlierTreatment(OutlierTreatmentMethodType value)
MiningField	withUsageType(FieldUsageType value)

Methods inherited from class java.lang.Object

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

Field Detail

extensions

protected List<Extension> extensions

name

protected FieldName name

usageType

protected FieldUsageType usageType

optype

protected OpType optype

importance

protected Double importance

outlierTreatment

protected OutlierTreatmentMethodType outlierTreatment

lowValue

protected Double lowValue

highValue

protected Double highValue

missingValueReplacement

protected String missingValueReplacement

missingValueTreatment

protected MissingValueTreatmentMethodType missingValueTreatment

invalidValueTreatment

protected InvalidValueTreatmentMethodType invalidValueTreatment

locator

protected Locator locator

Constructor Detail

MiningField

@Deprecated
public MiningField()

Deprecated.

MiningField

public MiningField(FieldName name)

Method Detail

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

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 void setName(FieldName value)

Sets the value of the name property.

Specified by:

setName in interface HasName

Specified by:

setName in class Field

Parameters:

value - allowed object is String

getUsageType

public FieldUsageType getUsageType()

Gets the value of the usageType property.

Returns:

possible object is FieldUsageType

setUsageType

public void setUsageType(FieldUsageType value)

Sets the value of the usageType property.

Parameters:

value - 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 void setOptype(OpType value)

Sets the value of the optype property.

Specified by:

setOptype in class Field

Parameters:

value - allowed object is OpType

getImportance

public Double getImportance()

Gets the value of the importance property.

Returns:

possible object is String

setImportance

public void setImportance(Double value)

Sets the value of the importance property.

Parameters:

value - allowed object is String

getOutlierTreatment

public OutlierTreatmentMethodType getOutlierTreatment()

Gets the value of the outlierTreatment property.

Returns:

possible object is OutlierTreatmentMethodType

setOutlierTreatment

public void setOutlierTreatment(OutlierTreatmentMethodType value)

Sets the value of the outlierTreatment property.

Parameters:

value - allowed object is OutlierTreatmentMethodType

getLowValue

public Double getLowValue()

Gets the value of the lowValue property.

Returns:

possible object is Double

setLowValue

public void setLowValue(Double value)

Sets the value of the lowValue property.

Parameters:

value - allowed object is Double

getHighValue

public Double getHighValue()

Gets the value of the highValue property.

Returns:

possible object is Double

setHighValue

public void setHighValue(Double value)

Sets the value of the highValue property.

Parameters:

value - allowed object is Double

getMissingValueReplacement

public String getMissingValueReplacement()

Gets the value of the missingValueReplacement property.

Returns:

possible object is String

setMissingValueReplacement

public void setMissingValueReplacement(String value)

Sets the value of the missingValueReplacement property.

Parameters:

value - allowed object is String

getMissingValueTreatment

public MissingValueTreatmentMethodType getMissingValueTreatment()

Gets the value of the missingValueTreatment property.

Returns:

possible object is MissingValueTreatmentMethodType

setMissingValueTreatment

public void setMissingValueTreatment(MissingValueTreatmentMethodType value)

Sets the value of the missingValueTreatment property.

Parameters:

value - allowed object is MissingValueTreatmentMethodType

getInvalidValueTreatment

public InvalidValueTreatmentMethodType getInvalidValueTreatment()

Gets the value of the invalidValueTreatment property.

Returns:

possible object is InvalidValueTreatmentMethodType

setInvalidValueTreatment

public void setInvalidValueTreatment(InvalidValueTreatmentMethodType value)

Sets the value of the invalidValueTreatment property.

Parameters:

value - allowed object is InvalidValueTreatmentMethodType

withExtensions

public MiningField withExtensions(Extension... values)

withExtensions

public MiningField withExtensions(Collection<Extension> values)

withName

public MiningField withName(FieldName value)

withUsageType

public MiningField withUsageType(FieldUsageType value)

withOptype

public MiningField withOptype(OpType value)

withImportance

public MiningField withImportance(Double value)

withOutlierTreatment

public MiningField withOutlierTreatment(OutlierTreatmentMethodType value)

withLowValue

public MiningField withLowValue(Double value)

withHighValue

public MiningField withHighValue(Double value)

withMissingValueReplacement

public MiningField withMissingValueReplacement(String value)

withMissingValueTreatment

public MiningField withMissingValueTreatment(MissingValueTreatmentMethodType value)

withInvalidValueTreatment

public MiningField withInvalidValueTreatment(InvalidValueTreatmentMethodType value)

sourceLocation

public Locator sourceLocation()

Specified by:

sourceLocation in interface com.sun.xml.bind.Locatable

Specified by:

sourceLocation in class PMMLObject

setSourceLocation

public void setSourceLocation(Locator newLocator)

Specified by:

setSourceLocation in class PMMLObject

getDisplayName

public String getDisplayName()

Gets the value of the displayName property.

Specified by:

getDisplayName in class Field

Throws:

UnsupportedOperationException - Always.

setDisplayName

public void 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 void 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