Package com.thingworx.datatables

Class DataTableThing

java.lang.Object
com.thingworx.types.NamedObject
com.thingworx.persistence.common.PersistableNamedObject
com.thingworx.entities.RootEntity
com.thingworx.things.Thing
com.thingworx.datastorage.DataThing<DataTableServiceProvider>
com.thingworx.datastorage.DataThingWithEvents<DataTableServiceProvider>
com.thingworx.datatables.DataTableThing
All Implemented Interfaces:
ISupportsAccessModifier, IConfigurableObject, INotScriptFriendly, ISupportsDeprecation, IDiffableObject, IAlertProvider, IAvatar, IEntityLifeCycleEvent, IEventMetadataProvider, IEventProvider, IPersistable, IPropertyProvider, IServiceMetadataProvider, IServiceProvider, IShapeProvider, ITaggableObject, IDependencyScannableObject, IImportDependencyHandler, IData, IDynamicServiceShape, IHierarchicalEntity, IEntityDefinition, IPersistableObject<String>, IDesignTimeSecurable, IDesignTimeSecurableEntity, IRunTimeSecurable, IRunTimeSecurableEntity, ISecurable, IVisibilitySecurable, IVisibilitySecurableEntity, IEventProcessor, IAspectContainer, IFeed, INamedObject, Serializable
@ThingworxExtensionApiClass(since={6,6}, canInstantiate=true, canExtendOrImplement=true) public class DataTableThing extends DataThingWithEvents<DataTableServiceProvider> implements IData, IFeed, IDynamicServiceShape
See Also:

  • Field Details

  • Constructor Details

  • Method Details

    • getEntryIterator

      @ThingworxExtensionApiMethod(since={7,0,1}) public IDataEntryCloseableIterator<DataTableEntry> getEntryIterator() throws 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:
      Exception - if an exception occurred creating the iterator

    • validateConfiguration

      @ThingworxExtensionApiMethod(since={6,6}, canOverride=true, requiresSuper=true) public void validateConfiguration(ImportedEntityCollection importedEntityCollections) throws 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:
      Exception - if the thing is invalid

    • initializeThing

      @ThingworxExtensionApiMethod(since={9,0}, canOverride=true, requiresSuper=true) public void initializeThing(ContextType contextType) throws Exception
      Description copied from class: Thing

      An initialization hook for subclasses of Thing. Some resources of Thing may not be available at this point in the lifecycle.

      Overrides:
      initializeThing in class Thing
      Throws:
      Exception - if an error occurs during thing initialization

    • getDataShapeName

      @ThingworxExtensionApiMethod(since={6,6}) public String getDataShapeName()
      Specified by:
      getDataShapeName in interface IData

    • GetDataShape

      @ThingworxExtensionApiMethod(since={6,6}) public 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(String name) throws Exception
      Service Category:
      DataShape
      Service Description:
      Sets the data shape.
      Parameters:
      name - Data shape name - DATASHAPENAME
      Throws:
      Exception - if an error occurs

    • getDataShape

      @ThingworxExtensionApiMethod(since={6,6}) public DataShapeDefinition getDataShape()
      Specified by:
      getDataShape in interface IData
      Specified by:
      getDataShape in interface IDynamicServiceShape

    • GetFieldNames

      @ThingworxExtensionApiMethod(since={6,6}) public InfoTable GetFieldNames() throws 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:
      Exception - if an error occurs

    • GetFieldNamesByType

      @ThingworxExtensionApiMethod(since={6,6}) public InfoTable GetFieldNamesByType(String type) throws 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:
      Exception - if an error occurs

    • Reindex

      @ThingworxExtensionApiMethod(since={6,6}) public void Reindex() throws 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:
      Exception - If reindexing fails. Some data providers throw NotImplementedException because reindexing is not supported.

    • AddOrUpdateDataTableEntry

      @ThingworxExtensionApiMethod(since={6,6}) public String AddOrUpdateDataTableEntry(TagCollection tags, Location location, String source, String sourceType, InfoTable values) throws 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:
      Exception - if an error occurs

    • AddOrUpdateDataTableEntries

      @ThingworxExtensionApiMethod(since={6,6}) public void AddOrUpdateDataTableEntries(TagCollection tags, Location location, String source, String sourceType, InfoTable values) throws 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:
      Exception - if an error occurs

    • UpdateDataTableEntries

      @ThingworxExtensionApiMethod(since={6,6}) public void UpdateDataTableEntries(TagCollection tags, Location location, String source, String sourceType, InfoTable values) throws 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:
      Exception - if an error occurs

    • AddDataTableEntries

      @ThingworxExtensionApiMethod(since={6,6}) public void AddDataTableEntries(TagCollection tags, Location location, String source, String sourceType, InfoTable values) throws 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:
      Exception - if an error occurs

    • UpdateDataTableEntriesWithQuery

      @ThingworxExtensionApiMethod(since={6,6}) public void UpdateDataTableEntriesWithQuery(TagCollection tags, Location location, String source, String sourceType, InfoTable values, org.json.JSONObject query, InfoTable updateValues) throws 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:
      Exception - if an error occurs

    • DeleteDataTableEntriesWithQuery

      @ThingworxExtensionApiMethod(since={6,6}, deprecatedSince={9,0}) @Deprecated public void DeleteDataTableEntriesWithQuery(TagCollection tags, Location location, String source, String sourceType, InfoTable values, org.json.JSONObject query) throws 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:
      Exception - if an error occurs

    • DeleteDataTableEntriesWithQueryCriteria

      @ThingworxExtensionApiMethod(since={9,0}) public void DeleteDataTableEntriesWithQueryCriteria(TagCollection tags, String source, InfoTable values, org.json.JSONObject query) throws 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:
      Exception - if an error occurs

    • AddDataTableEntry

      @ThingworxExtensionApiMethod(since={6,6}) public String AddDataTableEntry(TagCollection tags, Location location, String source, String sourceType, InfoTable values) throws 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:
      Exception - if an error occurs

    • UpdateDataTableEntry

      @ThingworxExtensionApiMethod(since={6,6}) public void UpdateDataTableEntry(TagCollection tags, Location location, String source, String sourceType, InfoTable values) throws 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:
      Exception - if an error occurs

    • AssignDataTableEntries

      @ThingworxExtensionApiMethod(since={6,6}) public void AssignDataTableEntries(TagCollection tags, Location location, String source, String sourceType, InfoTable values) throws 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:
      Exception - if an error occurs

    • DeleteDataTableEntry

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

    • DeleteDataTableEntryByKey

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

    • GetDataTableEntry

      @ThingworxExtensionApiMethod(since={6,6}) public InfoTable GetDataTableEntry(InfoTable values) throws 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:
      Exception - if an error occurs

    • GetDataTableEntryByKey

      @ThingworxExtensionApiMethod(since={6,6}) public InfoTable GetDataTableEntryByKey(String key) throws 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:
      Exception - if an error occurs

    • PurgeDataTableEntries

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

    • CreateValues

      @ThingworxExtensionApiMethod(since={6,6}) public InfoTable CreateValues() throws 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:
      Exception - if an error occurs

    • CreateValuesWithData

      @ThingworxExtensionApiMethod(since={6,6}) public InfoTable CreateValuesWithData(org.json.JSONObject values) throws 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:
      Exception - if an error occurs

    • GetDataTableEntries

      @ThingworxExtensionApiMethod(since={6,6}) public InfoTable GetDataTableEntries(Double maxItems) throws 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:
      Exception - if an error occurs

    • FindDataTableEntries

      @ThingworxExtensionApiMethod(since={6,6}, deprecatedSince={8,5}) @Deprecated public InfoTable FindDataTableEntries(InfoTable Info) throws Exception
      Deprecated.
      Throws:
      Exception

    • FindDataTableEntries

      @ThingworxExtensionApiMethod(since={8,5}) public InfoTable FindDataTableEntries(InfoTable values, Double maxItems) throws 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:
      Exception - if an error occurs

    • DeleteDataTableEntries

      @ThingworxExtensionApiMethod(since={6,6}, deprecatedSince={8,5}) @Deprecated public void DeleteDataTableEntries(InfoTable Info) throws Exception
      Deprecated.
      Throws:
      Exception

    • DeleteDataTableEntries

      @ThingworxExtensionApiMethod(since={8,5}) public void DeleteDataTableEntries(InfoTable values, Double maxItems) throws 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:
      Exception - if an error occurs

    • GetDataTableEntryCount

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

    • QueryDataTableEntries

      @ThingworxExtensionApiMethod(since={6,6}) public InfoTable QueryDataTableEntries(InfoTable values, Double maxItems, TagCollection tags, String source, org.json.JSONObject query) throws 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:
      Exception - if an error occurs

    • SearchDataTableEntries

      @ThingworxExtensionApiMethod(since={6,6}) public InfoTable SearchDataTableEntries(Double maxItems, String searchExpression, TagCollection tags, org.json.JSONObject query, String source) throws 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:
      Exception - if an error occurs

    • getDependencies

      @ThingworxExtensionApiMethod(since={6,6}) public EntityReferenceTypeMap getDependencies()
      Description copied from class: Thing

      Returns a map containing references to all entities that the Thing is dependent on.

      Overrides:
      getDependencies in class Thing
      Returns:
      a map of up-stream dependencies

    • getDataType

      @ThingworxExtensionApiMethod(since={6,6}) public RelationshipTypes.ThingworxRelationshipTypes getDataType()

    • getItemEntityType

      @ThingworxExtensionApiMethod(since={6,6}) public RelationshipTypes.ThingworxRelationshipTypes getItemEntityType()

    • getItemEntityName

      @ThingworxExtensionApiMethod(since={6,6}) public String getItemEntityName()
      Specified by:
      getItemEntityName in interface IFeed

    • getItemCollectionName

      @ThingworxExtensionApiMethod(since={6,6}) public String getItemCollectionName()
      Specified by:
      getItemCollectionName in interface IFeed

    • isStoredAsEncrypted

      @ThingworxExtensionApiMethod(since={6,6}, canOverride=true) protected boolean isStoredAsEncrypted()
      True if a secure data table.
      Returns:
      boolean