Package com.inductiveautomation.perspective.common

Class PerspectiveModule

java.lang.Object

com.inductiveautomation.perspective.common.PerspectiveModule

public class PerspectiveModule
extends java.lang.Object

Contains common configuration and const definitions for things like module ID, and also provides a registry for components.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PerspectiveModule.WellKnownIds

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	LOG_PREFIX
static JsonSchema	META_SCHEMA
static java.lang.String	MODULE_ID
static JsonSchema	SESSION_PROPS_SCHEMA
static JsonSchema	VIEW_SCHEMA

Constructor Summary

Constructors

Constructor	Description
PerspectiveModule()

Method Summary

Modifier and Type	Method	Description
static com.inductiveautomation.ignition.common.gson.Gson	createPerspectiveCompatibleGson()	Creates a Gson instance with the correct type adapters registered to serialize and deserialize views
static com.inductiveautomation.ignition.common.gson.Gson	createPerspectiveCompatibleGson(java.util.function.Consumer<com.inductiveautomation.ignition.common.gson.GsonBuilder> customize)	Creates a Gson instance with the correct type adapters registered to serialize and deserialize views
static com.inductiveautomation.ignition.common.gson.JsonObject	defaultMetaProps()
static com.inductiveautomation.ignition.common.gson.JsonObject	defaultSessionProps()
static com.inductiveautomation.ignition.common.gson.JsonObject	defaultViewProps()
static LoggerEx	getLogger(java.lang.String name)

Methods inherited from class java.lang.Object

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

Field Detail

MODULE_ID

public static final java.lang.String MODULE_ID

See Also:

Constant Field Values

LOG_PREFIX

public static final java.lang.String LOG_PREFIX

See Also:

Constant Field Values

SESSION_PROPS_SCHEMA

public static final JsonSchema SESSION_PROPS_SCHEMA

VIEW_SCHEMA

public static final JsonSchema VIEW_SCHEMA

META_SCHEMA

public static final JsonSchema META_SCHEMA

Constructor Detail

PerspectiveModule

public PerspectiveModule()

Method Detail

getLogger

public static LoggerEx getLogger(java.lang.String name)

createPerspectiveCompatibleGson

@Nonnull
public static com.inductiveautomation.ignition.common.gson.Gson createPerspectiveCompatibleGson()

Creates a Gson instance with the correct type adapters registered to serialize and deserialize views

createPerspectiveCompatibleGson

@Nonnull
public static com.inductiveautomation.ignition.common.gson.Gson createPerspectiveCompatibleGson(java.util.function.Consumer<com.inductiveautomation.ignition.common.gson.GsonBuilder> customize)

Creates a Gson instance with the correct type adapters registered to serialize and deserialize views

defaultMetaProps

public static com.inductiveautomation.ignition.common.gson.JsonObject defaultMetaProps()

Returns:

the default object parsed from the common meta-schema resource.

defaultViewProps

public static com.inductiveautomation.ignition.common.gson.JsonObject defaultViewProps()

Returns:

the default object parsed from the common view-props-schema resource.

defaultSessionProps

public static com.inductiveautomation.ignition.common.gson.JsonObject defaultSessionProps()

Returns:

the default object parsed from the common session-props schema resource.