org.dmg.pmml

Class DefineFunction

java.lang.Object

org.dmg.pmml.PMMLObject

org.dmg.pmml.DefineFunction

All Implemented Interfaces:

Serializable, HasExpression, HasExtensions, HasLocator, Indexable<String>, Visitable

public class DefineFunction
extends PMMLObject
implements HasExpression, HasExtensions, Indexable<String>

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"/>
         <element ref="{http://www.dmg.org/PMML-4_2}ParameterField" maxOccurs="unbounded"/>
         <group ref="{http://www.dmg.org/PMML-4_2}EXPRESSION"/>
       </sequence>
       <attribute name="name" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="optype" use="required" type="{http://www.dmg.org/PMML-4_2}OPTYPE" />
       <attribute name="dataType" type="{http://www.dmg.org/PMML-4_2}DATATYPE" />
     </restriction>
   </complexContent>
 </complexType>
 

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DefineFunction()
DefineFunction(String name, OpType opType, List<ParameterField> parameterFields)

Method Summary

Methods

Modifier and Type	Method and Description
VisitorAction	accept(Visitor visitor)
DefineFunction	addExtensions(Extension... extensions)
DefineFunction	addParameterFields(ParameterField... parameterFields)
DataType	getDataType() Gets the value of the dataType property.
Expression	getExpression() Gets the value of the expression property.
List<Extension>	getExtensions() Gets the value of the extensions property.
String	getKey()
String	getName() Gets the value of the name property.
OpType	getOpType() Gets the value of the opType property.
List<ParameterField>	getParameterFields() Gets the value of the parameterFields property.
boolean	hasExtensions()
boolean	hasParameterFields()
DefineFunction	setDataType(DataType dataType) Sets the value of the dataType property.
DefineFunction	setExpression(Expression expression) Sets the value of the expression property.
DefineFunction	setName(String name) Sets the value of the name property.
DefineFunction	setOpType(OpType opType) Sets the value of the opType 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

DefineFunction

public DefineFunction()

DefineFunction

public DefineFunction(String name,
              OpType opType,
              List<ParameterField> parameterFields)

Method Detail

getName

public String getName()

Gets the value of the name property.

Returns:

possible object is String

setName

public DefineFunction setName(String name)

Sets the value of the name property.

Parameters:

name - allowed object is String

getOpType

public OpType getOpType()

Gets the value of the opType property.

Returns:

possible object is OpType

setOpType

public DefineFunction setOpType(OpType opType)

Sets the value of the opType property.

Parameters:

opType - allowed object is OpType

getDataType

public DataType getDataType()

Gets the value of the dataType property.

Returns:

possible object is DataType

setDataType

public DefineFunction setDataType(DataType dataType)

Sets the value of the dataType property.

Parameters:

dataType - allowed object is DataType

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

getParameterFields

public List<ParameterField> getParameterFields()

Gets the value of the parameterFields 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 parameterFields property.

For example, to add a new item, do as follows:

    getParameterFields().add(newItem);
 

Objects of the following type(s) are allowed in the list ParameterField

getExpression

public Expression getExpression()

Gets the value of the expression property.

Specified by:

getExpression in interface HasExpression

Returns:

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

setExpression

public DefineFunction setExpression(Expression expression)

Sets the value of the expression property.

Specified by:

setExpression in interface HasExpression

Parameters:

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

getKey

public String getKey()

Specified by:

getKey in interface Indexable<String>

Returns:

The value of the primary key-like attribute. Never null.

hasExtensions

public boolean hasExtensions()

Specified by:

hasExtensions in interface HasExtensions

addExtensions

public DefineFunction addExtensions(Extension... extensions)

hasParameterFields

public boolean hasParameterFields()

addParameterFields

public DefineFunction addParameterFields(ParameterField... parameterFields)

accept

public VisitorAction accept(Visitor visitor)

Specified by:

accept in interface Visitable