org.apache.derby.iapi.services.property
Interface PersistentSet

All Known Subinterfaces:
TransactionController, TransactionManager, XATransactionController
All Known Implementing Classes:
RAMTransaction

public interface PersistentSet


Method Summary
 java.util.Properties getProperties()
          Get properties that can be stored in a java.util.Properties object.
 java.io.Serializable getProperty(java.lang.String key)
          Gets a value for a stored property.
 java.io.Serializable getPropertyDefault(java.lang.String key)
          Gets a default value for a stored property.
 boolean propertyDefaultIsVisible(java.lang.String key)
          Return true if the default property is visible.
 void setProperty(java.lang.String key, java.io.Serializable value, boolean dbOnlyProperty)
          Sets the Serializable object associated with a property key.
 void setPropertyDefault(java.lang.String key, java.io.Serializable value)
          Sets the Serializable object default value associated with a property key.
 

Method Detail

getProperty

java.io.Serializable getProperty(java.lang.String key)
                                 throws StandardException
Gets a value for a stored property. The returned value will be:
  1. the de-serialized object associated with the key using setProperty if such a value is defined or
  2. the default de-serialized object associated with the key using setPropertyDefault if such a value is defined or
  3. null

The Store provides a transaction protected list of database properties. Higher levels of the system can store and retrieve these properties once Recovery has finished. Each property is a serializable object and is stored/retrieved using a String key.

Parameters:
key - The "key" of the property that is being requested.
Returns:
object The requested object or null.
Throws:
StandardException - Standard exception policy.

getPropertyDefault

java.io.Serializable getPropertyDefault(java.lang.String key)
                                        throws StandardException
Gets a default value for a stored property. The returned value will be:
  1. the default de-serialized object associated with the key using setPropertyDefault if such a value is defined or
  2. null

The Store provides a transaction protected list of database properties. Higher levels of the system can store and retrieve these properties once Recovery has finished. Each property is a serializable object and is stored/retrieved using a String key.

Parameters:
key - The "key" of the property that is being requested.
Returns:
object The requested object or null.
Throws:
StandardException - Standard exception policy.

propertyDefaultIsVisible

boolean propertyDefaultIsVisible(java.lang.String key)
                                 throws StandardException
Return true if the default property is visible. A default is visible as long as the property is not set.

Parameters:
key - The "key" of the property that is being requested.
Throws:
StandardException - Standard exception policy.

setProperty

void setProperty(java.lang.String key,
                 java.io.Serializable value,
                 boolean dbOnlyProperty)
                 throws StandardException
Sets the Serializable object associated with a property key.

See the discussion of getProperty().

The value stored may be a Formatable object or a Serializable object whose class name starts with java.*. This stops arbitary objects being stored in the database by class name, which will cause problems in obfuscated/non-obfuscated systems.

Parameters:
key - The key used to lookup this property.
value - The value to be associated with this key. If null, delete the property from the properties list.
dbOnlyProperty - True if property is only ever searched for int the database properties.
Throws:
StandardException - Standard exception policy.

setPropertyDefault

void setPropertyDefault(java.lang.String key,
                        java.io.Serializable value)
                        throws StandardException
Sets the Serializable object default value associated with a property key.

See the discussion of getProperty().

The value stored may be a Formatable object or a Serializable object whose class name starts with java.*. This stops arbitary objects being stored in the database by class name, which will cause problems in obfuscated/non-obfuscated systems.

Parameters:
key - The key used to lookup this propertyDefault.
value - The default value to be associated with this key. If null, delete the property default from the properties list.
Throws:
StandardException - Standard exception policy.

getProperties

java.util.Properties getProperties()
                                   throws StandardException
Get properties that can be stored in a java.util.Properties object.

Get the sub-set of stored properties that can be stored in a java.util.Properties object. That is all the properties that have a value of type java.lang.String. Changes to this properties object are not reflected in any persisent storage.

Code must use the setProperty() method call.

Returns:
The sub-set of stored properties that can be stored in a java.util.Propertes object.
Throws:
StandardException - Standard exception policy.

Built on Thu 2011-03-10 11:54:14+0000, from revision ???

Apache Derby V10.6 Internals - Copyright © 2004,2007 The Apache Software Foundation. All Rights Reserved.