com.aspc.DBObj.Archive

Class TransField

java.lang.Object

com.aspc.DBObj.Archive.TransField

public final class TransField
extends java.lang.Object

Transaction field wrapper.
THREAD MODE: MULTI-THREADED

Since:

27 October 2002, 13:30 PM

Author:

Nigel Leck

Constructor Summary

Constructors

Constructor and Description
TransField(int layerId, long transId, long rowUID, DBClass dbClass, GlobalKeyId fieldId) A per transaction/record/field value and previous value.
TransField(int layerId, long transId, long rowUID, DBClass dbClass, GlobalKeyId fieldId, CSQL sql) A per transaction/record/field value and previous value.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCurrentDisplayName(DataSource ds)
java.lang.String	getCurrentDisplayValue(DataSource ds)
java.lang.String	getCurrentLinkedValue(DataSource ds, java.lang.String linkedFieldName)
java.lang.String	getCurrentString(DataSource ds) Current value
DBField	getDBField() The field that was changed
java.lang.String	getFieldGid() The row FieldGid
java.lang.String	getLanguageCd() The language_cd
long	getlinkedUID()
java.lang.String	getPreviousDisplayName(DataSource ds)
java.lang.String	getPreviousDisplayValue(DataSource ds)
long	getPreviousLinkedUID(DataSource ds)
java.lang.String	getPreviousString(DataSource ds)
java.lang.Object	getPreviousValue(DataSource ds)
java.lang.String	getRawValue() get the raw value
long	getRowId() The row id
int	getSeq() The Seq
TransHeader	getTransHeader()
TransRecord	getTransRecord() get the transaction record for this field
java.lang.Object	getValue() The value of the field in this row/transaction
java.lang.String[]	listChangedLanguages(DataSource ds) List the languages that were changed in this transaction for this field.
static TransField[]	search(int layerId, DBClass dbClass, GlobalKeyId fieldId, DBObject obj, java.util.Date from, java.util.Date to, java.lang.String like, java.lang.String sortOrder) Search the layer for a matching field

Methods inherited from class java.lang.Object

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

Constructor Detail

TransField

public TransField(int layerId,
                  long transId,
                  long rowUID,
                  DBClass dbClass,
                  GlobalKeyId fieldId)

A per transaction/record/field value and previous value.

Parameters:

layerId - The layer id

transId - The transaction id

rowUID - The row uid

dbClass - The class

fieldId - The field id

TransField

public TransField(int layerId,
                  long transId,
                  long rowUID,
                  DBClass dbClass,
                  GlobalKeyId fieldId,
                  CSQL sql)

A per transaction/record/field value and previous value.

Parameters:

layerId - The layer id

transId - The transaction id

rowUID - The row uid

dbClass - The class

fieldId - The field id

sql - the sql

Method Detail

search

@CheckReturnValue
 @Nonnull
public static TransField[] search(int layerId,
                                                              DBClass dbClass,
                                                              GlobalKeyId fieldId,
                                                              DBObject obj,
                                                              java.util.Date from,
                                                              java.util.Date to,
                                                              java.lang.String like,
                                                              java.lang.String sortOrder)
                                                       throws java.lang.Exception

Search the layer for a matching field

Parameters:

layerId - the layer

dbClass - the class

fieldId - the field to match on

obj - the object to search on

from - from a date

to - search until this date.

like - matching pattern

sortOrder - ascending or descending

Returns:

the list of matching transaction field records.

Throws:

java.lang.Exception - a serious problem

getTransRecord

@Nullable
 @CheckReturnValue
public TransRecord getTransRecord()

get the transaction record for this field

Returns:

the transaction record

getTransHeader

@Nullable
 @CheckReturnValue
public TransHeader getTransHeader()

Returns:

the transaction header

getPreviousString

@Nonnull
 @CheckReturnValue
public java.lang.String getPreviousString(@Nonnull
                                                                      DataSource ds)

Parameters:

ds - the data source

Returns:

the previous version

getCurrentString

@Nonnull
 @CheckReturnValue
public java.lang.String getCurrentString(@Nonnull
                                                                     DataSource ds)

Current value

Parameters:

ds - the data source

Returns:

the current version

getValue

@CheckReturnValue
public java.lang.Object getValue()

The value of the field in this row/transaction

Returns:

The value

getRawValue

@CheckReturnValue
public java.lang.String getRawValue()

get the raw value

Returns:

the raw value

getRowId

@CheckReturnValue
public long getRowId()

The row id

Returns:

the row.

getFieldGid

@CheckReturnValue
public java.lang.String getFieldGid()

The row FieldGid

Returns:

the FieldGid.

getLanguageCd

@CheckReturnValue
public java.lang.String getLanguageCd()

The language_cd

Returns:

the language_cd.

getSeq

@CheckReturnValue
public int getSeq()

The Seq

Returns:

the seq.

getPreviousDisplayName

@Nonnull
 @CheckReturnValue
public java.lang.String getPreviousDisplayName(@Nonnull
                                                                           DataSource ds)

Parameters:

ds - the data source

Returns:

the previous display name

listChangedLanguages

@Nonnull
 @CheckReturnValue
public java.lang.String[] listChangedLanguages(@Nonnull
                                                                           DataSource ds)

List the languages that were changed in this transaction for this field.

Parameters:

ds - the data source

Returns:

The list of languages

getPreviousDisplayValue

@Nonnull
 @CheckReturnValue
public java.lang.String getPreviousDisplayValue(@Nonnull
                                                                            DataSource ds)

Parameters:

ds - the data source

Returns:

the previous display value

getCurrentDisplayName

@Nonnull
 @CheckReturnValue
public java.lang.String getCurrentDisplayName(@Nonnull
                                                                          DataSource ds)

Parameters:

ds - the data source

Returns:

the current display name

getCurrentLinkedValue

@Nonnull
 @CheckReturnValue
public java.lang.String getCurrentLinkedValue(@Nonnull
                                                                          DataSource ds,
                                                                          java.lang.String linkedFieldName)

Parameters:

ds - the data source

linkedFieldName - the linked field.

Returns:

the current display name

getCurrentDisplayValue

@Nonnull
 @CheckReturnValue
public java.lang.String getCurrentDisplayValue(@Nonnull
                                                                           DataSource ds)

Parameters:

ds - the data source

Returns:

the current display value

getlinkedUID

@CheckReturnValue
public long getlinkedUID()

Returns:

the linked row UID

getPreviousLinkedUID

@CheckReturnValue
public long getPreviousLinkedUID(@Nonnull
                                                   DataSource ds)

Parameters:

ds - the data source

Returns:

the previous linked row UID

getPreviousValue

@Nullable
 @CheckReturnValue
public java.lang.Object getPreviousValue(@Nonnull
                                                                      DataSource ds)

Parameters:

ds - the data source

Returns:

the previous value

getDBField

@Nullable
 @CheckReturnValue
public DBField getDBField()

The field that was changed

Returns:

The field