org.treetank.api.IData Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of core Show documentation

Core module containing all storage functionality.

The newest version!

/**
 * 
 */
package org.treetank.api;

import java.io.DataOutput;

import org.treetank.exception.TTIOException;

import com.google.common.hash.Funnel;

/**
 * Overall {@link IData}-Interface for the interaction with the bucket-layer. All
 * persistence functionality must be handled over this interface while all
 * data-layers interfaces inherit from this interface.
 * 
 * @author Sebastian Graf, University of Konstanz
 * 
 */
public interface IData {

    /**
     * Serializing to given dataput
     * 
     * @param pOutput
     *            to serialize to
     * @throws TTIOException
     */
    void serialize(final DataOutput pOutput) throws TTIOException;

    /**
     * Gets unique {@link IData} key.
     * This key should be set over the IBucketWriteTrx.incrementDataKey for getting the correct
     * offset
     * within retrievals.
     * 
     * @return datakey
     */
    long getDataKey();

    /**
     * Getting a Funnel for computing guava-based hashes.
     * 
     * @return a Funnel for this {@link IData}
     */
    Funnel getFunnel();

}