From 780b92ada9afcf1d58085a83a0b9e6bc982203d1 Mon Sep 17 00:00:00 2001 From: Lorry Tar Creator Date: Tue, 17 Feb 2015 17:25:57 +0000 Subject: Imported from /home/lorry/working-area/delta_berkeleydb/db-6.1.23.tar.gz. --- .../bind/serial/TupleSerialKeyCreator.html | 862 ++++++++++----------- 1 file changed, 428 insertions(+), 434 deletions(-) (limited to 'docs/java/com/sleepycat/bind/serial/TupleSerialKeyCreator.html') diff --git a/docs/java/com/sleepycat/bind/serial/TupleSerialKeyCreator.html b/docs/java/com/sleepycat/bind/serial/TupleSerialKeyCreator.html index f7378c36..26bea5df 100644 --- a/docs/java/com/sleepycat/bind/serial/TupleSerialKeyCreator.html +++ b/docs/java/com/sleepycat/bind/serial/TupleSerialKeyCreator.html @@ -1,322 +1,319 @@ - - - - - -TupleSerialKeyCreator (Oracle - Berkeley DB Java API) - - - - - - - - - - - - -
- - +//--> + + - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - -
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
-		 -Berkeley DB
version 5.3.21 -
- PREV CLASS  - NEXT CLASS - FRAMES   - NO FRAMES   -  - - - -
- SUMMARY: NESTED | FIELD | CONSTR | METHOD -DETAIL: FIELD | CONSTR | METHOD
- + + +
+ + +
+ + + - -
-

- -com.sleepycat.bind.serial -
-Class TupleSerialKeyCreator<D>

-
-java.lang.Object
-  extended by com.sleepycat.bind.tuple.TupleBase
-      extended by com.sleepycat.bind.serial.TupleSerialKeyCreator<D>
-
-
-
All Implemented Interfaces:
ForeignKeyNullifier, SecondaryKeyCreator
-
-
-
Direct Known Subclasses:
TupleSerialMarshalledKeyCreator
-
-
-
-
public abstract class TupleSerialKeyCreator<D>
extends TupleBase
implements SecondaryKeyCreator, ForeignKeyNullifier
- - -

-A abstract key creator that uses a tuple key and a serial data entry. This +

+
com.sleepycat.bind.serial
+

Class TupleSerialKeyCreator<D>

+
+
+ +
+
+
See Also:
Class Evolution
+ + +
+
+ +
+
+
+
+
Specified by:
+
createSecondaryKey in interface SecondaryKeyCreator
+
Parameters:
db - the database to which the secondary key will be added. This parameter is passed for informational purposes but is not commonly used. -

primaryKeyEntry - the primary key entry. This parameter must not be modified +

primaryKeyEntry - the primary key entry. This parameter must not be modified by this method. -

dataEntry - the primary data entry. This parameter must not be modified +

dataEntry - the primary data entry. This parameter must not be modified by this method. -

indexKeyEntry - the secondary key created by this method. -

-

Returns:
true if a key was created, or false to indicate that the key is +

indexKeyEntry - the secondary key created by this method. +

+
Returns:
true if a key was created, or false to indicate that the key is not present. -

- - -
- -

-nullifyForeignKey

-
-public boolean nullifyForeignKey(SecondaryDatabase db,
-                                 DatabaseEntry dataEntry)
-
-
Description copied from interface: ForeignKeyNullifier
-
Sets the foreign key reference to null in the datum of the primary - database. -

-

-
Specified by:
nullifyForeignKey in interface ForeignKeyNullifier
-
-
-
Parameters:
db - the database in which the foreign key integrity +

+ + + + + +
    +
  • +

    nullifyForeignKey

    +
    public boolean nullifyForeignKey(SecondaryDatabase db,
+                        DatabaseEntry dataEntry)
    +
    Description copied from interface: ForeignKeyNullifier
    +
    Sets the foreign key reference to null in the datum of the primary + database.
    +
    +
    Specified by:
    +
    nullifyForeignKey in interface ForeignKeyNullifier
    +
    Parameters:
    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 + 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. -
    Returns:
    true if the datum was modified, or false to indicate that the - key is not present.
    -
-
-
- -

-createSecondaryKey

-
-public abstract boolean createSecondaryKey(TupleInput primaryKeyInput,
-                                           D dataInput,
-                                           TupleOutput indexKeyOutput)
-
-
Creates the index key entry from primary key tuple entry and - deserialized data entry. -

-

-
-
-
-
Parameters:
primaryKeyInput - is the TupleInput for the primary key + this method if it returns true.
+
Returns:
true if the datum was modified, or false to indicate that the + key is not present.
+ + + + + + + +
    +
  • +

    createSecondaryKey

    +
    public abstract boolean createSecondaryKey(TupleInput primaryKeyInput,
+                         D dataInput,
+                         TupleOutput indexKeyOutput)
    +
    Creates the index key entry from primary key tuple entry and + deserialized data entry.
    +
    Parameters:
    primaryKeyInput - is the TupleInput for the primary key entry, or null if no primary key entry is used to construct the index - key.
    dataInput - is the deserialized data entry, or null if no data - entry is used to construct the index key.
    indexKeyOutput - is the destination index key tuple. For index + key.
    dataInput - is the deserialized data entry, or null if no data + entry is used to construct the index key.
    indexKeyOutput - is the destination index key tuple. For index keys which are optionally present, no tuple entry should be output to - indicate that the key is not present or null. -
    Returns:
    true if a key was created, or false to indicate that the key is - not present.
    -
-
-
- -

-nullifyForeignKey

-
-public D nullifyForeignKey(D data)
-
-
Clears the index key in the deserialized data entry. + indicate that the key is not present or null.
+
Returns:
true if a key was created, or false to indicate that the key is + not present.
+ + + + + + + + + + + + + + -
- - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - -
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
-		 -Berkeley DB
version 5.3.21 -
- PREV CLASS  - NEXT CLASS - FRAMES   - NO FRAMES   -  - - - -
- SUMMARY: NESTED | FIELD | CONSTR | METHOD -DETAIL: FIELD | CONSTR | METHOD
- + + +
+ + +
+ + + - -
-Copyright (c) 1996, 2012 Oracle and/or its affiliates. All rights reserved. - - +

Copyright (c) 1996, 2015 Oracle and/or its affiliates. All rights reserved.

+ + -- cgit v1.2.1