org.thales.punch.libraries.punchlang.resource.tuple

Interface IResourceTuple

All Known Implementing Classes:

ByteBufTuple, LazyInPlaceTuple, LazyTuple, PlainTuple

public interface IResourceTuple

An IResourceTuple a PUNCHLANG Tuple that expose the Tuple.get(String) method but internally contains an optimised implementation to accommodate for very large resources.

If we were to load very large CSV or JSON resource files into plain tuples, the nesting map structure of tuples entail a high memory consumption. Alternative is to use a lzay strategy, encode a more compact format and defer the transformation to real tuple only if there is a match.

This interface is used by the streaming resource loader to signal the loading of new values typically from a remote file so that the resource tuples can prepare to whatever their strategy is.

Author:

dimi

Method Summary

Modifier and Type	Method and Description
void	addKeyValue(String k, Tuple item) Set or reset a value in a resource tuple
Tuple	onEnd() This signal tells you the loading of a remote resource is now terminated.
default void	onStart() This signal is sent right before a new set of values will be uploaded.

Method Detail

onStart

default void onStart()

This signal is sent right before a new set of values will be uploaded.

addKeyValue

void addKeyValue(String k,
                 Tuple item)

Set or reset a value in a resource tuple

Parameters:

k -

item -

onEnd

Tuple onEnd()

This signal tells you the loading of a remote resource is now terminated. Do whatever you need to do to clean up your structures.

You must return the underlying Tuple resource object.

Returns:

the underlying resource tuple implementation