com.thingworx.metadata.collections

Class FieldDefinitionCollection

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<K,V>

java.util.LinkedHashMap<java.lang.String,T>

com.thingworx.types.collections.GenericObjectCollection<T>

com.thingworx.types.collections.NamedObjectCollection<FieldDefinition>

com.thingworx.metadata.collections.FieldDefinitionCollection

All Implemented Interfaces:

IDiffableObject, java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.String,FieldDefinition>

@ThingworxExtensionApiClass(since={6,6},
                            canInstantiate=true)
public final class FieldDefinitionCollection
extends NamedObjectCollection<FieldDefinition>

A map of field names to their associated field definitions. A FieldDefinitionCollection supports serialization to XML and JSON, as well as creating derived data shape definitions. Fields belonging to this map can be iterated over according to their ordinality or storage order.

See Also:

FieldDefinition, DataShapeDefinition, ServiceDefinition, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

Constructor Summary

Constructors

Constructor and Description
FieldDefinitionCollection()

Method Summary

Modifier and Type	Method and Description
void	addFieldDefinition(FieldDefinition field) Adds a new field definition to this data shape definition.
FieldDefinitionCollection	clone() Returns a deep clone of this collection.
FieldDefinition	getFieldDefinition(java.lang.String name) Returns the field definition with the specified name.
java.util.ArrayList<FieldDefinition>	getOrderedFields() Returns a list of the field definitions in this collection using their natural order.
java.util.ArrayList<FieldDefinition>	getOrderedFieldsByOrdinal() Returns a list of field definitions in this collection using the order defined by their ordinality.
DataShapeDefinition	toDataShape() Returns a new DataShapeDefinition containing the field definitions stored in this collection.

Methods inherited from class com.thingworx.types.collections.NamedObjectCollection

getNamesAsInfoTable, getOrderedList

Methods inherited from class com.thingworx.types.collections.GenericObjectCollection

containsEntity, getDescription, getName, getNames

Methods inherited from class java.util.LinkedHashMap

clear, containsValue, entrySet, forEach, get, getOrDefault, keySet, removeEldestEntry, replaceAll, values

Methods inherited from class java.util.HashMap

compute, computeIfAbsent, computeIfPresent, containsKey, isEmpty, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, size

Methods inherited from class java.util.AbstractMap

equals, hashCode, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, containsKey, equals, hashCode, isEmpty, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, size

Constructor Detail

FieldDefinitionCollection

public FieldDefinitionCollection()

Method Detail

getFieldDefinition

@ThingworxExtensionApiMethod(since={6,6})
public FieldDefinition getFieldDefinition(java.lang.String name)

Returns the field definition with the specified name.

Parameters:

name - the name of the field to return

Returns:

the specified field definition, or null if the field does not exist

addFieldDefinition

@ThingworxExtensionApiMethod(since={6,6})
public void addFieldDefinition(FieldDefinition field)

Adds a new field definition to this data shape definition.

Parameters:

field - the field definition to add

toDataShape

@ThingworxExtensionApiMethod(since={6,6})
public DataShapeDefinition toDataShape()

Returns a new DataShapeDefinition containing the field definitions stored in this collection.

Returns:

a DataShapeDefinition containing this collection's field definitions

getOrderedFields

@ThingworxExtensionApiMethod(since={6,6})
public java.util.ArrayList<FieldDefinition> getOrderedFields()

Returns a list of the field definitions in this collection using their natural order.

Returns:

a sorted list of field definitions

getOrderedFieldsByOrdinal

@ThingworxExtensionApiMethod(since={6,6})
public java.util.ArrayList<FieldDefinition> getOrderedFieldsByOrdinal()

Returns a list of field definitions in this collection using the order defined by their ordinality.

Returns:

a sorted list of field definitions

clone

@ThingworxExtensionApiMethod(since={6,6})
public FieldDefinitionCollection clone()

Returns a deep clone of this collection.

Overrides:

clone in class java.util.HashMap<java.lang.String,FieldDefinition>

Returns:

a clone of this collection