com.ergotech.secs.gem

Class GemToolModelSnapshot.GemReportVariable

java.lang.Object

com.ergotech.secs.gem.GemToolModelSnapshot.GemVariable

com.ergotech.secs.gem.GemToolModelSnapshot.GemReportVariable

Direct Known Subclasses:

GemHostDevicesModel.GemDevicesReportVariable

Enclosing class:

GemToolModelSnapshot

public static class GemToolModelSnapshot.GemReportVariable
extends GemToolModelSnapshot.GemVariable

This adds a list of VIDs that are associated with this report. This is used by RPTIDs where the list is the list of VIDs associated with the report. This is used by CEIDs where the list is the list of reports associated with the CEID.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GemToolModelSnapshot.GemReportVariable.VariableType

Field Summary

Fields

Modifier and Type	Field and Description
java.util.List<java.lang.Long>	associatedIDs The list of VIDs that are in some way associated with this ID.
boolean	configured On the tool, configured is the same as enabled for a CEID and is ignored for a report id.
boolean	sort A hint to the tool or host to set the order of the report.

Fields inherited from class com.ergotech.secs.gem.GemToolModelSnapshot.GemVariable

id, name

Constructor Summary

Constructors

Constructor and Description
GemReportVariable() Create the ID.
GemReportVariable(java.lang.String name, long id, java.util.List<java.lang.Long> ids, GemToolModelSnapshot.GemReportVariable.VariableType variableType, boolean configured) Create the ID.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDataSourceName()
void	removeIdReference(long id) Remove the reference to the provide id from the associated id list.
java.lang.String	toString()

Methods inherited from class com.ergotech.secs.gem.GemToolModelSnapshot.GemVariable

equals, getId, getName, hashCode

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

associatedIDs

public java.util.List<java.lang.Long> associatedIDs

The list of VIDs that are in some way associated with this ID.

configured

public boolean configured

On the tool, configured is the same as enabled for a CEID and is ignored for a report id. On the host, reports that are not configured are assumed to be fixed reports from the tool and so no messages will be sent to configure the report. Similarly, CEIDs that are not configured will not be linked at runtime by the host.

sort

public boolean sort

A hint to the tool or host to set the order of the report. If true then the host or tool should sort the elements before creating the report, otherwise not. This object will not perform this sort, this is only a hint to an external program (such as TransSECS).

Constructor Detail

GemReportVariable

public GemReportVariable()

Create the ID. Default constructor required for XML serialization.

GemReportVariable

public GemReportVariable(java.lang.String name,
                         long id,
                         java.util.List<java.lang.Long> ids,
                         GemToolModelSnapshot.GemReportVariable.VariableType variableType,
                         boolean configured)

Create the ID.

Parameters:

name - the name of the CEID

id - the id

ids - the list of ids associated with this variable. Report ids for CEIDs and VIDs for ReportIds.

variableType - the type of the variable CEID or RPTID

configured - true if the tool has configured this and the host should not.

Method Detail

getDataSourceName

public java.lang.String getDataSourceName()

Specified by:

getDataSourceName in class GemToolModelSnapshot.GemVariable

Returns:

the name of the variable's data source (eg VID.valuename, CEID.eventname, etc.)

removeIdReference

public void removeIdReference(long id)

Remove the reference to the provide id from the associated id list. That is, if this is a report id, remove the reference vid. If a event, remove the assoicated rptid.

Parameters:

id - a report id or vid

toString

public java.lang.String toString()

Overrides:

toString in class GemToolModelSnapshot.GemVariable