com.inductiveautomation.reporting.designer.api

Class AbstractQueryConfigFactory

java.lang.Object

com.inductiveautomation.reporting.designer.api.AbstractQueryConfigFactory

All Implemented Interfaces:

QueryConfigFactory

public abstract class AbstractQueryConfigFactory
extends java.lang.Object
implements QueryConfigFactory

Created by carl.gould on 3/4/2015.

Constructor Summary

Constructors

Constructor and Description
AbstractQueryConfigFactory(java.lang.String id, java.lang.String nameKey)
AbstractQueryConfigFactory(java.lang.String id, java.lang.String nameKey, java.lang.String defaultDataKey)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDefaultDataKey() A string to use as the default "Data Key" name for this query
java.lang.String	getDisplayName() A human friendly name for this type of query
java.lang.String	getId() Return a unique ID for this type of query.
java.lang.String	getTooltip() An optional string for a tooltip for this query

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.inductiveautomation.reporting.designer.api.QueryConfigFactory

createConfigPanel, newConfigObject

Constructor Detail

AbstractQueryConfigFactory

public AbstractQueryConfigFactory(java.lang.String id,
                                  java.lang.String nameKey)

Parameters:

id - the ID of this query type

nameKey - An i18n name prefix, used with ".Name" for the name and ".Tooltip" for the tooltip.

AbstractQueryConfigFactory

public AbstractQueryConfigFactory(java.lang.String id,
                                  java.lang.String nameKey,
                                  java.lang.String defaultDataKey)

Method Detail

getId

public java.lang.String getId()

Description copied from interface: QueryConfigFactory

Return a unique ID for this type of query. Must match the ID of a QueryType registered in the Gateway

Specified by:

getId in interface QueryConfigFactory

getDisplayName

public java.lang.String getDisplayName()

Description copied from interface: QueryConfigFactory

A human friendly name for this type of query

Specified by:

getDisplayName in interface QueryConfigFactory

getDefaultDataKey

public java.lang.String getDefaultDataKey()

Description copied from interface: QueryConfigFactory

A string to use as the default "Data Key" name for this query

Specified by:

getDefaultDataKey in interface QueryConfigFactory

getTooltip

public java.lang.String getTooltip()

Description copied from interface: QueryConfigFactory

An optional string for a tooltip for this query

Specified by:

getTooltip in interface QueryConfigFactory