IdentityField

java.lang.Object
- simpleorm.dataset.SFieldMeta
- - simpleorm.dataset.SFieldScalar
  - - simpleorm.dataset.SFieldLong
    - - com.inductiveautomation.ignition.gateway.localdb.persistence.IdentityField

All Implemented Interfaces:

java.io.Serializable
```
public class IdentityField
extends SFieldLong
```
The IdentityField is a convenient field type that provides a unique, automatically generated long value, and sets itself as the primary key. If it is used in a record, that record should not have a seperately defined primary key.

See Also:

Serialized Form

Field Summary
- Fields inherited from class simpleorm.dataset.SFieldScalar
  sqlDataTypeOverride, theGenerator
- Fields inherited from class simpleorm.dataset.SFieldMeta
  quoteName

Constructor Summary

Constructors
Constructor Description

IdentityField(SRecordMeta<?> meta)

IdentityField(SRecordMeta<?> meta, java.lang.String columnName)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`SGeneratorMode`	`getGeneratorMode()`
`java.lang.Object[]`	`getGeneratorParameter()`
`java.lang.String`	`getSeqName()`
`boolean`	`isGenerated()`
`<T extends SFieldScalar> T`	`setGeneratorMode(SGeneratorMode gen, java.lang.Object... params)`	Sets the generator associated to this field.

Methods inherited from class simpleorm.dataset.SFieldLong
convertToDataSetFieldType, defaultSqlDataType, isFKeyCompatible, javaSqlType, queryFieldValue

Methods inherited from class simpleorm.dataset.SFieldScalar
getColumnName, getMaxSize, getReferences, getTheGenerator, isForeignKey, isMandatory, isNotOptimisticLocked, isPrimary, overrideSqlDataType, setMaxSize, setTheGenerator, toLongerString

Methods inherited from class simpleorm.dataset.SFieldMeta
addFlag, addValidator, doValidate, equals, getFieldName, getFlags, getRecordMeta, getUserProperties, getUserProperty, getValidators, hashCode, isDescriptive, isUnqueried, nextGeneratedValue, putUserProperty, readResolve, setQuoted, toString, writeFieldValue, writeFieldValue

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - IdentityField
```
public IdentityField(SRecordMeta<?> meta)
```
  - IdentityField
```
public IdentityField(SRecordMeta<?> meta,
                     java.lang.String columnName)
```
- Method Detail
  - getGeneratorMode
```
public SGeneratorMode getGeneratorMode()
```
    Overrides:
    
    getGeneratorMode in class SFieldScalar
  - getGeneratorParameter
```
public java.lang.Object[] getGeneratorParameter()
```
    Overrides:
    
    getGeneratorParameter in class SFieldScalar
  - isGenerated
```
public boolean isGenerated()
```
    Overrides:
    
    isGenerated in class SFieldScalar
  - setGeneratorMode
```
public <T extends SFieldScalar> T setGeneratorMode(SGeneratorMode gen,
                                                   java.lang.Object... params)
```
    Description copied from class: SFieldScalar
    
    Sets the generator associated to this field. This will make the field generated, reference the generator for future use and **remove any NotNullValidaotr*** (so if you want to add one, do it after you call setGenerator)
    
    Overrides:
    
    setGeneratorMode in class SFieldScalar
  - getSeqName
```
public java.lang.String getSeqName()
```