Package com.scaleoutsoftware.digitaltwin.core

Class ModelSchema

  • public class ModelSchema
extends java.lang.Object
    The ModelSchema class is used as a Java object representation of the model.json schema file used for deploying a digital twin model to the real-time digital twin cloud service.

    • Constructor Summary

      Constructors 
      Constructor Description
      ModelSchema​(java.lang.String dtClass, java.lang.String mpClass, java.lang.String msgClass)
      Creates a model schema from a digital twin class, a message processor class, and a message class.
      ModelSchema​(java.lang.String dtClass, java.lang.String mpClass, java.lang.String msgClass, boolean emr)
      Creates a model schema from a digital twin class, a message processor class, and a message class.
      ModelSchema​(java.lang.String dtClass, java.lang.String mpClass, java.lang.String msgClass, java.lang.String ep)
      Model schema with a defined entry point.
      ModelSchema​(java.lang.String dtClass, java.lang.String mpClass, java.lang.String msgClass, java.lang.String ep, boolean emr)
      Creates a model schema from a digital twin class, a message processor class, and a message class.
      ModelSchema​(java.lang.String dtClass, java.lang.String mpClass, java.lang.String msgClass, java.lang.String adtName, PersistenceProviderType persistenceType, java.util.List<AlertProviderConfiguration> alertingProviders)
      Creates a model schema from a digital twin class, a message processor class, a message class, and alert provider configurations.
      ModelSchema​(java.lang.String dtClass, java.lang.String mpClass, java.lang.String msgClass, java.lang.String adtName, PersistenceProviderType persistenceType, java.util.List<AlertProviderConfiguration> alertingProviders, boolean emr)
      Creates a model schema from a digital twin class, a message processor class, a message class, and alert provider configurations.
      ModelSchema​(java.lang.String dtClass, java.lang.String mpClass, java.lang.String msgClass, java.lang.String simulationProcessorClass, java.lang.String adtName, PersistenceProviderType persistenceType, java.util.List<AlertProviderConfiguration> alertingProviders)
      Creates a model schema from a digital twin class, a message processor class, a message class, a simulation processor class, an Azure Digital Twin Model name class, a persistence provider type, and an alert provider configuration.
      ModelSchema​(java.lang.String dtClass, java.lang.String mpClass, java.lang.String msgClass, java.lang.String simulationProcessorClass, java.lang.String adtName, PersistenceProviderType persistenceType, java.util.List<AlertProviderConfiguration> alertingProviders, boolean emr)
      Creates a model schema from a digital twin class, a message processor class, a message class, a simulation processor class, an Azure Digital Twin Model name class, a persistence provider type, and an alert provider configuration.
      ModelSchema​(java.lang.String dtClass, java.lang.String mpClass, java.lang.String msgClass, java.lang.String simulationProcessorClass, java.lang.String adtName, java.lang.String ep, PersistenceProviderType persistenceType, java.util.List<AlertProviderConfiguration> alertingProviders, boolean emr)
      Creates a model schema from a digital twin class, a message processor class, a message class, a simulation processor class, an Azure Digital Twin Model name class, a persistence provider type, and an alert provider configuration.
      ModelSchema​(java.lang.String dtClass, java.lang.String mpClass, java.lang.String msgClass, java.lang.String spClass, java.lang.String ep, java.util.List<AlertProviderConfiguration> alertingProviders)
      Creates a model schema from a digital twin class, a message processor class, a message class, and alert provider configurations.
      ModelSchema​(java.lang.String dtClass, java.lang.String mpClass, java.lang.String msgClass, java.lang.String spClass, java.lang.String ep, java.util.List<AlertProviderConfiguration> alertingProviders, boolean emr)
      Creates a model schema from a digital twin class, a message processor class, a message class, and alert provider configurations.
      ModelSchema​(java.lang.String dtClass, java.lang.String mpClass, java.lang.String msgClass, java.lang.String spClass, java.util.List<AlertProviderConfiguration> alertingProviders)
      Creates a model schema from a digital twin class, a message processor class, a message class, and alert provider configurations.
      ModelSchema​(java.lang.String dtClass, java.lang.String mpClass, java.lang.String msgClass, java.lang.String spClass, java.util.List<AlertProviderConfiguration> alertingProviders, boolean emr)
      Creates a model schema from a digital twin class, a message processor class, a message class, and alert provider configurations.
      ModelSchema​(java.lang.String dtClass, java.lang.String mpClass, java.lang.String msgClass, java.util.List<AlertProviderConfiguration> alertingProviders)
      Creates a model schema from a digital twin class, a message processor class, a message class, and alert provider configurations.

    • Constructor Detail

      • ModelSchema

        public ModelSchema​(java.lang.String dtClass,
                   java.lang.String mpClass,
                   java.lang.String msgClass)
        Creates a model schema from a digital twin class, a message processor class, and a message class.
        Parameters:
        dtClass - the digital twin class implementation.
        mpClass - the message processor class implementation.
        msgClass - a JSON serializable message class.

      • ModelSchema

        public ModelSchema​(java.lang.String dtClass,
                   java.lang.String mpClass,
                   java.lang.String msgClass,
                   java.lang.String ep)
        Model schema with a defined entry point.
        Parameters:
        dtClass - the digital twin class implementation.
        mpClass - the message processor class implementation.
        msgClass - a JSON serializable message class.
        ep - the invocation grid entry point.

      • ModelSchema

        public ModelSchema​(java.lang.String dtClass,
                   java.lang.String mpClass,
                   java.lang.String msgClass,
                   boolean emr)
        Creates a model schema from a digital twin class, a message processor class, and a message class.
        Parameters:
        dtClass - the digital twin class implementation.
        mpClass - the message processor class implementation.
        msgClass - a JSON serializable message class.
        emr - enable message recording for this model.

      • ModelSchema

        public ModelSchema​(java.lang.String dtClass,
                   java.lang.String mpClass,
                   java.lang.String msgClass,
                   java.lang.String ep,
                   boolean emr)
        Creates a model schema from a digital twin class, a message processor class, and a message class.
        Parameters:
        dtClass - the digital twin class implementation.
        mpClass - the message processor class implementation.
        msgClass - a JSON serializable message class.
        ep - the invocation grid entry point.
        emr - enable message recording for this model.

      • ModelSchema

        public ModelSchema​(java.lang.String dtClass,
                   java.lang.String mpClass,
                   java.lang.String msgClass,
                   java.util.List<AlertProviderConfiguration> alertingProviders)
        Creates a model schema from a digital twin class, a message processor class, a message class, and alert provider configurations.
        Parameters:
        dtClass - the digital twin class implementation.
        mpClass - the message processor class implementation.
        msgClass - a JSON serializable message class.
        alertingProviders - the alerting provider configurations.

      • ModelSchema

        public ModelSchema​(java.lang.String dtClass,
                   java.lang.String mpClass,
                   java.lang.String msgClass,
                   java.lang.String spClass,
                   java.util.List<AlertProviderConfiguration> alertingProviders)
        Creates a model schema from a digital twin class, a message processor class, a message class, and alert provider configurations.
        Parameters:
        dtClass - the digital twin class implementation.
        mpClass - the message processor class implementation.
        msgClass - a JSON serializable message class.
        spClass - the simulation processor class implementation.
        alertingProviders - the alerting provider configurations.

      • ModelSchema

        public ModelSchema​(java.lang.String dtClass,
                   java.lang.String mpClass,
                   java.lang.String msgClass,
                   java.lang.String spClass,
                   java.lang.String ep,
                   java.util.List<AlertProviderConfiguration> alertingProviders)
        Creates a model schema from a digital twin class, a message processor class, a message class, and alert provider configurations.
        Parameters:
        dtClass - the digital twin class implementation.
        mpClass - the message processor class implementation.
        msgClass - a JSON serializable message class.
        spClass - the simulation processor class implementation.
        ep - the invocation grid entry point.
        alertingProviders - the alerting provider configurations.

      • ModelSchema

        public ModelSchema​(java.lang.String dtClass,
                   java.lang.String mpClass,
                   java.lang.String msgClass,
                   java.lang.String spClass,
                   java.util.List<AlertProviderConfiguration> alertingProviders,
                   boolean emr)
        Creates a model schema from a digital twin class, a message processor class, a message class, and alert provider configurations.
        Parameters:
        dtClass - the digital twin class implementation.
        mpClass - the message processor class implementation.
        msgClass - a JSON serializable message class.
        spClass - the simulation processor class implementation.
        alertingProviders - the alerting provider configurations.
        emr - enable message recording for this model.

      • ModelSchema

        public ModelSchema​(java.lang.String dtClass,
                   java.lang.String mpClass,
                   java.lang.String msgClass,
                   java.lang.String spClass,
                   java.lang.String ep,
                   java.util.List<AlertProviderConfiguration> alertingProviders,
                   boolean emr)
        Creates a model schema from a digital twin class, a message processor class, a message class, and alert provider configurations.
        Parameters:
        dtClass - the digital twin class implementation.
        mpClass - the message processor class implementation.
        msgClass - a JSON serializable message class.
        spClass - the simulation processor class implementation.
        alertingProviders - the alerting provider configurations.
        ep - the invocation grid entry point.
        emr - enable message recording for this model.

      • ModelSchema

        public ModelSchema​(java.lang.String dtClass,
                   java.lang.String mpClass,
                   java.lang.String msgClass,
                   java.lang.String adtName,
                   PersistenceProviderType persistenceType,
                   java.util.List<AlertProviderConfiguration> alertingProviders)
        Creates a model schema from a digital twin class, a message processor class, a message class, and alert provider configurations.
        Parameters:
        dtClass - the digital twin class implementation.
        mpClass - the message processor class implementation.
        msgClass - a JSON serializable message class.
        adtName - the Azure Digital Twin model name.
        persistenceType - the persistence provider type.
        alertingProviders - the alerting provider configurations.

      • ModelSchema

        public ModelSchema​(java.lang.String dtClass,
                   java.lang.String mpClass,
                   java.lang.String msgClass,
                   java.lang.String adtName,
                   PersistenceProviderType persistenceType,
                   java.util.List<AlertProviderConfiguration> alertingProviders,
                   boolean emr)
        Creates a model schema from a digital twin class, a message processor class, a message class, and alert provider configurations.
        Parameters:
        dtClass - the digital twin class implementation.
        mpClass - the message processor class implementation.
        msgClass - a JSON serializable message class.
        adtName - the Azure Digital Twin model name.
        persistenceType - the persistence provider type.
        alertingProviders - the alerting provider configurations.
        emr - enable message recording for this model.

      • ModelSchema

        public ModelSchema​(java.lang.String dtClass,
                   java.lang.String mpClass,
                   java.lang.String msgClass,
                   java.lang.String simulationProcessorClass,
                   java.lang.String adtName,
                   PersistenceProviderType persistenceType,
                   java.util.List<AlertProviderConfiguration> alertingProviders)
        Creates a model schema from a digital twin class, a message processor class, a message class, a simulation processor class, an Azure Digital Twin Model name class, a persistence provider type, and an alert provider configuration.
        Parameters:
        dtClass - the digital twin class implementation.
        mpClass - the message processor class implementation.
        msgClass - a JSON serializable message class.
        simulationProcessorClass - the simulation processor class implementation.
        adtName - the Azure Digital Twin model name.
        persistenceType - the persistence provider type.
        alertingProviders - the alerting provider configurations.

      • ModelSchema

        public ModelSchema​(java.lang.String dtClass,
                   java.lang.String mpClass,
                   java.lang.String msgClass,
                   java.lang.String simulationProcessorClass,
                   java.lang.String adtName,
                   PersistenceProviderType persistenceType,
                   java.util.List<AlertProviderConfiguration> alertingProviders,
                   boolean emr)
        Creates a model schema from a digital twin class, a message processor class, a message class, a simulation processor class, an Azure Digital Twin Model name class, a persistence provider type, and an alert provider configuration.
        Parameters:
        dtClass - the digital twin class implementation.
        mpClass - the message processor class implementation.
        msgClass - a JSON serializable message class.
        simulationProcessorClass - the simulation processor class implementation.
        adtName - the Azure Digital Twin model name.
        persistenceType - the persistence provider type.
        alertingProviders - the alerting provider configurations.
        emr - enable message recording for this model.

      • ModelSchema

        public ModelSchema​(java.lang.String dtClass,
                   java.lang.String mpClass,
                   java.lang.String msgClass,
                   java.lang.String simulationProcessorClass,
                   java.lang.String adtName,
                   java.lang.String ep,
                   PersistenceProviderType persistenceType,
                   java.util.List<AlertProviderConfiguration> alertingProviders,
                   boolean emr)
        Creates a model schema from a digital twin class, a message processor class, a message class, a simulation processor class, an Azure Digital Twin Model name class, a persistence provider type, and an alert provider configuration.
        Parameters:
        dtClass - the digital twin class implementation.
        mpClass - the message processor class implementation.
        msgClass - a JSON serializable message class.
        simulationProcessorClass - the simulation processor class implementation.
        adtName - the Azure Digital Twin model name.
        persistenceType - the persistence provider type.
        alertingProviders - the alerting provider configurations.
        ep - the invocation grid entry point.
        emr - enable message recording for this model.

    • Method Detail

      • getModelType

        public java.lang.String getModelType()
        Retrieve the digital twin model type (a DigitalTwinBase implementation).
        Returns:
        the model type.

      • getMessageType

        public java.lang.String getMessageType()
        Retrieve the message type (JSON serializable message implementation).
        Returns:
        the message type.

      • getMessageProcessorType

        public java.lang.String getMessageProcessorType()
        Retrieve the message processor type (a MessageProcessor implementation).
        Returns:
        the message processor type.

      • getSimulationProcessorType

        public java.lang.String getSimulationProcessorType()
        Retrieve the simulation processor type (a SimulationProcessor implementation).
        Returns:
        the simulation processor type.

      • getAssemblyName

        public java.lang.String getAssemblyName()
        NOT USED BY JAVA MODEL SCHEMA
        Returns:
        NOT USED BY JAVA MODEL SCHEMA

      • getAlertProviders

        public java.util.List<AlertProviderConfiguration> getAlertProviders()
        Retrieve the alert provider configurations.
        Returns:
        the alert provider configurations.

      • getAzureDigitalTwinModelName

        public java.lang.String getAzureDigitalTwinModelName()
        Retrieve the Azure Digital Twin model name.
        Returns:
        the Azure Digital Twin model name.

      • persistenceEnabled

        public boolean persistenceEnabled()
        Retrieve persistence status. True if persistence is enabled, false otherwise.
        Returns:
        True if persistence is enabled, false otherwise.

      • simulationSupportEnabled

        public boolean simulationSupportEnabled()
        Retrieve simulation support enabled status. True if simulation support is enabled, false otherwise.
        Returns:
        True if simulation support is enabled, false otherwise.

      • getPersistenceProvider

        public PersistenceProviderType getPersistenceProvider()
        Retrieve the persistence provider type.
        Returns:
        the persistence provider type.

      • messageRecordingEnabled

        public boolean messageRecordingEnabled()
        Retrieves the message recording enabled status. True if this model should persist messages when message recording is active, false otherwise.
        Returns:
        True if message recording is enabled, false otherwise.

      • getEntryPoint

        public java.lang.String getEntryPoint()
        Retrieves the packaged model's entry point (fully-qualified class name -- FQCN -- of a Java main) for launching.
        Returns:
        the entry point for launching.