com.inductiveautomation.ignition.gateway.web.models

Class KeyValue

java.lang.Object

com.inductiveautomation.ignition.gateway.web.models.KeyValue

All Implemented Interfaces:

java.io.Serializable

public class KeyValue
extends java.lang.Object
implements java.io.Serializable

Represents the primitive value of a foreign key (potentially multiple values)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.Object[]	values

Constructor Summary

Constructors

Constructor and Description
KeyValue(SFieldReference<?> field) Creates a 'null' foreign key value that matches the number of key values for the reference field
KeyValue(SRecordInstance record) Pulls the primary key values into an aggregate foreign key value
KeyValue(SRecordInstance record, SFieldReference<?> field) Pulls the foreign key values into an aggregate foreign key value

Method Summary

Modifier and Type	Method and Description
java.lang.Long	getAsLong() Convenience cast for the common case of a single, Long-valued key
java.lang.Object[]	getKeyValues()
void	setRecordValues(SRecordInstance record, SFieldReference<?> field)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

values

protected java.lang.Object[] values

Constructor Detail

KeyValue

public KeyValue(SFieldReference<?> field)

Creates a 'null' foreign key value that matches the number of key values for the reference field

KeyValue

public KeyValue(SRecordInstance record,
                SFieldReference<?> field)

Pulls the foreign key values into an aggregate foreign key value

KeyValue

public KeyValue(SRecordInstance record)

Pulls the primary key values into an aggregate foreign key value

Method Detail

setRecordValues

public void setRecordValues(SRecordInstance record,
                            SFieldReference<?> field)

getKeyValues

public java.lang.Object[] getKeyValues()

getAsLong

public java.lang.Long getAsLong()

Convenience cast for the common case of a single, Long-valued key

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object