Package com.thingworx.data.util

Class InfoTableInstanceFactory

java.lang.Object

com.thingworx.data.util.InfoTableInstanceFactory

@ThingworxExtensionApiClass(since={6,6},
                            canInstantiate=true)
public final class InfoTableInstanceFactory
extends Object

Constructor Summary

Constructors

Constructor	Description
InfoTableInstanceFactory()

Method Summary

Modifier and Type	Method	Description
static InfoTable	convertInfoTableUsingDataShape(InfoTable t, DataShapeDefinition ds)	Convert a given InfoTable into a new InfoTable that uses the given DataShapeDefinition
static InfoTable	createInfoTableFromDataShape(DataShapeDefinition t)	Creates and returns a new InfoTable with fields defined in the given DataShapeDefinition
static InfoTable	createInfoTableFromDataShape(String type)	Creates and returns a new InfoTable with a DataShapeDefinition from the given entity type as a String
static InfoTable	createInfoTableFromFieldDefinition(FieldDefinition field)	Creates and returns a new InfoTable containing the field defined in the given FieldDefinition
static InfoTable	createInfoTableFromParameters(FieldDefinitionCollection t)	Creates and returns a new InfoTable containing the fields defined in the given FieldDefinitionCollection
static InfoTable	createInfoTableFromVTQ(VTQ vtq)	Creates and returns a new InfoTable with a row set to the given VTQ values

Methods inherited from class java.lang.Object

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

Constructor Details

InfoTableInstanceFactory

public InfoTableInstanceFactory()

Method Details

createInfoTableFromDataShape

@ThingworxExtensionApiMethod(since={6,6})
public static InfoTable createInfoTableFromDataShape(DataShapeDefinition t)
                                              throws Exception

Creates and returns a new InfoTable with fields defined in the given DataShapeDefinition

Parameters:

t - DataShapeDefinition defining the fields for the new InfoTable

Returns:

A new InfoTable with the given fields

Throws:

Exception - If an error occurs

createInfoTableFromDataShape

@ThingworxExtensionApiMethod(since={6,6})
public static InfoTable createInfoTableFromDataShape(String type)
                                              throws Exception

Creates and returns a new InfoTable with a DataShapeDefinition from the given entity type as a String

Parameters:

type - The entity type as a String

Returns:

InfoTable with a DataShape from the given entity type

Throws:

Exception - If an error occurs

convertInfoTableUsingDataShape

@ThingworxExtensionApiMethod(since={6,6})
public static InfoTable convertInfoTableUsingDataShape(InfoTable t,
 DataShapeDefinition ds)
                                                throws Exception

Convert a given InfoTable into a new InfoTable that uses the given DataShapeDefinition

Parameters:

t - InfoTable to be converted

ds - DataShapeDefinition to be used in the new InfoTable

Returns:

InfoTable using the new DataShapeDefinition and values from the given InfoTable

Throws:

Exception - If an error occurs

createInfoTableFromFieldDefinition

@ThingworxExtensionApiMethod(since={6,6})
public static InfoTable createInfoTableFromFieldDefinition(FieldDefinition field)
                                                    throws Exception

Creates and returns a new InfoTable containing the field defined in the given FieldDefinition

Parameters:

field - The field for the new InfoTable

Returns:

A new InfoTable with the given field

Throws:

Exception - If an error occurs

createInfoTableFromParameters

@ThingworxExtensionApiMethod(since={6,6})
public static InfoTable createInfoTableFromParameters(FieldDefinitionCollection t)
                                               throws Exception

Creates and returns a new InfoTable containing the fields defined in the given FieldDefinitionCollection

Parameters:

t - FieldDefinitionCollection The fields for the new InfoTable

Returns:

A new InfoTable with the given fields

Throws:

Exception - If an error occurs

createInfoTableFromVTQ

@ThingworxExtensionApiMethod(since={6,6})
public static InfoTable createInfoTableFromVTQ(VTQ vtq)
                                        throws Exception

Creates and returns a new InfoTable with a row set to the given VTQ values

Parameters:

vtq - VTQ containing the values to be set in each field of the row

Returns:

InfoTable containing a row with the given VTQ values

Throws:

Exception - If an error occurs