org.dmg.pmml

Class OutputField

java.lang.Object

org.dmg.pmml.PMMLObject

org.dmg.pmml.Field

org.dmg.pmml.OutputField

All Implemented Interfaces:

Serializable, HasExtensions, HasLocator, HasName, Indexable<FieldName>, Visitable

public class OutputField
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 minOccurs="0">
           <element ref="{http://www.dmg.org/PMML-4_2}Decisions" minOccurs="0"/>
           <group ref="{http://www.dmg.org/PMML-4_2}EXPRESSION"/>
         </sequence>
       </sequence>
       <attribute name="name" use="required" type="{http://www.dmg.org/PMML-4_2}FIELD-NAME" />
       <attribute name="displayName" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="optype" type="{http://www.dmg.org/PMML-4_2}OPTYPE" />
       <attribute name="dataType" type="{http://www.dmg.org/PMML-4_2}DATATYPE" />
       <attribute name="targetField" type="{http://www.dmg.org/PMML-4_2}FIELD-NAME" />
       <attribute name="feature" type="{http://www.dmg.org/PMML-4_2}RESULT-FEATURE" default="predictedValue" />
       <attribute name="value" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="ruleFeature" type="{http://www.dmg.org/PMML-4_2}RULE-FEATURE" default="consequent" />
       <attribute name="algorithm" default="exclusiveRecommendation">
         <simpleType>
           <restriction base="{http://www.w3.org/2001/XMLSchema}string">
             <enumeration value="recommendation"/>
             <enumeration value="exclusiveRecommendation"/>
             <enumeration value="ruleAssociation"/>
           </restriction>
         </simpleType>
       </attribute>
       <attribute name="rank" type="{http://www.dmg.org/PMML-4_2}INT-NUMBER" default="1" />
       <attribute name="rankBasis" default="confidence">
         <simpleType>
           <restriction base="{http://www.w3.org/2001/XMLSchema}string">
             <enumeration value="confidence"/>
             <enumeration value="support"/>
             <enumeration value="lift"/>
             <enumeration value="leverage"/>
             <enumeration value="affinity"/>
           </restriction>
         </simpleType>
       </attribute>
       <attribute name="rankOrder" default="descending">
         <simpleType>
           <restriction base="{http://www.w3.org/2001/XMLSchema}string">
             <enumeration value="descending"/>
             <enumeration value="ascending"/>
           </restriction>
         </simpleType>
       </attribute>
       <attribute name="isMultiValued" type="{http://www.w3.org/2001/XMLSchema}anySimpleType" default="0" />
       <attribute name="segmentId" type="{http://www.w3.org/2001/XMLSchema}string" />
     </restriction>
   </complexContent>
 </complexType>
 

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OutputField.Algorithm Java class for null.
static class	OutputField.RankBasis Java class for null.
static class	OutputField.RankOrder Java class for null.

Constructor Summary

Constructors

Constructor and Description
OutputField()
OutputField(FieldName name)

Method Summary

Methods

Modifier and Type	Method and Description
VisitorAction	accept(Visitor visitor)
OutputField	addExtensions(Extension... extensions)
OutputField.Algorithm	getAlgorithm() Gets the value of the algorithm property.
DataType	getDataType() Gets the value of the dataType property.
Decisions	getDecisions() Gets the value of the decisions property.
String	getDisplayName() Gets the value of the displayName property.
Expression	getExpression() Gets the value of the expression property.
List<Extension>	getExtensions() Gets the value of the extensions property.
ResultFeatureType	getFeature() Gets the value of the feature property.
String	getIsMultiValued() Gets the value of the isMultiValued property.
FieldName	getName() Gets the value of the name property.
OpType	getOpType() Gets the value of the opType property.
int	getRank() Gets the value of the rank property.
OutputField.RankBasis	getRankBasis() Gets the value of the rankBasis property.
OutputField.RankOrder	getRankOrder() Gets the value of the rankOrder property.
RuleFeatureType	getRuleFeature() Gets the value of the ruleFeature property.
String	getSegmentId() Gets the value of the segmentId property.
FieldName	getTargetField() Gets the value of the targetField property.
String	getValue() Gets the value of the value property.
boolean	hasExtensions()
OutputField	setAlgorithm(OutputField.Algorithm algorithm) Sets the value of the algorithm property.
OutputField	setDataType(DataType dataType) Sets the value of the dataType property.
OutputField	setDecisions(Decisions decisions) Sets the value of the decisions property.
OutputField	setDisplayName(String displayName) Sets the value of the displayName property.
OutputField	setExpression(Expression expression) Sets the value of the expression property.
OutputField	setFeature(ResultFeatureType feature) Sets the value of the feature property.
OutputField	setIsMultiValued(String isMultiValued) Sets the value of the isMultiValued property.
OutputField	setName(FieldName name) Sets the value of the name property.
OutputField	setOpType(OpType opType) Sets the value of the opType property.
OutputField	setRank(Integer rank) Sets the value of the rank property.
OutputField	setRankBasis(OutputField.RankBasis rankBasis) Sets the value of the rankBasis property.
OutputField	setRankOrder(OutputField.RankOrder rankOrder) Sets the value of the rankOrder property.
OutputField	setRuleFeature(RuleFeatureType ruleFeature) Sets the value of the ruleFeature property.
OutputField	setSegmentId(String segmentId) Sets the value of the segmentId property.
OutputField	setTargetField(FieldName targetField) Sets the value of the targetField property.
OutputField	setValue(String value) Sets the value of the value property.

Methods inherited from class org.dmg.pmml.Field

getKey

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

OutputField

public OutputField()

OutputField

public OutputField(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 OutputField 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

getDisplayName

public String getDisplayName()

Gets the value of the displayName property.

Overrides:

getDisplayName in class Field

Returns:

possible object is String

setDisplayName

public OutputField setDisplayName(String displayName)

Sets the value of the displayName property.

Overrides:

setDisplayName in class Field

Parameters:

displayName - allowed object is String

getOpType

public OpType getOpType()

Gets the value of the opType property.

Specified by:

getOpType in class Field

Returns:

possible object is OpType

setOpType

public OutputField setOpType(OpType opType)

Sets the value of the opType property.

Specified by:

setOpType in class Field

Parameters:

opType - allowed object is OpType

getDataType

public DataType getDataType()

Gets the value of the dataType property.

Specified by:

getDataType in class Field

Returns:

possible object is DataType

setDataType

public OutputField setDataType(DataType dataType)

Sets the value of the dataType property.

Specified by:

setDataType in class Field

Parameters:

dataType - allowed object is DataType

getTargetField

public FieldName getTargetField()

Gets the value of the targetField property.

Returns:

possible object is String

setTargetField

public OutputField setTargetField(FieldName targetField)

Sets the value of the targetField property.

Parameters:

targetField - allowed object is String

getFeature

public ResultFeatureType getFeature()

Gets the value of the feature property.

Returns:

possible object is ResultFeatureType

setFeature

public OutputField setFeature(ResultFeatureType feature)

Sets the value of the feature property.

Parameters:

feature - allowed object is ResultFeatureType

getValue

public String getValue()

Gets the value of the value property.

Returns:

possible object is String

setValue

public OutputField setValue(String value)

Sets the value of the value property.

Parameters:

value - allowed object is String

getRuleFeature

public RuleFeatureType getRuleFeature()

Gets the value of the ruleFeature property.

Returns:

possible object is RuleFeatureType

setRuleFeature

public OutputField setRuleFeature(RuleFeatureType ruleFeature)

Sets the value of the ruleFeature property.

Parameters:

ruleFeature - allowed object is RuleFeatureType

getAlgorithm

public OutputField.Algorithm getAlgorithm()

Gets the value of the algorithm property.

Returns:

possible object is OutputField.Algorithm

setAlgorithm

public OutputField setAlgorithm(OutputField.Algorithm algorithm)

Sets the value of the algorithm property.

Parameters:

algorithm - allowed object is OutputField.Algorithm

getRank

public int getRank()

Gets the value of the rank property.

Returns:

possible object is String

setRank

public OutputField setRank(Integer rank)

Sets the value of the rank property.

Parameters:

rank - allowed object is String

getRankBasis

public OutputField.RankBasis getRankBasis()

Gets the value of the rankBasis property.

Returns:

possible object is OutputField.RankBasis

setRankBasis

public OutputField setRankBasis(OutputField.RankBasis rankBasis)

Sets the value of the rankBasis property.

Parameters:

rankBasis - allowed object is OutputField.RankBasis

getRankOrder

public OutputField.RankOrder getRankOrder()

Gets the value of the rankOrder property.

Returns:

possible object is OutputField.RankOrder

setRankOrder

public OutputField setRankOrder(OutputField.RankOrder rankOrder)

Sets the value of the rankOrder property.

Parameters:

rankOrder - allowed object is OutputField.RankOrder

getIsMultiValued

public String getIsMultiValued()

Gets the value of the isMultiValued property.

Returns:

possible object is String

setIsMultiValued

public OutputField setIsMultiValued(String isMultiValued)

Sets the value of the isMultiValued property.

Parameters:

isMultiValued - allowed object is String

getSegmentId

public String getSegmentId()

Gets the value of the segmentId property.

Returns:

possible object is String

setSegmentId

public OutputField setSegmentId(String segmentId)

Sets the value of the segmentId property.

Parameters:

segmentId - allowed object is String

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

getDecisions

public Decisions getDecisions()

Gets the value of the decisions property.

Returns:

possible object is Decisions

setDecisions

public OutputField setDecisions(Decisions decisions)

Sets the value of the decisions property.

Parameters:

decisions - allowed object is Decisions

getExpression

public Expression getExpression()

Gets the value of the expression property.

Returns:

possible object is Constant FieldRef NormContinuous NormDiscrete Discretize MapValues TextIndex Apply Aggregate

setExpression

public OutputField setExpression(Expression expression)

Sets the value of the expression property.

Parameters:

expression - allowed object is Constant FieldRef NormContinuous NormDiscrete Discretize MapValues TextIndex Apply Aggregate

hasExtensions

public boolean hasExtensions()

Specified by:

hasExtensions in interface HasExtensions

addExtensions

public OutputField addExtensions(Extension... extensions)

accept

public VisitorAction accept(Visitor visitor)

Specified by:

accept in interface Visitable