OutputField (JPMML class model 1.1.2 API)

java.lang.Object
- org.dmg.pmml.PMMLObject
- - org.dmg.pmml.Field
  - - org.dmg.pmml.OutputField

All Implemented Interfaces:: com.sun.xml.bind.Locatable, Serializable, HasExtensions, HasName, Visitable

public class OutputField
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_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.

Field Summary

Fields
Modifier and Type	Field and Description
`protected OutputField.Algorithm`	`algorithm`
`protected DataType`	`dataType`
`protected Decisions`	`decisions`
`protected String`	`displayName`
`protected Expression`	`expression`
`protected List<Extension>`	`extensions`
`protected ResultFeatureType`	`feature`
`protected String`	`isMultiValued`
`protected Locator`	`locator`
`protected FieldName`	`name`
`protected OpType`	`optype`
`protected Integer`	`rank`
`protected OutputField.RankBasis`	`rankBasis`
`protected OutputField.RankOrder`	`rankOrder`
`protected RuleFeatureType`	`ruleFeature`
`protected String`	`segmentId`
`protected FieldName`	`targetField`
`protected String`	`value`

Constructor Summary

Constructors
Constructor and Description

OutputField()
Deprecated.

OutputField(FieldName name)

Constructors
Constructor and Description
`OutputField()` Deprecated.
`OutputField(FieldName name)`

Method Summary

Methods
Modifier and Type	Method and Description
`VisitorAction`	`accept(Visitor visitor)`
`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.
`void`	`setAlgorithm(OutputField.Algorithm value)` Sets the value of the algorithm property.
`void`	`setDataType(DataType value)` Sets the value of the dataType property.
`void`	`setDecisions(Decisions value)` Sets the value of the decisions property.
`void`	`setDisplayName(String value)` Sets the value of the displayName property.
`void`	`setExpression(Expression value)` Sets the value of the expression property.
`void`	`setFeature(ResultFeatureType value)` Sets the value of the feature property.
`void`	`setIsMultiValued(String value)` Sets the value of the isMultiValued property.
`void`	`setName(FieldName value)` Sets the value of the name property.
`void`	`setOptype(OpType value)` Sets the value of the optype property.
`void`	`setRank(Integer value)` Sets the value of the rank property.
`void`	`setRankBasis(OutputField.RankBasis value)` Sets the value of the rankBasis property.
`void`	`setRankOrder(OutputField.RankOrder value)` Sets the value of the rankOrder property.
`void`	`setRuleFeature(RuleFeatureType value)` Sets the value of the ruleFeature property.
`void`	`setSegmentId(String value)` Sets the value of the segmentId property.
`void`	`setSourceLocation(Locator newLocator)`
`void`	`setTargetField(FieldName value)` Sets the value of the targetField property.
`void`	`setValue(String value)` Sets the value of the value property.
`Locator`	`sourceLocation()`
`OutputField`	`withAlgorithm(OutputField.Algorithm value)`
`OutputField`	`withDataType(DataType value)`
`OutputField`	`withDecisions(Decisions value)`
`OutputField`	`withDisplayName(String value)`
`OutputField`	`withExpression(Expression value)`
`OutputField`	`withExtensions(Collection<Extension> values)`
`OutputField`	`withExtensions(Extension... values)`
`OutputField`	`withFeature(ResultFeatureType value)`
`OutputField`	`withIsMultiValued(String value)`
`OutputField`	`withName(FieldName value)`
`OutputField`	`withOptype(OpType value)`
`OutputField`	`withRank(Integer value)`
`OutputField`	`withRankBasis(OutputField.RankBasis value)`
`OutputField`	`withRankOrder(OutputField.RankOrder value)`
`OutputField`	`withRuleFeature(RuleFeatureType value)`
`OutputField`	`withSegmentId(String value)`
`OutputField`	`withTargetField(FieldName value)`
`OutputField`	`withValue(String 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
```
  - decisions
```
protected Decisions decisions
```
  - expression
```
protected Expression expression
```
  - name
```
protected FieldName name
```
  - displayName
```
protected String displayName
```
  - optype
```
protected OpType optype
```
  - dataType
```
protected DataType dataType
```
  - targetField
```
protected FieldName targetField
```
  - feature
```
protected ResultFeatureType feature
```
  - value
```
protected String value
```
  - ruleFeature
```
protected RuleFeatureType ruleFeature
```
  - algorithm
```
protected OutputField.Algorithm algorithm
```
  - rank
```
protected Integer rank
```
  - rankBasis
```
protected OutputField.RankBasis rankBasis
```
  - rankOrder
```
protected OutputField.RankOrder rankOrder
```
  - isMultiValued
```
protected String isMultiValued
```
  - segmentId
```
protected String segmentId
```
  - locator
```
protected Locator locator
```
- Constructor Detail
  - OutputField
```
@Deprecated
public OutputField()
```
    Deprecated.
  - OutputField
```
public OutputField(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
  - getDecisions
```
public Decisions getDecisions()
```
    Gets the value of the decisions property.
    
    Returns:
    possible object is Decisions
  - setDecisions
```
public void setDecisions(Decisions value)
```
    Sets the value of the decisions property.
    
    Parameters:
    value - 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 void setExpression(Expression value)
```
    Sets the value of the expression property.
    
    Parameters:
    value - allowed object is Constant FieldRef NormContinuous NormDiscrete Discretize MapValues TextIndex Apply Aggregate
  - 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
  - getDisplayName
```
public String getDisplayName()
```
    Gets the value of the displayName property.
    
    Specified by:
    
    getDisplayName in class Field
    
    Returns:
    possible object is String
  - setDisplayName
```
public void setDisplayName(String value)
```
    Sets the value of the displayName property.
    
    Specified by:
    
    setDisplayName in class Field
    
    Parameters:
    value - 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 void setOptype(OpType value)
```
    Sets the value of the optype property.
    
    Specified by:
    
    setOptype in class Field
    
    Parameters:
    value - 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 void setDataType(DataType value)
```
    Sets the value of the dataType property.
    
    Specified by:
    
    setDataType in class Field
    
    Parameters:
    value - allowed object is DataType
  - getTargetField
```
public FieldName getTargetField()
```
    Gets the value of the targetField property.
    
    Returns:
    possible object is String
  - setTargetField
```
public void setTargetField(FieldName value)
```
    Sets the value of the targetField property.
    
    Parameters:
    value - allowed object is String
  - getFeature
```
public ResultFeatureType getFeature()
```
    Gets the value of the feature property.
    
    Returns:
    possible object is ResultFeatureType
  - setFeature
```
public void setFeature(ResultFeatureType value)
```
    Sets the value of the feature property.
    
    Parameters:
    value - allowed object is ResultFeatureType
  - getValue
```
public String getValue()
```
    Gets the value of the value property.
    
    Returns:
    possible object is String
  - setValue
```
public void 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 void setRuleFeature(RuleFeatureType value)
```
    Sets the value of the ruleFeature property.
    
    Parameters:
    value - allowed object is RuleFeatureType
  - getAlgorithm
```
public OutputField.Algorithm getAlgorithm()
```
    Gets the value of the algorithm property.
    
    Returns:
    possible object is OutputField.Algorithm
  - setAlgorithm
```
public void setAlgorithm(OutputField.Algorithm value)
```
    Sets the value of the algorithm property.
    
    Parameters:
    value - allowed object is OutputField.Algorithm
  - getRank
```
public int getRank()
```
    Gets the value of the rank property.
    
    Returns:
    possible object is String
  - setRank
```
public void setRank(Integer value)
```
    Sets the value of the rank property.
    
    Parameters:
    value - allowed object is String
  - getRankBasis
```
public OutputField.RankBasis getRankBasis()
```
    Gets the value of the rankBasis property.
    
    Returns:
    possible object is OutputField.RankBasis
  - setRankBasis
```
public void setRankBasis(OutputField.RankBasis value)
```
    Sets the value of the rankBasis property.
    
    Parameters:
    value - 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 void setRankOrder(OutputField.RankOrder value)
```
    Sets the value of the rankOrder property.
    
    Parameters:
    value - allowed object is OutputField.RankOrder
  - getIsMultiValued
```
public String getIsMultiValued()
```
    Gets the value of the isMultiValued property.
    
    Returns:
    possible object is String
  - setIsMultiValued
```
public void setIsMultiValued(String value)
```
    Sets the value of the isMultiValued property.
    
    Parameters:
    value - allowed object is String
  - getSegmentId
```
public String getSegmentId()
```
    Gets the value of the segmentId property.
    
    Returns:
    possible object is String
  - setSegmentId
```
public void setSegmentId(String value)
```
    Sets the value of the segmentId property.
    
    Parameters:
    value - allowed object is String
  - withExtensions
```
public OutputField withExtensions(Extension... values)
```
  - withExtensions
```
public OutputField withExtensions(Collection<Extension> values)
```
  - withDecisions
```
public OutputField withDecisions(Decisions value)
```
  - withExpression
```
public OutputField withExpression(Expression value)
```
  - withName
```
public OutputField withName(FieldName value)
```
  - withDisplayName
```
public OutputField withDisplayName(String value)
```
  - withOptype
```
public OutputField withOptype(OpType value)
```
  - withDataType
```
public OutputField withDataType(DataType value)
```
  - withTargetField
```
public OutputField withTargetField(FieldName value)
```
  - withFeature
```
public OutputField withFeature(ResultFeatureType value)
```
  - withValue
```
public OutputField withValue(String value)
```
  - withRuleFeature
```
public OutputField withRuleFeature(RuleFeatureType value)
```
  - withAlgorithm
```
public OutputField withAlgorithm(OutputField.Algorithm value)
```
  - withRank
```
public OutputField withRank(Integer value)
```
  - withRankBasis
```
public OutputField withRankBasis(OutputField.RankBasis value)
```
  - withRankOrder
```
public OutputField withRankOrder(OutputField.RankOrder value)
```
  - withIsMultiValued
```
public OutputField withIsMultiValued(String value)
```
  - withSegmentId
```
public OutputField withSegmentId(String 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
  - accept
```
public VisitorAction accept(Visitor visitor)
```
    Specified by:
    
    accept in interface Visitable

Class OutputField

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

extensions

decisions

expression

name

displayName

optype

dataType

targetField

feature

value

ruleFeature

algorithm

rank

rankBasis

rankOrder

isMultiValued

segmentId

locator

Constructor Detail

OutputField

OutputField

Method Detail

getExtensions

getDecisions

setDecisions

getExpression

setExpression

getName

setName

getDisplayName

setDisplayName

getOptype

setOptype

getDataType

setDataType

getTargetField

setTargetField

getFeature

setFeature

getValue

setValue

getRuleFeature

setRuleFeature

getAlgorithm

setAlgorithm

getRank

setRank

getRankBasis

setRankBasis

getRankOrder

setRankOrder

getIsMultiValued

setIsMultiValued

getSegmentId

setSegmentId

withExtensions

withExtensions

withDecisions

withExpression

withName

withDisplayName

withOptype

withDataType

withTargetField

withFeature

withValue

withRuleFeature

withAlgorithm

withRank

withRankBasis

withRankOrder

withIsMultiValued

withSegmentId