com.goldencode.p2j.persist

Class Record

java.lang.Object

com.goldencode.p2j.persist.orm.BaseRecord

com.goldencode.p2j.persist.Record

All Implemented Interfaces:

DmoState, PropertiesDescriptor, Persistable

Direct Known Subclasses:

TempRecord

public abstract class Record
extends BaseRecord
implements PropertiesDescriptor

The abstract base class for all business data model object classes. Provides an API for a concrete implementation to access the low level data of this object as FWD data wrapper types. Subclasses are intended to be generated at runtime, rather than coded by hand.

Field Summary

Fields inherited from class com.goldencode.p2j.persist.orm.BaseRecord

activeOffset, data, id, PK_GETTER, readFields, references, state

Fields inherited from interface com.goldencode.p2j.persist.orm.DmoState

CACHED, CHANGED, COPY, DEFAULT, DELETED, DELETING, INCOMPLETE, INVALID, NEW, NOUNDO, READ, STALE, TRACKED

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Record() Default constructor needed by DMOs extending this class.

Method Summary

Modifier and Type	Method and Description
blob	_getBlob(int offset) Get an blob value for the datum at the given offset in the property array.
protected blob[]	_getBlob(int extent, int offset) Bulk getter for a blob extent field.
character	_getCharacter(int offset) Get a character value for the datum at the given offset in the property array.
protected character[]	_getCharacter(int extent, int offset) Bulk getter for a character extent field.
clob	_getClob(int offset) Get an clob value for the datum at the given offset in the property array.
protected clob[]	_getClob(int extent, int offset) Bulk getter for a clob extent field.
comhandle	_getComhandle(int offset) Get an comhandle value for the datum at the given offset in the property array.
protected comhandle[]	_getComhandle(int extent, int offset) Bulk getter for a comhandle extent field.
date	_getDate(int offset) Get an date value for the datum at the given offset in the property array.
protected date[]	_getDate(int extent, int offset) Bulk getter for a date extent field.
datetime	_getDatetime(int offset) Get an datetime value for the datum at the given offset in the property array.
protected datetime[]	_getDatetime(int extent, int offset) Bulk getter for a datetime extent field.
datetimetz	_getDatetimetz(int offset) Get an datetimetz value for the datum at the given offset in the property array.
protected datetimetz[]	_getDatetimetz(int extent, int offset) Bulk getter for a datetimetz extent field.
decimal	_getDecimal(int offset) Get a decimal value for the datum at the given offset in the property array.
protected decimal[]	_getDecimal(int extent, int offset) Bulk getter for a integer extent field.
handle	_getHandle(int offset) Get a handle value for the datum at the given offset in the property array.
protected handle[]	_getHandle(int extent, int offset) Bulk getter for a handle extent field.
int64	_getInt64(int offset) Get an int64 value for the datum at the given offset in the property array.
protected int64[]	_getInt64(int extent, int offset) Bulk getter for a int64 extent field.
integer	_getInteger(int offset) Get an integer value for the datum at the given offset in the property array.
protected integer[]	_getInteger(int extent, int offset) Bulk getter for a integer extent field.
object<?>	_getObject(int offset) Get an object value for the datum at the given offset in the property array.
protected object<?>[]	_getObject(int extent, int offset) Bulk getter for a object extent field.
raw	_getRaw(int offset) Get an raw value for the datum at the given offset in the property array.
protected raw[]	_getRaw(int extent, int offset) Bulk getter for a raw extent field.
recid	_getRecid(int offset) Get a recid value for the datum at the given offset in the property array.
protected recid[]	_getRecid(int extent, int offset) Bulk getter for a recid extent field.
(package private) RecordMeta	_getRecordMeta() Package private access to the subclass' record metadata for low level operations on this record.
rowid	_getRowid(int offset) Get a rowid value for the datum at the given offset in the property array.
protected rowid[]	_getRowid(int extent, int offset) Bulk getter for a rowid extent field.
logical	_isLogical(int offset) Get an integer value for the datum at the given offset in the property array.
protected logical[]	_isLogical(int extent, int offset) Bulk getter for a logical extent field.
protected void	_setBlob(blob[] val, int extent, int offset) Bulk setter for a blob extent field.
protected void	_setBlob(blob val, int extent, int offset) Mass setter for a blob extent field.
protected void	_setBlob(int offset, blob w) Set an blob value into the data at the given offset in the property array.
protected void	_setCharacter(int offset, Text w) Set a character value into the data at the given offset in the property array.
protected void	_setCharacter(Text[] val, int extent, int offset) Bulk setter for a Text extent field.
protected void	_setCharacter(Text val, int extent, int offset) Mass setter for a Text extent field.
protected void	_setClob(clob[] val, int extent, int offset) Bulk setter for a clob extent field.
protected void	_setClob(clob val, int extent, int offset) Mass setter for a clob extent field.
protected void	_setClob(int offset, clob w) Set an clob value into the data at the given offset in the property array.
protected void	_setComhandle(comhandle[] val, int extent, int offset) Bulk setter for a comhandle extent field.
protected void	_setComhandle(comhandle val, int extent, int offset) Mass setter for a comhandle extent field.
protected void	_setComhandle(int offset, comhandle w) Set an comhandle value into the data at the given offset in the property array.
protected void	_setDate(date[] val, int extent, int offset) Bulk setter for a date extent field.
protected void	_setDate(date val, int extent, int offset) Mass setter for a date extent field.
protected void	_setDate(int offset, date d) Set an date value into the data at the given offset in the property array.
protected void	_setDatetime(date[] val, int extent, int offset) Bulk setter for a datetime extent field.
protected void	_setDatetime(date val, int extent, int offset) Mass setter for a datetime extent field.
protected void	_setDatetime(int offset, date w) Set an datetime value into the data at the given offset in the property array.
protected void	_setDatetimetz(date[] val, int extent, int offset) Bulk setter for a datetimetz extent field.
protected void	_setDatetimetz(date val, int extent, int offset) Mass setter for a datetimetz extent field.
protected void	_setDatetimetz(int offset, date w) Set an datetimetz value into the data at the given offset in the property array.
protected void	_setDecimal(int offset, NumberType w) Set a decimal value into the data at the given offset in the property array.
protected void	_setDecimal(NumberType[] val, int extent, int offset) Bulk setter for a NumberType extent field.
protected void	_setDecimal(NumberType val, int extent, int offset) Mass setter for a NumberType extent field.
protected void	_setHandle(handle[] val, int extent, int offset) Bulk setter for a handle extent field.
protected void	_setHandle(handle val, int extent, int offset) Mass setter for a handle extent field.
protected void	_setHandle(int offset, handle w) Set a handle value into the data at the given offset in the property array.
protected void	_setInt64(int offset, NumberType w) Set an integer value into the data at the given offset in the property array.
protected void	_setInt64(NumberType[] val, int extent, int offset) Bulk setter for a NumberType extent field.
protected void	_setInt64(NumberType val, int extent, int offset) Mass setter for a NumberType extent field.
protected void	_setInteger(int offset, NumberType w) Set an integer value into the data at the given offset in the property array.
protected void	_setInteger(NumberType[] val, int extent, int offset) Bulk setter for a NumberType extent field.
protected void	_setInteger(NumberType val, int extent, int offset) Mass setter for a NumberType extent field.
protected void	_setLogical(int offset, logical w) Set an logical value into the data at the given offset in the property array.
protected void	_setLogical(logical[] val, int extent, int offset) Bulk setter for a logical extent field.
protected void	_setLogical(logical val, int extent, int offset) Mass setter for a logical extent field.
protected void	_setObject(int offset, object<?> w) Set an object value into the data at the given offset in the property array.
protected void	_setObject(object<?>[] val, int extent, int offset) Bulk setter for a object extent field.
protected void	_setObject(object<?> val, int extent, int offset) Mass setter for a object extent field.
protected void	_setRaw(BinaryData[] val, int extent, int offset) Bulk setter for a raw extent field.
protected void	_setRaw(BinaryData val, int extent, int offset) Mass setter for a raw extent field.
protected void	_setRaw(int offset, BinaryData w) Set an raw value into the data at the given offset in the property array.
protected void	_setRecid(int offset, NumberType w) Set a recid value into the data at the given offset in the property array.
protected void	_setRecid(NumberType val, int extent, int offset) Mass setter for a recid extent field.
protected void	_setRecid(recid[] val, int extent, int offset) Bulk setter for a recid extent field.
protected void	_setRowid(int offset, rowid w) Set a rowid value into the data at the given offset in the property array.
protected void	_setRowid(rowid[] val, int extent, int offset) Bulk setter for a rowid extent field.
protected void	_setRowid(rowid val, int extent, int offset) Mass setter for a rowid extent field.
(package private) long	decrementReferences(boolean transient_) Decrement the count of references to this object.
static DataModelObject	fromPOJO(java.lang.Object pojo) Create a new DMO Record starting from a POJO.
java.util.Map<java.lang.String,java.lang.Object>	getPropertyValues() Get all the properties from this record, in a map using as keys their legacy name.
(package private) long	incrementReferences(boolean transient_) Increment the count of references to this object.
boolean	isMultiplyReferenced(boolean includeTransient) Check if the record is referenced by multiple buffers in the same time.
protected abstract void	populateFromPOJO(java.lang.Object pojo) Populates this object with data from a POJO.
void	setPropertyValues(java.util.Map<java.lang.String,java.lang.Object> properties, java.util.function.BiFunction<PropertyMeta,java.lang.Object,java.lang.Object> f) Given a map which contains legacy property names to their values, populate this record by deserializing the expected value using the given function.
Record	snapshot() Creates a snapshot copy of the current record.
protected static java.sql.Date	toDmoDate(java.util.GregorianCalendar date) Helper function to convert form a GregorianCalendar to a java.sql.Date instance.
protected static java.sql.Timestamp	toDmoDatetime(java.util.GregorianCalendar datetime) Helper function to convert form a GregorianCalendar to a java.sql.Timestamp instance.
protected static java.time.OffsetDateTime	toDmoDatetimetz(java.util.GregorianCalendar datetimetz) Helper function to convert form a GregorianCalendar to a java.time.OffsetDateTime instance.
abstract java.lang.Object	toPOJO() Converts this Record into a POJO, if POJO class is available.
protected static java.util.GregorianCalendar	toPojo(java.sql.Date date) Helper function to convert form a java.sql.Date to a GregorianCalendar instance.
protected static java.util.GregorianCalendar	toPojo(java.time.OffsetDateTime datetimetz) Helper function to convert form a java.time.OffsetDateTime to a GregorianCalendar instance.
protected static java.util.GregorianCalendar	toPojo(java.sql.Timestamp datetime) Helper function to convert form a java.sql.Timestamp to a GregorianCalendar instance.
java.lang.String	toString2(boolean oneLine) Utility method used for debugging and logging.
protected void	updateObjectRefCount(object<?> oldVal, object<?> newVal) Update the object reference count.

Methods inherited from class com.goldencode.p2j.persist.orm.BaseRecord

_getReadFields, _recordMeta, checkIncomplete, checkState, copy, copy, deepCopy, getActiveUpdateDiffs, getCodePage, getData, getData, getDatum, getDirtyIndices, getDirtyProps, getIndexState, getRecordLockIdentifier, getSize, initialize, initialize, isAnyIndexFullyDirty, isDirty, isIndexed, isInUse, isValid, needsValidation, primaryKey, primaryKey, restoreActiveState, setActiveBuffer, setAllData, setDatum, toString, toString, undoActive, updateState

Methods inherited from class java.lang.Object

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

Constructor Detail

Record

protected Record()

Default constructor needed by DMOs extending this class.

Method Detail

snapshot

public Record snapshot()

Creates a snapshot copy of the current record.

Returns:

a new Record instance of this record with all fields set to values of the respective fields in this Record at the moment of the call.

_getInteger

public final integer _getInteger(int offset)

Get an integer value for the datum at the given offset in the property array.

This method serves as a bridge between the upper level DMO API used by business logic, and the low-level data storage in the record.

Parameters:

offset - Zero-based offset from which to retrieve the value from the property array.

Returns:

The datum as an integer; will represent unknown value if the datum is null.

_setInteger

protected final void _setInteger(int offset,
                                 NumberType w)

Set an integer value into the data at the given offset in the property array.

This method serves as a bridge between the upper level DMO API used by business logic, and the low-level data storage in the record.

Parameters:

offset - Zero-based offset at which to store the given datum in the property array.

w - FWD wrapper type for the integral value.

_getInteger

protected final integer[] _getInteger(int extent,
                                      int offset)

Bulk getter for a integer extent field. All components are returned as a single array of integer.

Parameters:

extent - The size of the extent field (the number of elements).

offset - Zero-based offset of the first element of the extent field.

Returns:

An array of integer representing the elements of an extent field.

_setInteger

protected final void _setInteger(NumberType[] val,
                                 int extent,
                                 int offset)

Bulk setter for a NumberType extent field. Each components from val parameter will initialize their correspondent of the extent field in data array.

Parameters:

val - An array of NumberType values to be used for setting the extent field.

extent - The size of the extent field (the number of elements).

offset - Zero-based offset of the first element of the extent field.

_setInteger

protected final void _setInteger(NumberType val,
                                 int extent,
                                 int offset)

Mass setter for a NumberType extent field. All components of the extent field will be set to val in data array.

Parameters:

val - A NumberType value to be used for setting the extent field components.

extent - The size of the extent field (the number of elements).

offset - Zero-based offset of the first element of the extent field.

_getDatetimetz

public final datetimetz _getDatetimetz(int offset)

Get an datetimetz value for the datum at the given offset in the property array.

This method serves as a bridge between the upper level DMO API used by business logic, and the low-level data storage in the record.

Parameters:

offset - Zero-based offset from which to retrieve the value from the property array.

Returns:

The datum as an datetimetz; will represent unknown value if the datum is null.

_setDatetimetz

protected final void _setDatetimetz(int offset,
                                    date w)

Set an datetimetz value into the data at the given offset in the property array.

This method serves as a bridge between the upper level DMO API used by business logic, and the low-level data storage in the record.

Parameters:

offset - Zero-based offset at which to store the given datum in the property array.

w - FWD wrapper type for the integral value.

_getDatetimetz

protected final datetimetz[] _getDatetimetz(int extent,
                                            int offset)

Bulk getter for a datetimetz extent field. All components are returned as a single array of datetimetz.

Parameters:

extent - The size of the extent field (the number of elements).

offset - Zero-based offset of the first element of the extent field.

Returns:

An array of datetimetz representing the elements of an extent field.

_setDatetimetz

protected final void _setDatetimetz(date[] val,
                                    int extent,
                                    int offset)

Bulk setter for a datetimetz extent field. Each components from val parameter will initialize their correspondent of the extent field in data array.

Parameters:

val - An array of date values to be used for setting the extent field.

extent - The size of the extent field (the number of elements).

offset - Zero-based offset of the first element of the extent field.

_setDatetimetz

protected final void _setDatetimetz(date val,
                                    int extent,
                                    int offset)

Mass setter for a datetimetz extent field. All components of the extent field will be set to val in data array.

Parameters:

val - A date value to be used for setting the extent field components.

extent - The size of the extent field (the number of elements).

offset - Zero-based offset of the first element of the extent field.

_getDatetime

public final datetime _getDatetime(int offset)

Get an datetime value for the datum at the given offset in the property array.

This method serves as a bridge between the upper level DMO API used by business logic, and the low-level data storage in the record.

Parameters:

offset - Zero-based offset from which to retrieve the value from the property array.

Returns:

The datum as an datetime; will represent unknown value if the datum is null.

_setDatetime

protected final void _setDatetime(int offset,
                                  date w)

Set an datetime value into the data at the given offset in the property array.

This method serves as a bridge between the upper level DMO API used by business logic, and the low-level data storage in the record.

Parameters:

offset - Zero-based offset at which to store the given datum in the property array.

w - FWD wrapper type for the integral value.

_getDatetime

protected final datetime[] _getDatetime(int extent,
                                        int offset)

Bulk getter for a datetime extent field. All components are returned as a single array of datetime.

Parameters:

extent - The size of the extent field (the number of elements).

offset - Zero-based offset of the first element of the extent field.

Returns:

An array of datetime representing the elements of an extent field.

_setDatetime

protected final void _setDatetime(date[] val,
                                  int extent,
                                  int offset)

Bulk setter for a datetime extent field. Each components from val parameter will initialize their correspondent of the extent field in data array.

Parameters:

val - An array of datetime values to be used for setting the extent field.

extent - The size of the extent field (the number of elements).

offset - Zero-based offset of the first element of the extent field.

_setDatetime

protected final void _setDatetime(date val,
                                  int extent,
                                  int offset)

Mass setter for a datetime extent field. All components of the extent field will be set to val in data array.

Parameters:

val - A date value to be used for setting the extent field components.

extent - The size of the extent field (the number of elements).

offset - Zero-based offset of the first element of the extent field.

_getDate

public final date _getDate(int offset)

Get an date value for the datum at the given offset in the property array.

This method serves as a bridge between the upper level DMO API used by business logic, and the low-level data storage in the record.

Parameters:

offset - Zero-based offset from which to retrieve the value from the property array.

Returns:

The datum as an date; will represent unknown value if the datum is null.

_setDate

protected final void _setDate(int offset,
                              date d)

Set an date value into the data at the given offset in the property array.

This method serves as a bridge between the upper level DMO API used by business logic, and the low-level data storage in the record.

Parameters:

offset - Zero-based offset at which to store the given datum in the property array.

d - FWD wrapper type for the integral value.

_getDate

protected final date[] _getDate(int extent,
                                int offset)

Bulk getter for a date extent field. All components are returned as a single array of date.

Parameters:

extent - The size of the extent field (the number of elements).

offset - Zero-based offset of the first element of the extent field.

Returns:

An array of date representing the elements of an extent field.

_setDate

protected final void _setDate(date[] val,
                              int extent,
                              int offset)

Bulk setter for a date extent field. Each components from val parameter will initialize their correspondent of the extent field in data array.

Parameters:

val - An array of date values to be used for setting the extent field.

extent - The size of the extent field (the number of elements).

offset - Zero-based offset of the first element of the extent field.

_setDate

protected final void _setDate(date val,
                              int extent,
                              int offset)

Mass setter for a date extent field. All components of the extent field will be set to val in data array.

Parameters:

val - A date value to be used for setting the extent field components.

extent - The size of the extent field (the number of elements).

offset - Zero-based offset of the first element of the extent field.

_isLogical

public final logical _isLogical(int offset)

Get an integer value for the datum at the given offset in the property array.

This method serves as a bridge between the upper level DMO API used by business logic, and the low-level data storage in the record.

Parameters:

offset - Zero-based offset from which to retrieve the value from the property array.

Returns:

The datum as an integer; will represent unknown value if the datum is null.

_setLogical

protected final void _setLogical(int offset,
                                 logical w)

Set an logical value into the data at the given offset in the property array.

This method serves as a bridge between the upper level DMO API used by business logic, and the low-level data storage in the record.

Parameters:

offset - Zero-based offset at which to store the given datum in the property array.

w - FWD wrapper type for the logical value.

_isLogical

protected final logical[] _isLogical(int extent,
                                     int offset)

Bulk getter for a logical extent field. All components are returned as a single array of logical.

Parameters:

extent - The size of the extent field (the number of elements).

offset - Zero-based offset of the first element of the extent field.

Returns:

An array of logical representing the elements of an extent field.

_setLogical

protected final void _setLogical(logical[] val,
                                 int extent,
                                 int offset)

Bulk setter for a logical extent field. Each components from val parameter will initialize their correspondent of the extent field in data array.

Parameters:

val - An array of logical values to be used for setting the extent field.

extent - The size of the extent field (the number of elements).

offset - Zero-based offset of the first element of the extent field.

_setLogical

protected final void _setLogical(logical val,
                                 int extent,
                                 int offset)

Mass setter for a logical extent field. All components of the extent field will be set to val in data array.

Parameters:

val - A logical value to be used for setting the extent field components.

extent - The size of the extent field (the number of elements).

offset - Zero-based offset of the first element of the extent field.

_getInt64

public final int64 _getInt64(int offset)

Get an int64 value for the datum at the given offset in the property array.

This method serves as a bridge between the upper level DMO API used by business logic, and the low-level data storage in the record.

Parameters:

offset - Zero-based offset from which to retrieve the value from the property array.

Returns:

The datum as an int64; will represent unknown value if the datum is null.

_setInt64

protected final void _setInt64(int offset,
                               NumberType w)

Set an integer value into the data at the given offset in the property array.

This method serves as a bridge between the upper level DMO API used by business logic, and the low-level data storage in the record.

Parameters:

offset - Zero-based offset at which to store the given datum in the property array.

w - FWD wrapper type for the integral value.

_getInt64

protected final int64[] _getInt64(int extent,
                                  int offset)

Bulk getter for a int64 extent field. All components are returned as a single array of int64.

Parameters:

extent - The size of the extent field (the number of elements).

offset - Zero-based offset of the first element of the extent field.

Returns:

An array of int64 representing the elements of an extent field.

_setInt64

protected final void _setInt64(NumberType[] val,
                               int extent,
                               int offset)

Bulk setter for a NumberType extent field. Each components from val parameter will initialize their correspondent of the extent field in data array.

Parameters:

val - An array of NumberType values to be used for setting the extent field.

extent - The size of the extent field (the number of elements).

offset - Zero-based offset of the first element of the extent field.

_setInt64

protected final void _setInt64(NumberType val,
                               int extent,
                               int offset)

Mass setter for a NumberType extent field. All components of the extent field will be set to val in data array.

Parameters:

val - A NumberType value to be used for setting the extent field components.

extent - The size of the extent field (the number of elements).

offset - Zero-based offset of the first element of the extent field.

_getDecimal

public final decimal _getDecimal(int offset)

Get a decimal value for the datum at the given offset in the property array.

This method serves as a bridge between the upper level DMO API used by business logic, and the low-level data storage in the record.

Parameters:

offset - Zero-based offset from which to retrieve the value from the property array.

Returns:

The datum as a decimal; will represent unknown value if the datum is null.

_setDecimal

protected final void _setDecimal(int offset,
                                 NumberType w)

Set a decimal value into the data at the given offset in the property array.

This method serves as a bridge between the upper level DMO API used by business logic, and the low-level data storage in the record.

Parameters:

offset - Zero-based offset at which to store the given datum in the property array.

w - FWD wrapper type for the decimal value.

_getDecimal

protected final decimal[] _getDecimal(int extent,
                                      int offset)

Bulk getter for a integer extent field. All components are returned as a single array of integer.

Parameters:

extent - The size of the extent field (the number of elements).

offset - Zero-based offset of the first element of the extent field.

Returns:

An array of integer representing the elements of an extent field.

_setDecimal

protected final void _setDecimal(NumberType[] val,
                                 int extent,
                                 int offset)

Bulk setter for a NumberType extent field. Each components from val parameter will initialize their correspondent of the extent field in data array.

Parameters:

val - An array of NumberType values to be used for setting the extent field.

extent - The size of the extent field (the number of elements).

offset - Zero-based offset of the first element of the extent field.

_setDecimal

protected final void _setDecimal(NumberType val,
                                 int extent,
                                 int offset)

Mass setter for a NumberType extent field. All components of the extent field will be set to val in data array.

Parameters:

val - A NumberType value to be used for setting the extent field components.

extent - The size of the extent field (the number of elements).

offset - Zero-based offset of the first element of the extent field.

_getCharacter

public final character _getCharacter(int offset)

Get a character value for the datum at the given offset in the property array.

This method serves as a bridge between the upper level DMO API used by business logic, and the low-level data storage in the record.

Parameters:

offset - Zero-based offset from which to retrieve the value from the property array.

Returns:

The datum as a character; will represent unknown value if the datum is null. The value will have the case-sensitivity inherent to the corresponding field.

_setCharacter

protected final void _setCharacter(int offset,
                                   Text w)

Set a character value into the data at the given offset in the property array.

This method serves as a bridge between the upper level DMO API used by business logic, and the low-level data storage in the record.

Parameters:

offset - Zero-based offset at which to store the given datum in the property array.

w - FWD wrapper type for the character value. The case-sensitivity property of this wrapper instance is not preserved.

_getCharacter

protected final character[] _getCharacter(int extent,
                                          int offset)

Bulk getter for a character extent field. All components are returned as a single array of character.

Parameters:

extent - The size of the extent field (the number of elements).

offset - Zero-based offset of the first element of the extent field.

Returns:

An array of character representing the elements of an extent field.

_setCharacter

protected final void _setCharacter(Text[] val,
                                   int extent,
                                   int offset)

Bulk setter for a Text extent field. Each components from val parameter will initialize their correspondent of the extent field in data array.

Parameters:

val - An array of Text values to be used for setting the extent field.

extent - The size of the extent field (the number of elements).

offset - Zero-based offset of the first element of the extent field.

_setCharacter

protected final void _setCharacter(Text val,
                                   int extent,
                                   int offset)

Mass setter for a Text extent field. All components of the extent field will be set to val in data array.

Parameters:

val - A Text value to be used for setting the extent field components.

extent - The size of the extent field (the number of elements).

offset - Zero-based offset of the first element of the extent field.

_getRowid

public final rowid _getRowid(int offset)

Get a rowid value for the datum at the given offset in the property array.

This method serves as a bridge between the upper level DMO API used by business logic, and the low-level data storage in the record.

Parameters:

offset - Zero-based offset from which to retrieve the value from the property array.

Returns:

The datum as a rowid; will represent unknown value if the datum is null. The value will have the case-sensitivity inherent to the corresponding field.

_setRowid

protected final void _setRowid(int offset,
                               rowid w)

Set a rowid value into the data at the given offset in the property array.

This method serves as a bridge between the upper level DMO API used by business logic, and the low-level data storage in the record.

Parameters:

offset - Zero-based offset at which to store the given datum in the property array.

w - FWD wrapper type for the rowid value. The case-sensitivity property of this wrapper instance is not preserved.

_getRowid

protected final rowid[] _getRowid(int extent,
                                  int offset)

Bulk getter for a rowid extent field. All components are returned as a single array of rowid.

Parameters:

extent - The size of the extent field (the number of elements).

offset - Zero-based offset of the first element of the extent field.

Returns:

An array of rowid representing the elements of an extent field.

_setRowid

protected final void _setRowid(rowid[] val,
                               int extent,
                               int offset)

Bulk setter for a rowid extent field. Each components from val parameter will initialize their correspondent of the extent field in data array.

Parameters:

val - An array of rowid values to be used for setting the extent field.

extent - The size of the extent field (the number of elements).

offset - Zero-based offset of the first element of the extent field.

_setRowid

protected final void _setRowid(rowid val,
                               int extent,
                               int offset)

Mass setter for a rowid extent field. All components of the extent field will be set to val in data array.

Parameters:

val - A rowid value to be used for setting the extent field components.

extent - The size of the extent field (the number of elements).

offset - Zero-based offset of the first element of the extent field.

_getHandle

public final handle _getHandle(int offset)

Get a handle value for the datum at the given offset in the property array.

This method serves as a bridge between the upper level DMO API used by business logic, and the low-level data storage in the record.

Parameters:

offset - Zero-based offset from which to retrieve the value from the property array.

Returns:

The datum as a handle; will represent unknown value if the datum is null. The value will have the case-sensitivity inherent to the corresponding field.

_setHandle

protected final void _setHandle(int offset,
                                handle w)

Set a handle value into the data at the given offset in the property array.

This method serves as a bridge between the upper level DMO API used by business logic, and the low-level data storage in the record.

Parameters:

offset - Zero-based offset at which to store the given datum in the property array.

w - FWD wrapper type for the handle value. The case-sensitivity property of this wrapper instance is not preserved.

_getHandle

protected final handle[] _getHandle(int extent,
                                    int offset)

Bulk getter for a handle extent field. All components are returned as a single array of handle.

Parameters:

extent - The size of the extent field (the number of elements).

offset - Zero-based offset of the first element of the extent field.

Returns:

An array of handle representing the elements of an extent field.

_setHandle

protected final void _setHandle(handle[] val,
                                int extent,
                                int offset)

Bulk setter for a handle extent field. Each components from val parameter will initialize their correspondent of the extent field in data array.

Parameters:

val - An array of handle values to be used for setting the extent field.

extent - The size of the extent field (the number of elements).

offset - Zero-based offset of the first element of the extent field.

_setHandle

protected final void _setHandle(handle val,
                                int extent,
                                int offset)

Mass setter for a handle extent field. All components of the extent field will be set to val in data array.

Parameters:

val - A handle value to be used for setting the extent field components.

extent - The size of the extent field (the number of elements).

offset - Zero-based offset of the first element of the extent field.

_getRecid

public final recid _getRecid(int offset)

Get a recid value for the datum at the given offset in the property array.

This method serves as a bridge between the upper level DMO API used by business logic, and the low-level data storage in the record.

Parameters:

offset - Zero-based offset from which to retrieve the value from the property array.

Returns:

The datum as a recid; will represent unknown value if the datum is null. The value will have the case-sensitivity inherent to the corresponding field.

_setRecid

protected final void _setRecid(int offset,
                               NumberType w)

Set a recid value into the data at the given offset in the property array.

This method serves as a bridge between the upper level DMO API used by business logic, and the low-level data storage in the record.

Parameters:

offset - Zero-based offset at which to store the given datum in the property array.

w - FWD wrapper type for the recid value. The case-sensitivity property of this wrapper instance is not preserved.

_getRecid

protected final recid[] _getRecid(int extent,
                                  int offset)

Bulk getter for a recid extent field. All components are returned as a single array of recid.

Parameters:

extent - The size of the extent field (the number of elements).

offset - Zero-based offset of the first element of the extent field.

Returns:

An array of recid representing the elements of an extent field.

_setRecid

protected final void _setRecid(recid[] val,
                               int extent,
                               int offset)

Bulk setter for a recid extent field. Each components from val parameter will initialize their correspondent of the extent field in data array.

Parameters:

val - An array of recid values to be used for setting the extent field.

extent - The size of the extent field (the number of elements).

offset - Zero-based offset of the first element of the extent field.

_setRecid

protected final void _setRecid(NumberType val,
                               int extent,
                               int offset)

Mass setter for a recid extent field. All components of the extent field will be set to val in data array.

Parameters:

val - A recid value to be used for setting the extent field components.

extent - The size of the extent field (the number of elements).

offset - Zero-based offset of the first element of the extent field.

_getBlob

public final blob _getBlob(int offset)

Get an blob value for the datum at the given offset in the property array.

This method serves as a bridge between the upper level DMO API used by business logic, and the low-level data storage in the record.

Parameters:

offset - Zero-based offset from which to retrieve the value from the property array.

Returns:

The datum as an blob; will represent unknown value if the datum is null.

_getBlob

protected final blob[] _getBlob(int extent,
                                int offset)

Bulk getter for a blob extent field. All components are returned as a single array of blob.

Parameters:

extent - The size of the extent field (the number of elements).

offset - Zero-based offset of the first element of the extent field.

Returns:

An array of blob representing the elements of an extent field.

_setBlob

protected final void _setBlob(int offset,
                              blob w)

Set an blob value into the data at the given offset in the property array.

This method serves as a bridge between the upper level DMO API used by business logic, and the low-level data storage in the record.

Parameters:

offset - Zero-based offset at which to store the given datum in the property array.

w - FWD wrapper type for the value.

_setBlob

protected final void _setBlob(blob[] val,
                              int extent,
                              int offset)

Bulk setter for a blob extent field. Each components from val parameter will initialize their correspondent of the extent field in data array.

Parameters:

val - An array of blob values to be used for setting the extent field.

extent - The size of the extent field (the number of elements).

offset - Zero-based offset of the first element of the extent field.

_setBlob

protected final void _setBlob(blob val,
                              int extent,
                              int offset)

Mass setter for a blob extent field. All components of the extent field will be set to val in data array.

Parameters:

val - A blob value to be used for setting the extent field components.

extent - The size of the extent field (the number of elements).

offset - Zero-based offset of the first element of the extent field.

_getClob

public final clob _getClob(int offset)

Get an clob value for the datum at the given offset in the property array.

This method serves as a bridge between the upper level DMO API used by business logic, and the low-level data storage in the record.

Note: in order for this method to work, the activeBuffer on parent object must be set in advance. After the method was invoked, it is recommended to clear its value.

Parameters:

offset - Zero-based offset from which to retrieve the value from the property array.

Returns:

The datum as an clob; will represent unknown value if the datum is null.

_getClob

protected final clob[] _getClob(int extent,
                                int offset)

Bulk getter for a clob extent field. All components are returned as a single array of clob.

Parameters:

extent - The size of the extent field (the number of elements).

offset - Zero-based offset of the first element of the extent field.

Returns:

An array of clob representing the elements of an extent field.

_setClob

protected final void _setClob(int offset,
                              clob w)

Set an clob value into the data at the given offset in the property array.

This method serves as a bridge between the upper level DMO API used by business logic, and the low-level data storage in the record.

Parameters:

offset - Zero-based offset at which to store the given datum in the property array.

w - FWD wrapper type for the value.

_setClob

protected final void _setClob(clob[] val,
                              int extent,
                              int offset)

Bulk setter for a clob extent field. Each components from val parameter will initialize their correspondent of the extent field in data array.

Parameters:

val - An array of clob values to be used for setting the extent field.

extent - The size of the extent field (the number of elements).

offset - Zero-based offset of the first element of the extent field.

_setClob

protected final void _setClob(clob val,
                              int extent,
                              int offset)

Mass setter for a clob extent field. All components of the extent field will be set to val in data array.

Parameters:

val - A clob value to be used for setting the extent field components.

extent - The size of the extent field (the number of elements).

offset - Zero-based offset of the first element of the extent field.

_getComhandle

public final comhandle _getComhandle(int offset)

Get an comhandle value for the datum at the given offset in the property array.

This method serves as a bridge between the upper level DMO API used by business logic, and the low-level data storage in the record.

Parameters:

offset - Zero-based offset from which to retrieve the value from the property array.

Returns:

The datum as an comhandle; will represent unknown value if the datum is null.

_getComhandle

protected final comhandle[] _getComhandle(int extent,
                                          int offset)

Bulk getter for a comhandle extent field. All components are returned as a single array of comhandle.

Parameters:

extent - The size of the extent field (the number of elements).

offset - Zero-based offset of the first element of the extent field.

Returns:

An array of comhandle representing the elements of an extent field.

_setComhandle

protected final void _setComhandle(int offset,
                                   comhandle w)

Set an comhandle value into the data at the given offset in the property array.

This method serves as a bridge between the upper level DMO API used by business logic, and the low-level data storage in the record.

Parameters:

offset - Zero-based offset at which to store the given datum in the property array.

w - FWD wrapper type for the value.

_setComhandle

protected final void _setComhandle(comhandle[] val,
                                   int extent,
                                   int offset)

Bulk setter for a comhandle extent field. Each components from val parameter will initialize their correspondent of the extent field in data array.

Parameters:

val - An array of comhandle values to be used for setting the extent field.

extent - The size of the extent field (the number of elements).

offset - Zero-based offset of the first element of the extent field.

_setComhandle

protected final void _setComhandle(comhandle val,
                                   int extent,
                                   int offset)

Mass setter for a comhandle extent field. All components of the extent field will be set to val in data array.

Parameters:

val - A comhandle value to be used for setting the extent field components.

extent - The size of the extent field (the number of elements).

offset - Zero-based offset of the first element of the extent field.

_getObject

public final object<?> _getObject(int offset)

Get an object value for the datum at the given offset in the property array.

This method serves as a bridge between the upper level DMO API used by business logic, and the low-level data storage in the record.

Parameters:

offset - Zero-based offset from which to retrieve the value from the property array.

Returns:

The datum as an object; will represent unknown value if the datum is null.

_getObject

protected final object<?>[] _getObject(int extent,
                                       int offset)

Bulk getter for a object extent field. All components are returned as a single array of object.

Parameters:

extent - The size of the extent field (the number of elements).

offset - Zero-based offset of the first element of the extent field.

Returns:

An array of object representing the elements of an extent field.

_setObject

protected final void _setObject(int offset,
                                object<?> w)

Set an object value into the data at the given offset in the property array.

This method serves as a bridge between the upper level DMO API used by business logic, and the low-level data storage in the record.

Parameters:

offset - Zero-based offset at which to store the given datum in the property array.

w - FWD wrapper type for the value.

_setObject

protected final void _setObject(object<?>[] val,
                                int extent,
                                int offset)

Bulk setter for a object extent field. Each components from val parameter will initialize their correspondent of the extent field in data array.

Parameters:

val - An array of object values to be used for setting the extent field.

extent - The size of the extent field (the number of elements).

offset - Zero-based offset of the first element of the extent field.

_setObject

protected final void _setObject(object<?> val,
                                int extent,
                                int offset)

Mass setter for a object extent field. All components of the extent field will be set to val in data array.

Parameters:

val - A object value to be used for setting the extent field components.

extent - The size of the extent field (the number of elements).

offset - Zero-based offset of the first element of the extent field.

_getRaw

public final raw _getRaw(int offset)

Get an raw value for the datum at the given offset in the property array.

This method serves as a bridge between the upper level DMO API used by business logic, and the low-level data storage in the record.

Parameters:

offset - Zero-based offset from which to retrieve the value from the property array.

Returns:

The datum as an raw; will represent unknown value if the datum is null.

_getRaw

protected final raw[] _getRaw(int extent,
                              int offset)

Bulk getter for a raw extent field. All components are returned as a single array of raw.

Parameters:

extent - The size of the extent field (the number of elements).

offset - Zero-based offset of the first element of the extent field.

Returns:

An array of raw representing the elements of an extent field.

_setRaw

protected final void _setRaw(int offset,
                             BinaryData w)

Set an raw value into the data at the given offset in the property array.

This method serves as a bridge between the upper level DMO API used by business logic, and the low-level data storage in the record.

Parameters:

offset - Zero-based offset at which to store the given datum in the property array.

w - FWD wrapper type for the value.

_setRaw

protected final void _setRaw(BinaryData[] val,
                             int extent,
                             int offset)

Bulk setter for a raw extent field. Each components from val parameter will initialize their correspondent of the extent field in data array.

Parameters:

val - An array of BinaryData values to be used for setting the extent field.

extent - The size of the extent field (the number of elements).

offset - Zero-based offset of the first element of the extent field.

_setRaw

protected final void _setRaw(BinaryData val,
                             int extent,
                             int offset)

Mass setter for a raw extent field. All components of the extent field will be set to val in data array.

Parameters:

val - A BinaryData value to be used for setting the extent field components.

extent - The size of the extent field (the number of elements).

offset - Zero-based offset of the first element of the extent field.

updateObjectRefCount

protected void updateObjectRefCount(object<?> oldVal,
                                    object<?> newVal)

Update the object reference count. It will decrement the old value reference and increment the new value reference.

No-op by default.

Parameters:

oldVal - The old value.

newVal - The new value.

isMultiplyReferenced

public boolean isMultiplyReferenced(boolean includeTransient)

Check if the record is referenced by multiple buffers in the same time.

Parameters:

includeTransient - Include the transient references (used by presort queries).

Returns:

true if this record is loaded in more than one buffer.

incrementReferences

final long incrementReferences(boolean transient_)

Increment the count of references to this object. While positive, this record must remain in the current session's cache.

Parameters:

transient_ - true if this is a transient reference (usually from presort queries).

Returns:

The record's reference count after being incremented.

decrementReferences

final long decrementReferences(boolean transient_)

Decrement the count of references to this object. While positive, this record must remain in the current session's cache.

Parameters:

transient_ - true if this is a transient reference (usually from presort queries).

Returns:

The record's reference count after being decremented.

_getRecordMeta

final RecordMeta _getRecordMeta()

Package private access to the subclass' record metadata for low level operations on this record.

Returns:

The metadata for the the concrete implementation of this class.

toString2

public java.lang.String toString2(boolean oneLine)

Utility method used for debugging and logging.

Parameters:

oneLine - Simplify the result to make it fit on a single line. Some details are skipped and column names.

Returns:

the description of the object as configured by parameter(s).

setPropertyValues

public void setPropertyValues(java.util.Map<java.lang.String,java.lang.Object> properties,
                              java.util.function.BiFunction<PropertyMeta,java.lang.Object,java.lang.Object> f)

Given a map which contains legacy property names to their values, populate this record by deserializing the expected value using the given function.

Parameters:

properties - The properties for this record, which may be serialized as a Java type or as a String (in case of extents).

f - The function used to deserialize the values. The first argument is the PropertyMeta, the second argument is the property value from the properties map and the returned value is the deserialized value of this property, compatible with PropertyMeta.getDataHandler().

getPropertyValues

public java.util.Map<java.lang.String,java.lang.Object> getPropertyValues()

Get all the properties from this record, in a map using as keys their legacy name.

Any extent properties will be contained as a Java array.

Specified by:

getPropertyValues in interface PropertiesDescriptor

Returns:

See above.

toPOJO

public abstract java.lang.Object toPOJO()

Converts this Record into a POJO, if POJO class is available. To be implemented by DMO implementations.

Returns:

a POJO object with same data as current object.

populateFromPOJO

protected abstract void populateFromPOJO(java.lang.Object pojo)

Populates this object with data from a POJO. This is called by fromPOJO(). To be implemented by DMO implementations.

Parameters:

pojo - The source for data.

fromPOJO

public static DataModelObject fromPOJO(java.lang.Object pojo)

Create a new DMO Record starting from a POJO. To work, the application must be converted with POJO generation enabled.

Parameters:

pojo - The source for the new DMO Object.

Returns:

The DMO object created using data from POJO.

toPojo

protected static java.util.GregorianCalendar toPojo(java.sql.Date date)

Helper function to convert form a java.sql.Date to a GregorianCalendar instance.

Parameters:

date - The date to be converted.

Returns:

The converted date as a GregorianCalendar instance.

toPojo

protected static java.util.GregorianCalendar toPojo(java.sql.Timestamp datetime)

Helper function to convert form a java.sql.Timestamp to a GregorianCalendar instance.

Parameters:

datetime - The datetime instant to be converted.

Returns:

The converted date as a GregorianCalendar instance.

toPojo

protected static java.util.GregorianCalendar toPojo(java.time.OffsetDateTime datetimetz)

Helper function to convert form a java.time.OffsetDateTime to a GregorianCalendar instance.

Parameters:

datetimetz - The datetimetz instant to be converted.

Returns:

The converted date as a GregorianCalendar instance.

toDmoDate

protected static java.sql.Date toDmoDate(java.util.GregorianCalendar date)

Helper function to convert form a GregorianCalendar to a java.sql.Date instance.

Parameters:

date - The GregorianCalendar to be converted.

Returns:

The converted date as a Date instance.

toDmoDatetime

protected static java.sql.Timestamp toDmoDatetime(java.util.GregorianCalendar datetime)

Helper function to convert form a GregorianCalendar to a java.sql.Timestamp instance.

Parameters:

datetime - The GregorianCalendar instant to be converted.

Returns:

The converted date as a datetime instance.

toDmoDatetimetz

protected static java.time.OffsetDateTime toDmoDatetimetz(java.util.GregorianCalendar datetimetz)

Helper function to convert form a GregorianCalendar to a java.time.OffsetDateTime instance.

Parameters:

datetimetz - The GregorianCalendar instant to be converted.

Returns:

The converted date as a datetimetz instance.