public abstract class TupleTupleKeyCreator<E> extends TupleBase<E> implements SecondaryKeyCreator, ForeignKeyNullifier
TupleOutputobjects. The following abstract method must be implemented by a concrete subclass to create the index key using these objects
specified when opening the secondary database, the following method must be
overridden to nullify the foreign index key. If NULLIFY was not specified,
this method need not be overridden.
specified when creating the secondary, this method is called when the
entity for this foreign key is deleted. If NULLIFY was not specified,
this method will not be called and may always return false.
|Constructor and Description|
Creates a tuple-tuple key creator.
|Modifier and Type||Method and Description|
Creates a secondary key entry, given a primary key and data entry.
Creates the index key from primary key tuple and data tuple.
Sets the foreign key reference to null in the datum of the primary database.
Clears the index key in the tuple data entry.
entryToInput, getTupleBufferSize, getTupleOutput, inputToEntry, newOutput, newOutput, outputToEntry, setTupleBufferSize
public boolean createSecondaryKey(SecondaryDatabase db, DatabaseEntry primaryKeyEntry, DatabaseEntry dataEntry, DatabaseEntry indexKeyEntry)
A secondary key may be derived from the primary key, primary data, or a combination of the primary key and data. For secondary keys that are optional, the key creator method may return false and the key/data pair will not be indexed. To ensure the integrity of a secondary database the key creator method must always return the same result for a given set of input parameters.
RuntimeException may be thrown by this method if an error
occurs attempting to create the secondary key. This exception will be
thrown by the API method currently in progress, for example, a
put method. However, this will cause the write operation
to be incomplete. When databases are not configured to be
transactional, caution should be used to avoid integrity problems. See
Special considerations for
using Secondary Databases with and without Transactions.
db- the database to which the secondary key will be added. This parameter is passed for informational purposes but is not commonly used. This parameter is always non-null.
primaryKeyEntry- the primary key entry. This parameter must not be modified by this method. This parameter is always non-null.
dataEntry- the primary data entry. This parameter must not be modified by this method. If
SecondaryConfig#setExtractFromPrimaryKeyOnlyis configured as
dataparam may be either null or non-null, and the implementation is expected to ignore it; otherwise, this parameter is always non-null.
indexKeyEntry- the secondary key created by this method. This parameter is always non-null.
public boolean nullifyForeignKey(SecondaryDatabase db, DatabaseEntry dataEntry)
db- the database in which the foreign key integrity constraint is defined. This parameter is passed for informational purposes but is not commonly used.
dataEntry- the existing primary datum in which the foreign key reference should be set to null. This parameter should be updated by this method if it returns true.
public abstract boolean createSecondaryKey(TupleInput primaryKeyInput, TupleInput dataInput, TupleOutput indexKeyOutput)
public boolean nullifyForeignKey(TupleInput dataInput, TupleOutput dataOutput)
The secondary key should be output or removed by this method such
createSecondaryKey(com.sleepycat.je.SecondaryDatabase, com.sleepycat.je.DatabaseEntry, com.sleepycat.je.DatabaseEntry, com.sleepycat.je.DatabaseEntry) will return false. Other fields in the
data object should remain unchanged.
Copyright (c) 2004, 2014 Oracle and/or its affiliates. All rights reserved.