DbPreferencesNode (Tentackle Persistence 2.0.6 API)

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

All Implemented Interfaces:

Serializable, Cloneable, Comparable<DbPreferencesNode>, Identifiable, Immutable, SerialNumbered, SessionDependable, SessionProvider
```
@ClassId(value=3)
 @TableName(value="prefnode")
public class DbPreferencesNode
extends AbstractDbObject<DbPreferencesNode>
```
Preferences Node stored in the database.

Author:

harald

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CN_NAME` database column name for 'name'.
`static String`	`CN_PARENTID` database column name for 'parentId'.
`static String`	`CN_USER` database column name for 'user'.
`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

DbPreferencesNode()
Creates a node (without db).

DbPreferencesNode(Db db)
Creates a node.

Constructors
Constructor and Description
`DbPreferencesNode()` Creates a node (without db).
`DbPreferencesNode(Db db)` Creates a node.

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.
`String`	`getBaseName()` Gets the basename of the node.
`DbObjectClassVariables<DbPreferencesNode>`	`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`	`getName()` Gets the attribute name.
`long`	`getParentId()` Gets the attribute parentId.
`String`	`getUser()` Gets the attribute user.
`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.
`List<DbPreferencesNode>`	`selectByParentId(long parentId)` Gets all nodes belonging to a parent node.
`DbPreferencesNode`	`selectByUserAndName(String user, String name)` Selects a node by user and name.
`Set<Long>`	`selectChildIds()` Selects the object IDs of all childs nodes.
`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`	`setName(String name)` Sets the attribute name.
`void`	`setParentId(long parentId)` Sets the attribute parentId.
`void`	`setUser(String user)` Sets the attribute user.
`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, createDeleteAllSql, createDeleteSql, createDummyUpdateSql, createModificationLog, createPreparedStatement, createPreparedStatement, createSelectAllByIdInnerSql, createSelectAllIdSerialInnerSql, createSelectAllInnerSql, createSelectExpiredTableSerials1Sql, createSelectExpiredTableSerials2Sql, createSelectIdInnerSql, createSelectMaxIdSql, createSelectMaxTableSerialSql, createSelectSerialSql, createSelectSql, createSqlUpdate, createUpdateSerialAndTableSerialSql, createUpdateSerialSql, deleteImpl, deleteObject, deletePlain, deleteReferencedRelations, deleteReferencingRelations, 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, isTracked, isUpdateNecessary, isUpdatingSerialEvenIfNotModified, isVirgin, loadLazyReferences, logModification, markDeleted, newId, newInstance, newInstance, newInstance, persistObject, prepareDelete, prepareSave, prepareSetFields, 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_USER
```
public static final String CN_USER
```
    database column name for 'user'.
    
    See Also:
    
    Constant Field Values
  - CN_NAME
```
public static final String CN_NAME
```
    database column name for 'name'.
    
    See Also:
    
    Constant Field Values
  - CN_PARENTID
```
public static final String CN_PARENTID
```
    database column name for 'parentId'.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - DbPreferencesNode
```
public DbPreferencesNode(Db db)
```
    Creates a node.
    
    Parameters:
    
    db - the db connection
  - DbPreferencesNode
```
public DbPreferencesNode()
```
    Creates a node (without db).
- Method Detail
  - 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<DbPreferencesNode>
    
    Parameters:
    
    modType - is one of the modtypes INSERT, UPDATE, DELETE, ...
    
    Returns:
    
    true if count modification, false if not.
  - getClassVariables
```
public DbObjectClassVariables<DbPreferencesNode> 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<DbPreferencesNode>
    
    Returns:
    
    the class variables
  - selectByParentId
```
public List<DbPreferencesNode> selectByParentId(long parentId)
```
    Gets all nodes belonging to a parent node.
    
    Parameters:
    
    parentId - the ID of the parent node, 0 = rootnode
    
    Returns:
    
    List of nodes
    
    Wurblet:
    
    selectByParentId DbSelectList --model=$mapfile parentId
  - selectChildIds
```
public Set<Long> selectChildIds()
```
    Selects the object IDs of all childs nodes.
    
    Returns:
    
    the IDs
  - selectByUserAndName
```
public DbPreferencesNode selectByUserAndName(String user,
                                             String name)
```
    Selects a node by user and name.
    
    Parameters:
    
    user - is the username, null = system
    
    name - is the absolute pathname of the node, ""=root
    
    Returns:
    
    the node
    
    Wurblet:
    
    selectByUserAndName DbSelectUnique --model=$mapfile user name
  - isTableSerialProvided
```
public boolean isTableSerialProvided()
```
    Object provides the tableserial.
    
    Overrides:
    
    isTableSerialProvided in class AbstractDbObject<DbPreferencesNode>
    
    Returns:
    
    true
  - getFields
```
public void getFields(ResultSetWrapper rs)
```
    Description copied from class: AbstractDbObject
    
    Retrieves the values of all fields.
    
    Overrides:
    
    getFields in class AbstractDbObject<DbPreferencesNode>
    
    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<DbPreferencesNode>
    
    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<DbPreferencesNode>
    
    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<DbPreferencesNode>
    
    Returns:
    
    the SQL code
  - getUser
```
public String getUser()
```
    Gets the attribute user.
    
    Returns:
    
    name of user, null if system
  - setUser
```
public void setUser(String user)
```
    Sets the attribute user.
    
    Parameters:
    
    user - name of user, null if system
  - getName
```
public String getName()
```
    Gets the attribute name.
    
    Returns:
    
    name of the node
  - setName
```
public void setName(String name)
```
    Sets the attribute name.
    
    Parameters:
    
    name - name of the node
  - getParentId
```
public long getParentId()
```
    Gets the attribute parentId.
    
    Returns:
    
    ID of parent node, 0 if rootnode
  - setParentId
```
public void setParentId(long parentId)
```
    Sets the attribute parentId.
    
    Parameters:
    
    parentId - ID of parent node, 0 if rootnode
  - getBaseName
```
public String getBaseName()
```
    Gets the basename of the node.
    
    Returns:
    
    the node's basename
  - 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<DbPreferencesNode>
    
    Returns:
    
    the string value of this AbstractDbObject

Class DbPreferencesNode

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_USER

CN_NAME

CN_PARENTID

Constructor Detail

DbPreferencesNode

DbPreferencesNode

Method Detail

isCountingModification

getClassVariables

selectByParentId

selectChildIds

selectByUserAndName

isTableSerialProvided

getFields

setFields

createInsertSql

createUpdateSql

getUser

setUser

getName

setName

getParentId

setParentId

getBaseName

toString