Module com.esri.arcgisruntime

Package com.esri.arcgisruntime.data

Class Field

java.lang.Object

com.esri.arcgisruntime.data.Field

public final class Field
extends Object

Represents a single field of a FeatureTable.

Since:

100.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Field.Type	The different row value types.

Method Summary

Modifier and Type	Method	Description
static Field	createDate(String name, String alias)	Creates a Field of type Field.Type.DATE which corresponds to the Java type Calendar.
static Field	createDateOnly(String name, String alias)	Creates a new Field.Type.DATE_ONLY field which corresponds to the Java type LocalDate.
static Field	createDouble(String name, String alias)	Creates a Field of type Field.Type.DOUBLE which corresponds to the Java type Double.
static Field	createFloat(String name, String alias)	Creates a Field of type Field.Type.FLOAT which corresponds to the Java type Float.
static Field	createInteger(String name, String alias)	Creates a Field of type Field.Type.INTEGER which corresponds to the Java type Integer.
static Field	createLong(String name, String alias)	Creates a new Field.Type.LONG field object with the following parameters.
static Field	createShort(String name, String alias)	Creates a Field of type Field.Type.SHORT which corresponds to the Java type Short.
static Field	createString(String name, String alias, int length)	Creates a Field of type Field.Type.TEXT which corresponds to the Java type String.
static Field	createTimeOnly(String name, String alias)	Creates a new Field.Type.TIME_ONLY field which corresponds to the Java type LocalTime.
static Field	createTimestampOffset(String name, String alias)	Creates a new Field.Type.TIMESTAMP_OFFSET field which corresponds to the Java type OffsetDateTime.
static Field	fromJson(String json)	Creates a Field instance from a JSON string.
String	getAlias()	Gets the alias of the Field, a user-friendly string often used for display in a user interface.
Domain	getDomain()	Gets the domain of the Field.
Field.Type	getFieldType()	Gets the type of the Field.
int	getLength()	Gets the length of the Field.
String	getName()	Gets the name of the Field.
boolean	isEditable()	Gets whether or not the Field is editable.
boolean	isNullable()	True if the field is nullable.
String	toJson()	Serializes this Field to a JSON string.

Methods inherited from class java.lang.Object

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

Method Details

createDate

public static Field createDate(String name,
 String alias)

Creates a Field of type Field.Type.DATE which corresponds to the Java type Calendar.

The field will be editable and nullable.

Parameters:

name - the name of the field

alias - the alias of the field, if null or empty it will be substituted by the field name

Returns:

a date Field

Throws:

IllegalArgumentException - if name is null or empty

Since:

100.0.0

createDateOnly

public static Field createDateOnly(String name,
 String alias)

Creates a new Field.Type.DATE_ONLY field which corresponds to the Java type LocalDate.

Use this method to create a field. The field will be editable and nullable.

Parameters:

name - name of the field

alias - alias of the field

Returns:

a Field

Throws:

NullPointerException - if name is null

NullPointerException - if alias is null

Since:

200.4.0

createDouble

public static Field createDouble(String name,
 String alias)

Creates a Field of type Field.Type.DOUBLE which corresponds to the Java type Double.

The field will be editable and nullable.

Parameters:

name - the name of the field

alias - the alias of the field, if null or empty it will be substituted by the field name

Returns:

a double-precision floating point field

Throws:

IllegalArgumentException - if name is null or empty

Since:

100.0.0

createFloat

public static Field createFloat(String name,
 String alias)

Creates a Field of type Field.Type.FLOAT which corresponds to the Java type Float.

The field will be editable and nullable.

Parameters:

name - the name of the field

alias - the alias of the field, if null or empty it will be substituted by the field name

Returns:

a single-precision floating point field

Throws:

IllegalArgumentException - if name is null or empty

Since:

100.0.0

createInteger

public static Field createInteger(String name,
 String alias)

Creates a Field of type Field.Type.INTEGER which corresponds to the Java type Integer.

The field will be editable and nullable.

Parameters:

name - the name of the field

alias - the alias of the field, if null or empty it will be substituted by the field name

Returns:

a 32-bit integer field

Throws:

IllegalArgumentException - if name is null or empty

Since:

100.0.0

createLong

public static Field createLong(String name,
 String alias)

Creates a new Field.Type.LONG field object with the following parameters.

Use this method to create a field. The field will be editable and nullable.

Parameters:

name - name of the field

alias - alias of the field

Returns:

a Field

Throws:

NullPointerException - if name is null

NullPointerException - if alias is null

Since:

200.4.0

createShort

public static Field createShort(String name,
 String alias)

Creates a Field of type Field.Type.SHORT which corresponds to the Java type Short.

The field will be editable and nullable.

Parameters:

name - the name of the field

alias - the alias of the field, if null or empty it will be substituted by the field name

Returns:

a 16-bit integer field

Throws:

IllegalArgumentException - if name is null or empty

Since:

100.0.0

createTimeOnly

public static Field createTimeOnly(String name,
 String alias)

Creates a new Field.Type.TIME_ONLY field which corresponds to the Java type LocalTime.

Use this method to create a field. The field will be editable and nullable.

Parameters:

name - name of the field

alias - alias of the field

Returns:

a Field

Throws:

NullPointerException - if name is null

NullPointerException - if alias is null

Since:

200.4.0

createTimestampOffset

public static Field createTimestampOffset(String name,
 String alias)

Creates a new Field.Type.TIMESTAMP_OFFSET field which corresponds to the Java type OffsetDateTime.

Use this method to create a field. The field will be editable and nullable.

Parameters:

name - name of the field

alias - alias of the field

Returns:

a Field

Throws:

NullPointerException - if name is null

NullPointerException - if alias is null

Since:

200.4.0

createString

public static Field createString(String name,
 String alias,
 int length)

Creates a Field of type Field.Type.TEXT which corresponds to the Java type String.

The field will be editable and nullable.

Parameters:

name - the name of the field

alias - the alias of the field, if null or empty it will be substituted by the field name

length - the maximum number of characters in the field

Returns:

a text field

Throws:

IllegalArgumentException - if name is null or empty

Since:

100.0.0

toJson

public String toJson()

Serializes this Field to a JSON string.

Returns:

the JSON representation of this Field

Since:

100.0.0

fromJson

public static Field fromJson(String json)

Creates a Field instance from a JSON string.

Parameters:

json - the JSON representation of a Field

Returns:

a Field instance deserialized from the JSON string

Throws:

IllegalArgumentException - if json is null or empty

Since:

100.0.0

getAlias

public String getAlias()

Gets the alias of the Field, a user-friendly string often used for display in a user interface.

Returns:

the alias of the Field

Since:

100.0.0

getDomain

public Domain getDomain()

Gets the domain of the Field. A domain represents the valid values for a Field. Non ArcGISFeatureTables do not have domains.

Returns:

the domain of the Field for ArcGISFeatureTables; null if there is no domain

Since:

100.0.0

getFieldType

public Field.Type getFieldType()

Gets the type of the Field.

Returns:

the type of the Field

Since:

100.0.0

getLength

public int getLength()

Gets the length of the Field. Only valid for Field.Type.TEXT type fields.

Returns:

the length of the Field

Since:

100.0.0

getName

public String getName()

Gets the name of the Field.

Returns:

the name of the Field

Since:

100.0.0

isEditable

public boolean isEditable()

Gets whether or not the Field is editable.

Returns:

true if the field is editable, otherwise false

Since:

100.0.0

isNullable

public boolean isNullable()

True if the field is nullable.

Returns:

true if the Field is nullable, otherwise false

Since:

100.0.0