Class RecordMeta<T extends PersistentRecord>
- java.lang.Object
-
- simpleorm.dataset.SRecordMeta<T>
-
- com.inductiveautomation.ignition.gateway.localdb.persistence.RecordMeta<T>
-
- All Implemented Interfaces:
java.io.Serializable
public class RecordMeta<T extends PersistentRecord> extends SRecordMeta<T>
Simple renaming class of SRecordMeta to be consistent.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
RECORD_NOUN_KEY
static java.lang.String
RECORD_NOUN_PLURAL_KEY
-
Fields inherited from class simpleorm.dataset.SRecordMeta
quoteName
-
-
Constructor Summary
Constructors Constructor Description RecordMeta(java.lang.Class<T> userClass, java.lang.String tableName)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addRecordListener(IRecordListener<T> listener)
static SFieldMeta
getNameField(SRecordMeta<?> meta)
Returns the field for the record type that represents the record's name.static java.lang.String
getRecordDescription(SRecordInstance record)
Attempts to return the "description" of any given record instance, using heuristics to find the name field (i.e.int
getRecordListenerCount()
IRecordListener<T>[]
getRecordListeners()
static java.lang.String
getRecordName(SRecordInstance record)
Attempts to return the "name" of any given record instance, using heuristics to find the name field (i.e.static java.lang.String
getRecordNameIfExists(RecordInstanceForeignKey rfk)
Attempts to return the "name" of any given record instance, using heuristics to find the name field (i.e.static java.lang.String
getRecordNameIfExists(SRecordInstance record)
Attempts to return the "name" of any given record instance, using heuristics to find the name field (i.e.java.lang.String
getRecordTypeName(java.util.Locale locale)
void
removeRecordListener(IRecordListener<T> listener)
RecordMeta<T>
setNounKey(java.lang.String key)
RecordMeta<T>
setNounPluralKey(java.lang.String key)
-
Methods inherited from class simpleorm.dataset.SRecordMeta
fieldsForMode, getAllScalarFields, getDescriptiveScalarFields, getField, getFieldMetas, getFieldNames, getPrimaryKeys, getQueriedScalarFields, getTableName, getUserClass, getUserProperties, getUserProperty, putUserProperty, readResolve, setQuoted, toLongerString, toString
-
-
-
-
Field Detail
-
RECORD_NOUN_KEY
public static final java.lang.String RECORD_NOUN_KEY
- See Also:
- Constant Field Values
-
RECORD_NOUN_PLURAL_KEY
public static final java.lang.String RECORD_NOUN_PLURAL_KEY
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
RecordMeta
public RecordMeta(java.lang.Class<T> userClass, java.lang.String tableName)
-
-
Method Detail
-
getNameField
public static SFieldMeta getNameField(SRecordMeta<?> meta)
Returns the field for the record type that represents the record's name. If it has not been explicitly set, it looks for a field with the name "Name". If none exists, it looks for the first descriptive scalar field. If there is none, it returns null.- Returns:
- A field that represents the name of the record, or null if none can be found.
-
getRecordName
public static java.lang.String getRecordName(SRecordInstance record)
Attempts to return the "name" of any given record instance, using heuristics to find the name field (i.e. it guesses that it is named "Name". See getNameField() logic.
-
getRecordNameIfExists
public static java.lang.String getRecordNameIfExists(SRecordInstance record)
Attempts to return the "name" of any given record instance, using heuristics to find the name field (i.e. it guesses that it is named "Name". Will return null if it can't find a name unlike getRecordName(), which returns the record.toString() if a name field can't be found.
-
getRecordNameIfExists
public static java.lang.String getRecordNameIfExists(RecordInstanceForeignKey rfk)
Attempts to return the "name" of any given record instance, using heuristics to find the name field (i.e. it guesses that it is named "Name".) If the name cannot be located in this way, the foreign key column name is returned instead.
-
getRecordDescription
public static java.lang.String getRecordDescription(SRecordInstance record)
Attempts to return the "description" of any given record instance, using heuristics to find the name field (i.e. it guesses that it is named "Description" or "Desc".
-
addRecordListener
public void addRecordListener(IRecordListener<T> listener)
-
removeRecordListener
public void removeRecordListener(IRecordListener<T> listener)
-
getRecordListeners
public IRecordListener<T>[] getRecordListeners()
-
getRecordListenerCount
public int getRecordListenerCount()
-
setNounKey
public RecordMeta<T> setNounKey(java.lang.String key)
-
setNounPluralKey
public RecordMeta<T> setNounPluralKey(java.lang.String key)
-
getRecordTypeName
public java.lang.String getRecordTypeName(java.util.Locale locale)
-
-