DataField (JPMML class model 1.1.2 API)

java.lang.Object
- org.dmg.pmml.PMMLObject
- - org.dmg.pmml.Field
  - - org.dmg.pmml.TypeDefinitionField
    - - org.dmg.pmml.DataField

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

public class DataField
extends TypeDefinitionField
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>
           <element ref="{http://www.dmg.org/PMML-4_2}Interval" maxOccurs="unbounded" minOccurs="0"/>
           <element ref="{http://www.dmg.org/PMML-4_2}Value" maxOccurs="unbounded" minOccurs="0"/>
         </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" use="required" type="{http://www.dmg.org/PMML-4_2}OPTYPE" />
       <attribute name="dataType" use="required" type="{http://www.dmg.org/PMML-4_2}DATATYPE" />
       <attribute name="taxonomy" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="isCyclic" default="0">
         <simpleType>
           <restriction base="{http://www.w3.org/2001/XMLSchema}string">
             <enumeration value="0"/>
             <enumeration value="1"/>
           </restriction>
         </simpleType>
       </attribute>
     </restriction>
   </complexContent>
 </complexType>

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class DataField.Cyclic
Java class for null.

Nested Classes
Modifier and Type	Class and Description
`static class`	`DataField.Cyclic` Java class for null.

Field Summary

Fields
Modifier and Type	Field and Description
`protected DataField.Cyclic`	`cyclic`
`protected DataType`	`dataType`
`protected String`	`displayName`
`protected List<Extension>`	`extensions`
`protected List<Interval>`	`intervals`
`protected Locator`	`locator`
`protected FieldName`	`name`
`protected OpType`	`optype`
`protected String`	`taxonomy`
`protected List<Value>`	`values`

Constructor Summary

Constructors
Constructor and Description

DataField()
Deprecated.

DataField(FieldName name, OpType optype, DataType dataType)

Constructors
Constructor and Description
`DataField()` Deprecated.
`DataField(FieldName name, OpType optype, DataType dataType)`

Method Summary

Methods
Modifier and Type	Method and Description
`VisitorAction`	`accept(Visitor visitor)`
`DataField.Cyclic`	`getCyclic()` Gets the value of the cyclic property.
`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.
`List<Interval>`	`getIntervals()` Gets the value of the intervals property.
`FieldName`	`getName()` Gets the value of the name property.
`OpType`	`getOptype()` Gets the value of the optype property.
`String`	`getTaxonomy()` Gets the value of the taxonomy property.
`List<Value>`	`getValues()` Gets the value of the values property.
`void`	`setCyclic(DataField.Cyclic value)` Sets the value of the cyclic property.
`void`	`setDataType(DataType value)` Sets the value of the dataType property.
`void`	`setDisplayName(String value)` Sets the value of the displayName property.
`void`	`setName(FieldName value)` Sets the value of the name property.
`void`	`setOptype(OpType value)` Sets the value of the optype property.
`void`	`setSourceLocation(Locator newLocator)`
`void`	`setTaxonomy(String value)` Sets the value of the taxonomy property.
`Locator`	`sourceLocation()`
`DataField`	`withCyclic(DataField.Cyclic value)`
`DataField`	`withDataType(DataType value)`
`DataField`	`withDisplayName(String value)`
`DataField`	`withExtensions(Collection<Extension> values)`
`DataField`	`withExtensions(Extension... values)`
`DataField`	`withIntervals(Collection<Interval> values)`
`DataField`	`withIntervals(Interval... values)`
`DataField`	`withName(FieldName value)`
`DataField`	`withOptype(OpType value)`
`DataField`	`withTaxonomy(String value)`
`DataField`	`withValues(Collection<Value> values)`
`DataField`	`withValues(Value... values)`

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
```
  - intervals
```
protected List<Interval> intervals
```
  - values
```
protected List<Value> values
```
  - name
```
protected FieldName name
```
  - displayName
```
protected String displayName
```
  - optype
```
protected OpType optype
```
  - dataType
```
protected DataType dataType
```
  - taxonomy
```
protected String taxonomy
```
  - cyclic
```
protected DataField.Cyclic cyclic
```
  - locator
```
protected Locator locator
```
- Constructor Detail
  - DataField
```
@Deprecated
public DataField()
```
    Deprecated.
  - DataField
```
public DataField(FieldName name,
         OpType optype,
         DataType dataType)
```
- 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
  - getIntervals
```
public List<Interval> getIntervals()
```
    Gets the value of the intervals 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 intervals property.
    For example, to add a new item, do as follows:
```
    getIntervals().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list Interval
  - getValues
```
public List<Value> getValues()
```
    Gets the value of the values 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 values property.
    For example, to add a new item, do as follows:
```
    getValues().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list Value
    Specified by:
    
    getValues in class TypeDefinitionField
  - 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
  - getTaxonomy
```
public String getTaxonomy()
```
    Gets the value of the taxonomy property.
    
    Returns:
    possible object is String
  - setTaxonomy
```
public void setTaxonomy(String value)
```
    Sets the value of the taxonomy property.
    
    Parameters:
    value - allowed object is String
  - getCyclic
```
public DataField.Cyclic getCyclic()
```
    Gets the value of the cyclic property.
    
    Returns:
    possible object is DataField.Cyclic
  - setCyclic
```
public void setCyclic(DataField.Cyclic value)
```
    Sets the value of the cyclic property.
    
    Parameters:
    value - allowed object is DataField.Cyclic
  - withExtensions
```
public DataField withExtensions(Extension... values)
```
  - withExtensions
```
public DataField withExtensions(Collection<Extension> values)
```
  - withIntervals
```
public DataField withIntervals(Interval... values)
```
  - withIntervals
```
public DataField withIntervals(Collection<Interval> values)
```
  - withValues
```
public DataField withValues(Value... values)
```
  - withValues
```
public DataField withValues(Collection<Value> values)
```
  - withName
```
public DataField withName(FieldName value)
```
  - withDisplayName
```
public DataField withDisplayName(String value)
```
  - withOptype
```
public DataField withOptype(OpType value)
```
  - withDataType
```
public DataField withDataType(DataType value)
```
  - withTaxonomy
```
public DataField withTaxonomy(String value)
```
  - withCyclic
```
public DataField withCyclic(DataField.Cyclic 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 DataField

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

extensions

intervals

values

name

displayName

optype

dataType

taxonomy

cyclic

locator

Constructor Detail

DataField

DataField

Method Detail

getExtensions

getIntervals

getValues

getName

setName

getDisplayName

setDisplayName

getOptype

setOptype

getDataType

setDataType

getTaxonomy

setTaxonomy

getCyclic

setCyclic

withExtensions

withExtensions

withIntervals

withIntervals

withValues

withValues

withName

withDisplayName

withOptype

withDataType

withTaxonomy

withCyclic

sourceLocation

setSourceLocation

accept