Package com.inductiveautomation.ignition.gateway.localdb.persistence

Class ReferenceField<T extends SRecordInstance>

java.lang.Object

simpleorm.dataset.SFieldMeta

simpleorm.dataset.SFieldReference<T>

com.inductiveautomation.ignition.gateway.localdb.persistence.ReferenceField<T>

All Implemented Interfaces:

java.io.Serializable

public class ReferenceField<T extends SRecordInstance>
extends SFieldReference<T>

This class allows all the rows of a given table to be listed in a dropdown on a Wicket page. When a dropdown entry is selected by the user, the row id of the selected entry (specified by SRecordMeta<T> referencedRecord) is saved in a specified table (specified by SRecordMeta<?> meta) as a foreign key.

See Also:

Serialized Form

Field Summary

Fields inherited from class simpleorm.dataset.SFieldMeta

quoteName

Constructor Summary

Constructors

Constructor	Description
ReferenceField(SRecordMeta<?> meta, SRecordMeta<T> referencedRecord, java.lang.String fieldName, SFieldScalar... foreignKeys)
ReferenceField(SRecordMeta<?> meta, SRecordMeta<T> referencedRecord, java.lang.String fieldName, SFieldScalar[] foreignKeys, SFieldScalar[] referencedPrimaryKeys)

Method Summary

Modifier and Type	Method	Description
FormMeta	getFormMeta()
java.lang.String[]	getSupressedNames()	An array of record Names which should never be added to any dropdown.
boolean	isMandatory()
ReferenceField<T>	setDescriptive(boolean b)
void	setSuppressedNames(java.lang.String[] supressedNames)	Sets an array of record Names which should never be added to any dropdown.

Methods inherited from class simpleorm.dataset.SFieldReference

convertToDataSetFieldType, createColumnSQL, getForeignKeyMetas, getPrimaryKeyForForegnKey, getReferencedRecordMeta, queryFieldValue, toLongerString, toString

Methods inherited from class simpleorm.dataset.SFieldMeta

addFlag, addValidator, doValidate, equals, getFieldName, getFlags, getRecordMeta, getUserProperties, getUserProperty, getValidators, hashCode, isDescriptive, isForeignKey, isUnqueried, nextGeneratedValue, putUserProperty, readResolve, setQuoted, writeFieldValue, writeFieldValue

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ReferenceField

public ReferenceField(SRecordMeta<?> meta,
                      SRecordMeta<T> referencedRecord,
                      java.lang.String fieldName,
                      SFieldScalar... foreignKeys)

ReferenceField

public ReferenceField(SRecordMeta<?> meta,
                      SRecordMeta<T> referencedRecord,
                      java.lang.String fieldName,
                      SFieldScalar[] foreignKeys,
                      SFieldScalar[] referencedPrimaryKeys)

Method Detail

isMandatory

public boolean isMandatory()

Overrides:

isMandatory in class SFieldMeta

setDescriptive

public ReferenceField<T> setDescriptive(boolean b)

getFormMeta

public FormMeta getFormMeta()

setSuppressedNames

public void setSuppressedNames(java.lang.String[] supressedNames)

Sets an array of record Names which should never be added to any dropdown. Use this to supress system records that should not be visible to the user.

getSupressedNames

public java.lang.String[] getSupressedNames()

An array of record Names which should never be added to any dropdown. Use this to supress system records that should not be visible to the user. This method will always return a useable ArrayList that may or may not be empty.