Package com.affinda.api.client.models

Class DataField

java.lang.Object

com.affinda.api.client.models.DataField

public final class DataField
extends Object

The DataField model.

Constructor Summary

Constructors

Constructor	Description
DataField()

Method Summary

Modifier and Type	Method	Description
String	getCategoryLabel()	Get the categoryLabel property: The label of the category that this field will be put into.
DataFieldDataPoint	getDataPoint()	Get the dataPoint property: The data point to be created for this field.
DataFieldField	getField()	Get the field property: The field to be created.
DataField	setCategoryLabel(String categoryLabel)	Set the categoryLabel property: The label of the category that this field will be put into.
DataField	setDataPoint(DataFieldDataPoint dataPoint)	Set the dataPoint property: The data point to be created for this field.
DataField	setField(DataFieldField field)	Set the field property: The field to be created.

Methods inherited from class java.lang.Object

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

Constructor Detail

DataField

public DataField()

Method Detail

getCategoryLabel

public String getCategoryLabel()

Get the categoryLabel property: The label of the category that this field will be put into. If not provided, the field will be put into the default category. If no category exists with the specified label, a new category will be created.

Returns:

the categoryLabel value.

setCategoryLabel

public DataField setCategoryLabel(String categoryLabel)

Set the categoryLabel property: The label of the category that this field will be put into. If not provided, the field will be put into the default category. If no category exists with the specified label, a new category will be created.

Parameters:

categoryLabel - the categoryLabel value to set.

Returns:

the DataField object itself.

getField

public DataFieldField getField()

Get the field property: The field to be created.

Returns:

the field value.

setField

public DataField setField(DataFieldField field)

Set the field property: The field to be created.

Parameters:

field - the field value to set.

Returns:

the DataField object itself.

getDataPoint

public DataFieldDataPoint getDataPoint()

Get the dataPoint property: The data point to be created for this field. If a data point with the same slug and collection already exists, it will be reused.

Returns:

the dataPoint value.

setDataPoint

public DataField setDataPoint(DataFieldDataPoint dataPoint)

Set the dataPoint property: The data point to be created for this field. If a data point with the same slug and collection already exists, it will be reused.

Parameters:

dataPoint - the dataPoint value to set.

Returns:

the DataField object itself.