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/tuple/MarshalledTupleKeyEntity.html | 533 ++++++++++----------- 1 file changed, 261 insertions(+), 272 deletions(-) (limited to 'docs/java/com/sleepycat/bind/tuple/MarshalledTupleKeyEntity.html') diff --git a/docs/java/com/sleepycat/bind/tuple/MarshalledTupleKeyEntity.html b/docs/java/com/sleepycat/bind/tuple/MarshalledTupleKeyEntity.html index c657ea4a..d1ef159d 100644 --- a/docs/java/com/sleepycat/bind/tuple/MarshalledTupleKeyEntity.html +++ b/docs/java/com/sleepycat/bind/tuple/MarshalledTupleKeyEntity.html @@ -1,103 +1,96 @@ - - - - - -MarshalledTupleKeyEntity (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.tuple -
-Interface MarshalledTupleKeyEntity

-
-
-
public interface MarshalledTupleKeyEntity
- - -

-A marshalling interface implemented by entity classes that represent keys as +

+
com.sleepycat.bind.tuple
+

Interface MarshalledTupleKeyEntity

+
+
+
+
    +
  • +
    +
    +
    public interface MarshalledTupleKeyEntity
    +
    A marshalling interface implemented by entity classes that represent keys as tuples. Since MarshalledTupleKeyEntity objects are instantiated using Java deserialization, no particular constructor is required by classes that implement this interface. @@ -106,200 +99,196 @@ A marshalling interface implemented by entity classes that represent keys as than a non-marshalled key tuple extractor because more conversions are needed. A marshalled key extractor must convert the entry to an object in order to extract the key fields, while an unmarshalled key extractor does - not.

    -

    - -

    -

    -
    See Also:
    TupleTupleMarshalledBinding, -TupleSerialMarshalledBinding
    -
    - -

    - + not.

    +
    See Also:
    TupleTupleMarshalledBinding, +TupleSerialMarshalledBinding
    +
    • +
+
+
+
    +
  • - - - - - - - - - - - - - - - - - - - - - - -
    -Method Summary
    - voidmarshalPrimaryKey(TupleOutput keyOutput) - -
    -          Extracts the entity's primary key and writes it to the key output.
    - booleanmarshalSecondaryKey(String keyName, - TupleOutput keyOutput) - -
    -          Extracts the entity's secondary key and writes it to the key output.
    - booleannullifyForeignKey(String keyName) - -
    -          Clears the entity's secondary key fields for the given key name.
    - voidunmarshalPrimaryKey(TupleInput keyInput) - -
    -          Completes construction of the entity by setting its primary key from the - stored primary key.
    -  -

    - +

      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidmarshalPrimaryKey(TupleOutput keyOutput) +
      Extracts the entity's primary key and writes it to the key output.
      +
      booleanmarshalSecondaryKey(java.lang.String keyName, + TupleOutput keyOutput) +
      Extracts the entity's secondary key and writes it to the key output.
      +
      booleannullifyForeignKey(java.lang.String keyName) +
      Clears the entity's secondary key fields for the given key name.
      +
      voidunmarshalPrimaryKey(TupleInput keyInput) +
      Completes construction of the entity by setting its primary key from the + stored primary key.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • - - - - - - -
    -Method Detail
    - -

    -marshalPrimaryKey

    -
    -void marshalPrimaryKey(TupleOutput keyOutput)
    -
    -
    Extracts the entity's primary key and writes it to the key output. -

    -

    -
    Parameters:
    keyOutput - is the output tuple.
    -
    -
    -
    - -

    -unmarshalPrimaryKey

    -
    -void unmarshalPrimaryKey(TupleInput keyInput)
    -
    -
    Completes construction of the entity by setting its primary key from the - stored primary key. -

    -

    -
    Parameters:
    keyInput - is the input tuple.
    -
    -
    -
    - -

    -marshalSecondaryKey

    -
    -boolean marshalSecondaryKey(String keyName,
-                            TupleOutput keyOutput)
    -
    -
    Extracts the entity's secondary key and writes it to the key output. -

    -

    -
    Parameters:
    keyName - identifies the secondary key.
    keyOutput - is the output tuple. -
    Returns:
    true if a key was created, or false to indicate that the key is - not present.
    -
    -
    -
    - -

    -nullifyForeignKey

    -
    -boolean nullifyForeignKey(String keyName)
    -
    -
    Clears the entity's secondary key fields for the given key name. +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        marshalPrimaryKey

        +
        void marshalPrimaryKey(TupleOutput keyOutput)
        +
        Extracts the entity's primary key and writes it to the key output.
        +
        Parameters:
        keyOutput - is the output tuple.
        +
        • +
      + + + +
        +
      • +

        unmarshalPrimaryKey

        +
        void unmarshalPrimaryKey(TupleInput keyInput)
        +
        Completes construction of the entity by setting its primary key from the + stored primary key.
        +
        Parameters:
        keyInput - is the input tuple.
        +
        • +
      + + + +
        +
      • +

        marshalSecondaryKey

        +
        boolean marshalSecondaryKey(java.lang.String keyName,
+                          TupleOutput keyOutput)
        +
        Extracts the entity's secondary key and writes it to the key output.
        +
        Parameters:
        keyName - identifies the secondary key.
        keyOutput - is the output tuple.
        +
        Returns:
        true if a key was created, or false to indicate that the key is + not present.
        +
        • +
      + + + +
    + false.

+
Parameters:
keyName - identifies the secondary key.
+
Returns:
true if the key was cleared, or false to indicate that the key + is not present and no change is necessary.
+ + + + + + +
+ -
- - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - -
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