Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
 /*-
  * See the file LICENSE for redistribution information.
  *
  * Copyright (c) 2000, 2010 Oracle and/or its affiliates.  All rights reserved.
  *
  */
 
 package com.sleepycat.bind.tuple;

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.

Note that a marshalled tuple key extractor is somewhat less efficient 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.

public interface MarshalledTupleKeyEntity {

    
Extracts the entity's primary key and writes it to the key output.

Parameters:
keyOutput is the output tuple.
    void marshalPrimaryKey(TupleOutput keyOutput);

    
Completes construction of the entity by setting its primary key from the stored primary key.

Parameters:
keyInput is the input tuple.
    void unmarshalPrimaryKey(TupleInput keyInput);

    
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.
    boolean marshalSecondaryKey(String keyNameTupleOutput keyOutput);

    
Clears the entity's secondary key fields for the given key name.

The specified index key should be changed by this method such that marshalSecondaryKey(java.lang.String,com.sleepycat.bind.tuple.TupleOutput) for the same key name will return false. Other fields in the data object should remain unchanged.

If com.sleepycat.je.ForeignKeyDeleteAction.NULLIFY was specified when opening the secondary database, 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.

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.
    boolean nullifyForeignKey(String keyName);
New to GrepCode? Check out our FAQ X