DbPreferencesKey (Tentackle Persistence 2.0.7 API)

java.lang.Object
- org.tentackle.persist.AbstractDbObject<DbPreferencesKey>
- - org.tentackle.persist.DbPreferencesKey

All Implemented Interfaces:

Serializable, Cloneable, Comparable<DbPreferencesKey>, Identifiable, Immutable, SerialNumbered, SessionDependable, SessionProvider
```
@ClassId(value=4)
 @TableName(value="prefkey")
public class DbPreferencesKey
extends AbstractDbObject<DbPreferencesKey>
```
A preferences key/value pair stored in the database.

Author:

harald

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CN_KEY` database column name for 'key'.
`static String`	`CN_NODEID` database column name for 'nodeId'.
`static String`	`CN_VALUE` database column name for 'value'.
`static String`	`TABLENAME` the database tablename.

Fields inherited from class org.tentackle.persist.AbstractDbObject
AN_CLASSID, AN_ID, AN_SERIAL, AN_TABLESERIAL, CN_CLASSID, CN_ID, CN_SERIAL, CN_TABLESERIAL, idComparator, nameComparator, nameIdComparator, preparePending, TX_DELETE_LIST, TX_DELETE_MISSING_IN_LIST, TX_DELETE_OBJECT, TX_DUMMY_UPDATE, TX_INSERT_OBJECT, TX_INSERT_PLAIN, TX_SAVE, TX_SAVE_LIST, TX_SYNC, TX_UPDATE_OBJECT, TX_UPDATE_PLAIN, TX_UPDATE_SERIAL, TX_UPDATE_SERIAL_AND_TABLESERIAL, TX_UPDATE_TABLESERIAL

Constructor Summary

Constructors
Constructor and Description

DbPreferencesKey()
Creates a preferences key (without db connection).

DbPreferencesKey(Db db)
Creates a preferences key.

Constructors
Constructor and Description
`DbPreferencesKey()` Creates a preferences key (without db connection).
`DbPreferencesKey(Db db)` Creates a preferences key.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`createInsertSql()` Creates the SQL code for the insert statement.
`String`	`createUpdateSql()` Creates the SQL code for the update statement.
`int`	`deleteByNodeId(long nodeId)` Deletes all keys for a node.
`DbObjectClassVariables<DbPreferencesKey>`	`getClassVariables()` Gets the some attributes and variables common to all objects of the same class.
`void`	`getFields(ResultSetWrapper rs)` Retrieves the values of all fields.
`String`	`getKey()` Gets the attribute key.
`DbPreferencesNode`	`getLazyNode()`
`long`	`getNodeId()` Gets the attribute nodeId.
`String`	`getValue()` Gets the attribute value.
`boolean`	`isCountingModification(char modType)` Determines whether modifications of this object are counted in the modification table. Counting is also turned on if the PDO provides a tableserial.
`boolean`	`isTableSerialProvided()` Object provides the tableserial.
`boolean`	`isTracked()` Overridden cause of "--tracked".
`void`	`prepareSetFields()` Prepares the object's attributes before the object is saved to the database. The default implementation does nothing.
`List<DbPreferencesKey>`	`selectByNodeId(long nodeId)` Gets all keys belonging to a node.
`DbPreferencesKey`	`selectByNodeIdKey(long nodeId, String key)` Get a preferences key by nodeid and key name.
`int`	`setFields(PreparedStatementWrapper st)` Sets the values of all fields (all columns of the database table) in the given `PreparedStatementWrapper` from the object's attributes.
`void`	`setKey(String key)` Sets the attribute key.
`void`	`setLazyNode(DbPreferencesNode node)` sets the "lazy" parent, i.e.
`void`	`setNodeId(long nodeId)` Sets the attribute nodeId.
`void`	`setValue(String value)` Sets the attribute value.
`String`	`toString()` Gets the default string value. The default implementation invokes `AbstractDbObject.toGenericString()`.

Methods inherited from class org.tentackle.persist.AbstractDbObject
acceptPersistenceVisitor, addPropertyChangeListener, addPropertyChangeListener, assertMutable, assertNotNew, assertNotOverloaded, assertNotRemote, assertNumberOfRowsAffected, assertPersistable, assertRemote, assertThisRowAffected, attributesModified, beginTx, clearOnRemoteSave, clone, compareTo, copyToDb, countModification, createAttributesInSnapshot, createDeleteAllSql, createDeleteSql, createDummyUpdateSql, createModificationLog, createPreparedStatement, createPreparedStatement, createSelectAllByIdInnerSql, createSelectAllIdSerialInnerSql, createSelectAllInnerSql, createSelectExpiredTableSerials1Sql, createSelectExpiredTableSerials2Sql, createSelectIdInnerSql, createSelectMaxIdSql, createSelectMaxTableSerialSql, createSelectSerialSql, createSelectSql, createSqlUpdate, createUpdateSerialAndTableSerialSql, createUpdateSerialSql, deleteImpl, deleteObject, deletePlain, deleteReferencedRelations, deleteReferencingRelations, differsPersisted, dummyUpdate, equals, finishModification, finishNotUpdated, firePropertyChange, getBackend, getClassBaseName, getClassId, getColumnCount, getExpirationBacklog, getExpiredTableSerials, getId, getIdSource, getImmutableLoggingLevel, getModificationCount, getModificationLog, getPreparedStatement, getPreparedStatement, getPropertyChangeListeners, getPropertyChangeListeners, getRemoteDelegate, getSerial, getSession, getSessionHolder, getTableName, getTableSerial, hashCode, initModification, insertImpl, insertObject, insertPlain, isDeleted, isEntity, isIdValid, isImmutable, isLoggingModification, isModified, isNew, isOverloadable, isPersistable, isReferenced, isRemovable, isSessionImmutable, isStatementAlwaysPrepared, isUpdateNecessary, isUpdatingSerialEvenIfNotModified, isVirgin, loadLazyReferences, logModification, markDeleted, newId, newInstance, newInstance, newInstance, persistObject, prepareDelete, prepareSave, readFromResultSetWrapper, reloadLockedObject, reloadObject, removeAllPropertyChangeListeners, removePropertyChangeListener, removePropertyChangeListener, reserveId, resultAllIdSerial, resultAllObjects, revertAttributesToSnapshot, saveObject, saveReferencedRelations, saveReferencingRelations, selectAllIdSerial, selectAllObjects, selectExpiredTableSerials, selectExpiredTableSerials, selectLockedObject, selectMaxId, selectMaxTableSerial, selectNextObject, selectObject, selectSerial, setClassId, setId, setImmutable, setImmutableLoggingLevel, setModificationLog, setModified, setOverloadable, setSerial, setSession, setSessionHolder, setSessionImmutable, setStatementAlwaysPrepared, setTableSerial, toGenericString, toIdString, unmarkDeleted, updateImpl, updateObject, updatePlain, updateSerial, updateSerialAndTableSerial

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

- Field Detail
  - TABLENAME
```
public static final String TABLENAME
```
    the database tablename.
    
    See Also:
    
    Constant Field Values
  - CN_NODEID
```
public static final String CN_NODEID
```
    database column name for 'nodeId'.
    
    See Also:
    
    Constant Field Values
  - CN_KEY
```
public static final String CN_KEY
```
    database column name for 'key'.
    
    See Also:
    
    Constant Field Values
  - CN_VALUE
```
public static final String CN_VALUE
```
    database column name for 'value'.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - DbPreferencesKey
```
public DbPreferencesKey(Db db)
```
    Creates a preferences key.
    
    Parameters:
    
    db - the db connection
  - DbPreferencesKey
```
public DbPreferencesKey()
```
    Creates a preferences key (without db connection).
- Method Detail
  - toString
```
public String toString()
```
    Description copied from class: AbstractDbObject
    
    Gets the default string value.
    The default implementation invokes AbstractDbObject.toGenericString().
    
    Overrides:
    
    toString in class AbstractDbObject<DbPreferencesKey>
    
    Returns:
    
    the string value of this AbstractDbObject
  - isCountingModification
```
public boolean isCountingModification(char modType)
```
    Description copied from class: AbstractDbObject
    
    Determines whether modifications of this object are counted in the modification table.
    Counting is also turned on if the PDO provides a tableserial.
    
    Overrides:
    
    isCountingModification in class AbstractDbObject<DbPreferencesKey>
    
    Parameters:
    
    modType - is one of the modtypes INSERT, UPDATE, DELETE, ...
    
    Returns:
    
    true if count modification, false if not.
  - setLazyNode
```
public void setLazyNode(DbPreferencesNode node)
```
    sets the "lazy" parent, i.e. a new parent without an ID.
    
    Parameters:
    
    node - the parent node, null if none.
  - getLazyNode
```
public DbPreferencesNode getLazyNode()
```
    Returns:
    
    the lazy parent, if any
  - prepareSetFields
```
public void prepareSetFields()
```
    Prepares the object's attributes before the object is saved to the database.
    The default implementation does nothing. Used to setup, check and align values.
    Overridden to set the parent id if lazy parent set and has no id
    
    Overrides:
    
    prepareSetFields in class AbstractDbObject<DbPreferencesKey>
  - getClassVariables
```
public DbObjectClassVariables<DbPreferencesKey> getClassVariables()
```
    Description copied from class: AbstractDbObject
    
    Gets the some attributes and variables common to all objects of the same class. Class variables for classes derived from AbstractDbObject are kept in an instance of DbObjectClassVariables.
    
    Overrides:
    
    getClassVariables in class AbstractDbObject<DbPreferencesKey>
    
    Returns:
    
    the class variables
  - selectByNodeId
```
public List<DbPreferencesKey> selectByNodeId(long nodeId)
```
    Gets all keys belonging to a node.
    
    Parameters:
    
    nodeId - the node's ID
    
    Returns:
    
    List of keys
    
    Wurblet:
    
    selectByNodeId DbSelectList --model=$mapfile nodeId
  - selectByNodeIdKey
```
public DbPreferencesKey selectByNodeIdKey(long nodeId,
                                          String key)
```
    Get a preferences key by nodeid and key name.
    
    Parameters:
    
    nodeId - the node ID
    
    key - the key name
    
    Returns:
    
    the preferences key, null if not found
    
    Wurblet:
    
    selectByNodeIdKey DbSelectUnique --model=$mapfile nodeId key
  - deleteByNodeId
```
public int deleteByNodeId(long nodeId)
```
    Deletes all keys for a node.
    
    Parameters:
    
    nodeId - the node's ID
    
    Returns:
    
    the number of keys deleted
    
    Wurblet:
    
    deleteByNodeId DbDeleteBy --model=$mapfile nodeId
  - isTableSerialProvided
```
public boolean isTableSerialProvided()
```
    Object provides the tableserial.
    
    Overrides:
    
    isTableSerialProvided in class AbstractDbObject<DbPreferencesKey>
    
    Returns:
    
    true
  - isTracked
```
public boolean isTracked()
```
    Overridden cause of "--tracked".
    
    Overrides:
    
    isTracked in class AbstractDbObject<DbPreferencesKey>
    
    Returns:
    
    true = setters check for modification
  - getFields
```
public void getFields(ResultSetWrapper rs)
```
    Description copied from class: AbstractDbObject
    
    Retrieves the values of all fields.
    
    Overrides:
    
    getFields in class AbstractDbObject<DbPreferencesKey>
    
    Parameters:
    
    rs - the result set
  - setFields
```
public int setFields(PreparedStatementWrapper st)
```
    Description copied from class: AbstractDbObject
    
    Sets the values of all fields (all columns of the database table) in the given PreparedStatementWrapper from the object's attributes.
    
    Overrides:
    
    setFields in class AbstractDbObject<DbPreferencesKey>
    
    Parameters:
    
    st - the statement
    
    Returns:
    
    the number of fields set
  - createInsertSql
```
public String createInsertSql()
```
    Description copied from class: AbstractDbObject
    
    Creates the SQL code for the insert statement.
    
    Overrides:
    
    createInsertSql in class AbstractDbObject<DbPreferencesKey>
    
    Returns:
    
    the SQL code
  - createUpdateSql
```
public String createUpdateSql()
```
    Description copied from class: AbstractDbObject
    
    Creates the SQL code for the update statement.
    
    Overrides:
    
    createUpdateSql in class AbstractDbObject<DbPreferencesKey>
    
    Returns:
    
    the SQL code
  - getNodeId
```
public long getNodeId()
```
    Gets the attribute nodeId.
    
    Returns:
    
    ID of the preferences node
  - setNodeId
```
public void setNodeId(long nodeId)
```
    Sets the attribute nodeId.
    
    Parameters:
    
    nodeId - ID of the preferences node
  - getKey
```
public String getKey()
```
    Gets the attribute key.
    
    Returns:
    
    name of the key
  - setKey
```
public void setKey(String key)
```
    Sets the attribute key.
    
    Parameters:
    
    key - name of the key
  - getValue
```
public String getValue()
```
    Gets the attribute value.
    
    Returns:
    
    value of the key
  - setValue
```
public void setValue(String value)
```
    Sets the attribute value.
    
    Parameters:
    
    value - value of the key

Class DbPreferencesKey

Field Summary

Fields inherited from class org.tentackle.persist.AbstractDbObject

Constructor Summary

Method Summary

Methods inherited from class org.tentackle.persist.AbstractDbObject

Methods inherited from class java.lang.Object

Field Detail

TABLENAME

CN_NODEID

CN_KEY

CN_VALUE

Constructor Detail

DbPreferencesKey

DbPreferencesKey

Method Detail

toString

isCountingModification

setLazyNode

getLazyNode

prepareSetFields

getClassVariables

selectByNodeId

selectByNodeIdKey

deleteByNodeId

isTableSerialProvided

isTracked

getFields

setFields

createInsertSql

createUpdateSql

getNodeId

setNodeId

getKey

setKey

getValue

setValue