Package com.thingworx.datatables

Class DataTableThing

    • Method Detail

      • getEntryIterator

        @ThingworxExtensionApiMethod(since={7,0,1})
public IDataEntryCloseableIterator<DataTableEntry> getEntryIterator()
                                                             throws java.lang.Exception


        Returns an iterator over all entries inside this data table thing. The iterator must be closed when no longer used.
        Returns:
        a closeable iterator
        Throws:
        java.lang.Exception - if an exception occurred creating the iterator

      • validateConfiguration

        @ThingworxExtensionApiMethod(since={6,6},
                             canOverride=true,
                             requiresSuper=true)
public void validateConfiguration​(ImportedEntityCollection importedEntityCollections)
                           throws java.lang.Exception
        Description copied from class: Thing


        Validates the configuration of the thing during the import process. This method is called whenever a thing is created or modified via the REST APIs. During the validation step, there may be other associated entities (including thing shapes and templates) that are being imported. These can be accessed via the importedEntities collection if needed.

        Note that some resources belonging to the thing or other associated entities may not be available during this step in the lifecycle.

        It is required for all subclasses of Thing to call super.validateConfiguration(importedEntities) if they override this method.

        Overrides:
        validateConfiguration in class Thing
        Parameters:
        importedEntityCollections - - a typed collection of entities currently being imported
        Throws:
        java.lang.Exception - If an error occurs

      • GetDataShape

        @ThingworxExtensionApiMethod(since={6,6})
public java.lang.String GetDataShape()
        Service Category:
        DataShape
        Service Description:
        Get the currently assigned data shape.
        Returns:
        result Data shape name - DATASHAPENAME

      • SetDataShape

        @ThingworxExtensionApiMethod(since={6,6})
public void SetDataShape​(java.lang.String name)
                  throws java.lang.Exception
        Service Category:
        DataShape
        Service Description:
        Sets the data shape.
        Parameters:
        name - Data shape name - DATASHAPENAME
        Throws:
        java.lang.Exception - If an error occurs

      • GetFieldNames

        @ThingworxExtensionApiMethod(since={6,6})
public InfoTable GetFieldNames()
                        throws java.lang.Exception
        Service Category:
        Fields
        Service Description:
        Retrieve a list of field names for the data shape associated with this stream.
        Returns:
        result Field names - INFOTABLE - Aspects {dataShape:EntityList}
        Throws:
        java.lang.Exception - If an error occurs

      • GetFieldNamesByType

        @ThingworxExtensionApiMethod(since={6,6})
public InfoTable GetFieldNamesByType​(java.lang.String type)
                              throws java.lang.Exception
        Service Category:
        Fields
        Service Description:
        Retrieve a list of field names for the data shape associated with this stream, of a specific type.
        Parameters:
        type - Base type name - BASETYPENAME
        Returns:
        result Field names - INFOTABLE - Aspects {dataShape:EntityList}
        Throws:
        java.lang.Exception - If an error occurs

      • Reindex

        @ThingworxExtensionApiMethod(since={6,6})
public void Reindex()
             throws java.lang.Exception
        Service Category:
        Indexing
        Service Description:
        Reindex the custom indexes on the data table.


        Reindexes the Data Table data through Thingworx. NOTE: This service is not implemented for Postgres, will throw a NotImplementedException if used in that Persistence Provider deployment of Thingworx.
        Throws:
        java.lang.Exception - If reindexing fails. Some data providers throw NotImplementedException because reindexing is not supported.

      • AddOrUpdateDataTableEntry

        @ThingworxExtensionApiMethod(since={6,6})
public java.lang.String AddOrUpdateDataTableEntry​(TagCollection tags,
                                                  Location location,
                                                  java.lang.String source,
                                                  java.lang.String sourceType,
                                                  InfoTable values)
                                           throws java.lang.Exception
        Service Category:
        DataTableEntries
        Service Description:
        Add a new data table entry, or if it exists, update an existing entry.
        Parameters:
        tags - Tags - TAGS
        location - Location of the entry (optional) - LOCATION
        source - Source of the entry (optional) - STRING
        sourceType - Source type (optional) - STRING
        values - Data values - INFOTABLE
        Returns:
        id Newly created ID - STRING
        Throws:
        java.lang.Exception - If an error occurs

      • AddOrUpdateDataTableEntries

        @ThingworxExtensionApiMethod(since={6,6})
public void AddOrUpdateDataTableEntries​(TagCollection tags,
                                        Location location,
                                        java.lang.String source,
                                        java.lang.String sourceType,
                                        InfoTable values)
                                 throws java.lang.Exception
        Service Category:
        DataTableEntries
        Service Description:
        Add or update multiple data table entries.
        Parameters:
        tags - Tags - TAGS
        location - Location of the entry (optional) - LOCATION
        source - Source of the entry (optional) - STRING
        sourceType - Source type (optional) - STRING
        values - Data values - INFOTABLE
        Throws:
        java.lang.Exception - If an error occurs

      • UpdateDataTableEntries

        @ThingworxExtensionApiMethod(since={6,6})
public void UpdateDataTableEntries​(TagCollection tags,
                                   Location location,
                                   java.lang.String source,
                                   java.lang.String sourceType,
                                   InfoTable values)
                            throws java.lang.Exception
        Service Category:
        DataTableEntries
        Service Description:
        Update multiple data table entries.
        Parameters:
        tags - Tags - TAGS
        location - Location of the entry (optional) - LOCATION
        source - Source of the entry (optional) - STRING
        sourceType - Source type (optional) - STRING
        values - Data values - INFOTABLE
        Throws:
        java.lang.Exception - If an error occurs

      • AddDataTableEntries

        @ThingworxExtensionApiMethod(since={6,6})
public void AddDataTableEntries​(TagCollection tags,
                                Location location,
                                java.lang.String source,
                                java.lang.String sourceType,
                                InfoTable values)
                         throws java.lang.Exception
        Service Category:
        DataTableEntries
        Service Description:
        Add multiple data table entries.
        Parameters:
        tags - Tags - TAGS
        location - Location of the entry (optional) - LOCATION
        source - Source of the entry (optional) - STRING
        sourceType - Source type (optional) - STRING
        values - Data values - INFOTABLE
        Throws:
        java.lang.Exception - If an error occurs

      • UpdateDataTableEntriesWithQuery

        @ThingworxExtensionApiMethod(since={6,6})
public void UpdateDataTableEntriesWithQuery​(TagCollection tags,
                                            Location location,
                                            java.lang.String source,
                                            java.lang.String sourceType,
                                            InfoTable values,
                                            org.json.JSONObject query,
                                            InfoTable updateValues)
                                     throws java.lang.Exception
        Service Category:
        DataTableEntries
        Service Description:
        Add or update multiple data table entries based on a query.
        Parameters:
        tags - Tags - TAGS
        location - Location of the entry (optional) - LOCATION
        source - Source of the entry (optional) - STRING
        sourceType - Source type (optional) - STRING
        values - Data values to search for - INFOTABLE
        query - Query definition - QUERY
        updateValues - Data values to be updated - INFOTABLE
        Throws:
        java.lang.Exception - If an error occurs

      • DeleteDataTableEntriesWithQuery

        @ThingworxExtensionApiMethod(since={6,6},
                             deprecatedSince={9,0})
@Deprecated
public void DeleteDataTableEntriesWithQuery​(TagCollection tags,
                                            Location location,
                                            java.lang.String source,
                                            java.lang.String sourceType,
                                            InfoTable values,
                                            org.json.JSONObject query)
                                     throws java.lang.Exception
        Deprecated.
        Service Category:
        DataTableEntries
        Service Description:
        Add or update multiple data table entries based on a query.
        Parameters:
        tags - Tags - TAGS
        location - Location of the entry (optional) - LOCATION
        source - Source of the entry (optional) - STRING
        sourceType - Source type (optional) - STRING
        values - Data values - INFOTABLE
        query - Query definition - QUERY
        Throws:
        java.lang.Exception - If an error occurs

      • DeleteDataTableEntriesWithQueryCriteria

        @ThingworxExtensionApiMethod(since={9,0})
public void DeleteDataTableEntriesWithQueryCriteria​(TagCollection tags,
                                                    java.lang.String source,
                                                    InfoTable values,
                                                    org.json.JSONObject query)
                                             throws java.lang.Exception
        Service Category:
        DataTableEntries
        Service Description:
        Delete entries from data table entries based on a query, values, tags and source.
        Parameters:
        tags - Tags - TAGS
        source - Source of the entry (optional) - STRING
        values - Data values - INFOTABLE
        query - Query definition - QUERY
        Throws:
        java.lang.Exception - If an error occurs

      • AddDataTableEntry

        @ThingworxExtensionApiMethod(since={6,6})
public java.lang.String AddDataTableEntry​(TagCollection tags,
                                          Location location,
                                          java.lang.String source,
                                          java.lang.String sourceType,
                                          InfoTable values)
                                   throws java.lang.Exception
        Service Category:
        DataTableEntries
        Service Description:
        Add a new data table entry.
        Parameters:
        tags - Tags - TAGS
        location - Location of the entry (optional) - LOCATION
        source - Source of the entry (optional) - STRING
        sourceType - Source type (optional) - STRING
        values - Data values - INFOTABLE
        Returns:
        id Newly created id - STRING
        Throws:
        java.lang.Exception - If an error occurs

      • UpdateDataTableEntry

        @ThingworxExtensionApiMethod(since={6,6})
public void UpdateDataTableEntry​(TagCollection tags,
                                 Location location,
                                 java.lang.String source,
                                 java.lang.String sourceType,
                                 InfoTable values)
                          throws java.lang.Exception
        Service Category:
        DataTableEntries
        Service Description:
        Update an existing data table entry.
        Parameters:
        tags - Tags - TAGS
        location - Location of the entry (optional) - LOCATION
        source - Source of the entry (optional) - STRING
        sourceType - Source type (optional) - STRING
        values - Data values - INFOTABLE
        Throws:
        java.lang.Exception - If an error occurs

      • AssignDataTableEntries

        @ThingworxExtensionApiMethod(since={6,6})
public void AssignDataTableEntries​(TagCollection tags,
                                   Location location,
                                   java.lang.String source,
                                   java.lang.String sourceType,
                                   InfoTable values)
                            throws java.lang.Exception
        Service Category:
        DataTableEntries
        Service Description:
        Replaces existing data table entries.
        Parameters:
        tags - Tags - TAGS
        location - Location of the entry (optional) - LOCATION
        source - Source of the entry (optional) - STRING
        sourceType - Source type (optional) - STRING
        values - Data values - INFOTABLE
        Throws:
        java.lang.Exception - If an error occurs

      • DeleteDataTableEntry

        @ThingworxExtensionApiMethod(since={6,6})
public void DeleteDataTableEntry​(InfoTable values)
                          throws java.lang.Exception
        Service Category:
        DataTableEntries
        Service Description:
        Delete an existing data table entry.
        Parameters:
        values - Data values - INFOTABLE
        Throws:
        java.lang.Exception - If an error occurs

      • DeleteDataTableEntryByKey

        @ThingworxExtensionApiMethod(since={6,6})
public void DeleteDataTableEntryByKey​(java.lang.String key)
                               throws java.lang.Exception
        Service Category:
        DataTableEntries
        Service Description:
        Delete an existing data table entry using its key value.
        Parameters:
        key - Key Value - STRING
        Throws:
        java.lang.Exception - If an error occurs

      • GetDataTableEntry

        @ThingworxExtensionApiMethod(since={6,6})
public InfoTable GetDataTableEntry​(InfoTable values)
                            throws java.lang.Exception
        Service Category:
        DataTableEntries
        Service Description:
        Get an existing data table entry.
        Parameters:
        values - Data values - INFOTABLE
        Returns:
        result Table entries - INFOTABLE - Aspects {isEntityDataShape:true, isDataTableEntry:true}
        Throws:
        java.lang.Exception - If an error occurs

      • GetDataTableEntryByKey

        @ThingworxExtensionApiMethod(since={6,6})
public InfoTable GetDataTableEntryByKey​(java.lang.String key)
                                 throws java.lang.Exception
        Service Category:
        DataTableEntries
        Service Description:
        Get an existing data table entry using its key value.
        Parameters:
        key - Key Value - STRING
        Returns:
        result Table entries - INFOTABLE - Aspects {isEntityDataShape:true, isDataTableEntry:true}
        Throws:
        java.lang.Exception - If an error occurs

      • PurgeDataTableEntries

        @ThingworxExtensionApiMethod(since={6,6})
public void PurgeDataTableEntries()
                           throws java.lang.Exception
        Service Category:
        Maintenance
        Service Description:
        Remove all data table entries.
        Throws:
        java.lang.Exception - If an error occurs

      • CreateValues

        @ThingworxExtensionApiMethod(since={6,6})
public InfoTable CreateValues()
                       throws java.lang.Exception
        Service Category:
        Values
        Service Description:
        Create an empty info table of the correct datashape for this data table.
        Returns:
        Values Created Infotable - INFOTABLE - Aspects {isEntityDataShape:true}
        Throws:
        java.lang.Exception - If an error occurs

      • CreateValuesWithData

        @ThingworxExtensionApiMethod(since={6,6})
public InfoTable CreateValuesWithData​(org.json.JSONObject values)
                               throws java.lang.Exception
        Service Category:
        Values
        Service Description:
        Create an info table of the correct datashape for this stream and include data values.
        Parameters:
        values - Data values (JSON Object) - JSON
        Returns:
        Values Created Infotable - INFOTABLE - Aspects {isEntityDataShape:true}
        Throws:
        java.lang.Exception - If an error occurs

      • GetDataTableEntries

        @ThingworxExtensionApiMethod(since={6,6})
public InfoTable GetDataTableEntries​(java.lang.Double maxItems)
                              throws java.lang.Exception
        Service Category:
        Queries
        Service Description:
        Retrieve all table entries up to max items number.
        Parameters:
        maxItems - Maximum number of items to return - NUMBER
        Returns:
        result Table entries - INFOTABLE - Aspects {isEntityDataShape:true, isDataTableEntry:true}
        Throws:
        java.lang.Exception - If an error occurs

      • FindDataTableEntries

        @ThingworxExtensionApiMethod(since={8,5})
public InfoTable FindDataTableEntries​(InfoTable values,
                                      java.lang.Double maxItems)
                               throws java.lang.Exception
        Service Category:
        Queries
        Service Description:
        Retrieve all table entries that match the provided values.
        Parameters:
        values - Data values - INFOTABLE
        maxItems - Maximum number of items to return - NUMBER
        Returns:
        result Table entries - INFOTABLE - Aspects {isEntityDataShape:true, isDataTableEntry:true}
        Throws:
        java.lang.Exception - If an error occurs

      • DeleteDataTableEntries

        @ThingworxExtensionApiMethod(since={8,5})
public void DeleteDataTableEntries​(InfoTable values,
                                   java.lang.Double maxItems)
                            throws java.lang.Exception
        Service Category:
        DataTableEntries
        Service Description:
        Delete all table entries that match the provided values.
        Parameters:
        values - Data values - INFOTABLE
        maxItems - Maximum number of items to return - NUMBER
        Throws:
        java.lang.Exception - If an error occurs

      • GetDataTableEntryCount

        @ThingworxExtensionApiMethod(since={6,6})
public java.lang.Integer GetDataTableEntryCount()
                                         throws java.lang.Exception
        Service Category:
        Service Description:
        Get an count of data table entries.
        Returns:
        result Table entry count - INTEGER
        Throws:
        java.lang.Exception - If an error occurs

      • QueryDataTableEntries

        @ThingworxExtensionApiMethod(since={6,6})
public InfoTable QueryDataTableEntries​(InfoTable values,
                                       java.lang.Double maxItems,
                                       TagCollection tags,
                                       java.lang.String source,
                                       org.json.JSONObject query)
                                throws java.lang.Exception
        Service Category:
        Queries
        Service Description:
        Retrieve all table entries that match the query parameters.
        Parameters:
        values - Data values - INFOTABLE
        maxItems - Maximum number of items to return - NUMBER
        tags - Tags (optional) - TAGS
        source - Source (optional) - STRING
        query - Query definition - QUERY
        Returns:
        result Table entries - INFOTABLE - Aspects {isEntityDataShape:true, isDataTableEntry:true}
        Throws:
        java.lang.Exception - If an error occurs

      • SearchDataTableEntries

        @ThingworxExtensionApiMethod(since={6,6})
public InfoTable SearchDataTableEntries​(java.lang.Double maxItems,
                                        java.lang.String searchExpression,
                                        TagCollection tags,
                                        org.json.JSONObject query,
                                        java.lang.String source)
                                 throws java.lang.Exception
        Service Category:
        Queries
        Service Description:
        Retrieve all table entries that match the search query parameters.
        Parameters:
        maxItems - Maximum number of items to return - NUMBER
        searchExpression - Search expression - STRING
        tags - Tags (optional) - TAGS
        query - Query definition - QUERY
        source - Source (optional) - STRING
        Returns:
        result Table entries - INFOTABLE - Aspects {isEntityDataShape:true, isDataTableEntry:true}
        Throws:
        java.lang.Exception - If an error occurs