java.lang.Object
com.esri.arcgisruntime.data.Field
Represents a single field of a
FeatureTable
.- Since:
- 100.0.0
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic Field
createDate
(String name, String alias) Creates a Field of typeField.Type.DATE
which corresponds to the Java typeCalendar
.static Field
createDateOnly
(String name, String alias) Creates a newField.Type.DATE_ONLY
field which corresponds to the Java typeLocalDate
.static Field
createDouble
(String name, String alias) Creates a Field of typeField.Type.DOUBLE
which corresponds to the Java typeDouble
.static Field
createFloat
(String name, String alias) Creates a Field of typeField.Type.FLOAT
which corresponds to the Java typeFloat
.static Field
createInteger
(String name, String alias) Creates a Field of typeField.Type.INTEGER
which corresponds to the Java typeInteger
.static Field
createLong
(String name, String alias) Creates a newField.Type.LONG
field object with the following parameters.static Field
createShort
(String name, String alias) Creates a Field of typeField.Type.SHORT
which corresponds to the Java typeShort
.static Field
createString
(String name, String alias, int length) Creates a Field of typeField.Type.TEXT
which corresponds to the Java typeString
.static Field
createTimeOnly
(String name, String alias) Creates a newField.Type.TIME_ONLY
field which corresponds to the Java typeLocalTime
.static Field
createTimestampOffset
(String name, String alias) Creates a newField.Type.TIMESTAMP_OFFSET
field which corresponds to the Java typeOffsetDateTime
.static Field
Creates a Field instance from a JSON string.getAlias()
Gets the alias of the Field, a user-friendly string often used for display in a user interface.Gets the domain of the Field.Gets the type of the Field.int
Gets the length of the Field.getName()
Gets the name of the Field.boolean
Gets whether or not the Field is editable.boolean
True if the field is nullable.toJson()
Serializes this Field to a JSON string.
-
Method Details
-
createDate
Creates a Field of typeField.Type.DATE
which corresponds to the Java typeCalendar
.The field will be editable and nullable.
- Parameters:
name
- the name of the fieldalias
- 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
Creates a newField.Type.DATE_ONLY
field which corresponds to the Java typeLocalDate
.Use this method to create a field. The field will be editable and nullable.
- Parameters:
name
- name of the fieldalias
- alias of the field- Returns:
- a Field
- Throws:
NullPointerException
- if name is nullNullPointerException
- if alias is null- Since:
- 200.4.0
-
createDouble
Creates a Field of typeField.Type.DOUBLE
which corresponds to the Java typeDouble
.The field will be editable and nullable.
- Parameters:
name
- the name of the fieldalias
- 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
Creates a Field of typeField.Type.FLOAT
which corresponds to the Java typeFloat
.The field will be editable and nullable.
- Parameters:
name
- the name of the fieldalias
- 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
Creates a Field of typeField.Type.INTEGER
which corresponds to the Java typeInteger
.The field will be editable and nullable.
- Parameters:
name
- the name of the fieldalias
- 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
Creates a newField.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 fieldalias
- alias of the field- Returns:
- a Field
- Throws:
NullPointerException
- if name is nullNullPointerException
- if alias is null- Since:
- 200.4.0
-
createShort
Creates a Field of typeField.Type.SHORT
which corresponds to the Java typeShort
.The field will be editable and nullable.
- Parameters:
name
- the name of the fieldalias
- 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
Creates a newField.Type.TIME_ONLY
field which corresponds to the Java typeLocalTime
.Use this method to create a field. The field will be editable and nullable.
- Parameters:
name
- name of the fieldalias
- alias of the field- Returns:
- a Field
- Throws:
NullPointerException
- if name is nullNullPointerException
- if alias is null- Since:
- 200.4.0
-
createTimestampOffset
Creates a newField.Type.TIMESTAMP_OFFSET
field which corresponds to the Java typeOffsetDateTime
.Use this method to create a field. The field will be editable and nullable.
- Parameters:
name
- name of the fieldalias
- alias of the field- Returns:
- a Field
- Throws:
NullPointerException
- if name is nullNullPointerException
- if alias is null- Since:
- 200.4.0
-
createString
Creates a Field of typeField.Type.TEXT
which corresponds to the Java typeString
.The field will be editable and nullable.
- Parameters:
name
- the name of the fieldalias
- the alias of the field, if null or empty it will be substituted by the field namelength
- 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
Serializes this Field to a JSON string.- Returns:
- the JSON representation of this Field
- Since:
- 100.0.0
-
fromJson
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
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
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
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 forField.Type.TEXT
type fields.- Returns:
- the length of the Field
- Since:
- 100.0.0
-
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
-