com.bigdata.bop.engine

Class LocalChunkMessage

java.lang.Object

com.bigdata.bop.engine.LocalChunkMessage

All Implemented Interfaces:

IChunkMessage<IBindingSet>, IOpMessage, Serializable

public class LocalChunkMessage
extends Object
implements IChunkMessage<IBindingSet>

A chunk of intermediate results which are ready to be consumed by some BOp in a specific query.

Note: This class is only used in query evaluation for the standalone database.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
LocalChunkMessage(IQueryClient queryController, UUID queryId, int bopId, int partitionId, IBindingSet bset)
LocalChunkMessage(IQueryClient queryController, UUID queryId, int bopId, int partitionId, IBindingSet[] bsets)
LocalChunkMessage(IQueryClient queryController, UUID queryId, int bopId, int partitionId, IBindingSet[][] bindingSetChunks) TODO There are a few unit tests which rely on the ability to push multiple chunks through the query engine, otherwise this could be changed to an IBindingSet[] by flattening the caller's IBindingSet[][] when given.

Method Summary

Methods

Modifier and Type	Method and Description
int	getBOpId() Return the operator identifier.
IChunkAccessor<IBindingSet>	getChunkAccessor() Return an interface which may be used to access the chunk's data.
int	getPartitionId() Return the index partition identifier.
IQueryClient	getQueryController() The proxy for the query controller.
UUID	getQueryControllerId() The UUID of the query controller (the IQueryClient to which the query was submitted).
UUID	getQueryId() Return the query identifier.
int	getSolutionCount() Return the #of solutions which are available from this message.
boolean	isLastInvocation() Return true iff the IChunkMessage is for the last evaluation pass of an operator.
boolean	isMaterialized() Return true if the chunk is materialized on the receiver.
void	materialize(FederatedRunningQuery runningQuery) Materialize the chunk on the receiver.
void	release() Release all resources associated with this chunk.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

LocalChunkMessage

public LocalChunkMessage(IQueryClient queryController,
                 UUID queryId,
                 int bopId,
                 int partitionId,
                 IBindingSet bset)

LocalChunkMessage

public LocalChunkMessage(IQueryClient queryController,
                 UUID queryId,
                 int bopId,
                 int partitionId,
                 IBindingSet[] bsets)

LocalChunkMessage

public LocalChunkMessage(IQueryClient queryController,
                 UUID queryId,
                 int bopId,
                 int partitionId,
                 IBindingSet[][] bindingSetChunks)

TODO There are a few unit tests which rely on the ability to push multiple chunks through the query engine, otherwise this could be changed to an IBindingSet[] by flattening the caller's IBindingSet[][] when given. Doing this could simplify some other things in the API since any chunk would just be an IBindingSet[].

See IChunkAccessor which has some notes concerning this and related matters. It might be useful to preserve the ability to have a message with multiple chunks, ie., to deal with data on different driect buffers.

See Also:

Optimize serialization for query messages on cluster

Method Detail

getQueryController

public IQueryClient getQueryController()

Description copied from interface: IChunkMessage

The proxy for the query controller.

Specified by:

getQueryController in interface IChunkMessage<IBindingSet>

See Also:

Optimize serialization for query messages on cluster, The query controller should be discoverable

getQueryControllerId

public UUID getQueryControllerId()

Description copied from interface: IChunkMessage

The UUID of the query controller (the IQueryClient to which the query was submitted).

Specified by:

getQueryControllerId in interface IChunkMessage<IBindingSet>

See Also:

https://sourceforge.net/apps/trac/bigdata/ticket/475

getQueryId

public UUID getQueryId()

Description copied from interface: IOpMessage

Return the query identifier.

Specified by:

getQueryId in interface IOpMessage

getBOpId

public int getBOpId()

Description copied from interface: IOpMessage

Return the operator identifier.

Specified by:

getBOpId in interface IOpMessage

getPartitionId

public int getPartitionId()

Description copied from interface: IOpMessage

Return the index partition identifier.

Specified by:

getPartitionId in interface IOpMessage

isLastInvocation

public boolean isLastInvocation()

Description copied from interface: IChunkMessage

Return true iff the IChunkMessage is for the last evaluation pass of an operator. The last evaluation pass for an operator must be requested using an annotation. When it is requested, the operator will be invoked one more time for each node or shard on which it was run (depending on the BOpEvaluationContext). When so invoked, the IChunkMessage will be associated with an empty source and this flag will be set.

Specified by:

isLastInvocation in interface IChunkMessage<IBindingSet>

See Also:

PipelineOp.Annotations#LAST_PASS

isMaterialized

public boolean isMaterialized()

Description copied from interface: IChunkMessage

Return true if the chunk is materialized on the receiver.

Specified by:

isMaterialized in interface IChunkMessage<IBindingSet>

getSolutionCount

public int getSolutionCount()

Description copied from interface: IChunkMessage

Return the #of solutions which are available from this message.

Specified by:

getSolutionCount in interface IChunkMessage<IBindingSet>

toString

public String toString()

Overrides:

toString in class Object

materialize

public void materialize(FederatedRunningQuery runningQuery)

Description copied from interface: IChunkMessage

Materialize the chunk on the receiver.

Specified by:

materialize in interface IChunkMessage<IBindingSet>

Parameters:

runningQuery - The running query.

release

public void release()

Description copied from interface: IChunkMessage

Release all resources associated with this chunk. If the source has been opened, then ensure that it is closed. If the data has been materialized, then discard the materialized data.

Specified by:

release in interface IChunkMessage<IBindingSet>

getChunkAccessor

public IChunkAccessor<IBindingSet> getChunkAccessor()

Description copied from interface: IChunkMessage

Return an interface which may be used to access the chunk's data.

Specified by:

getChunkAccessor in interface IChunkMessage<IBindingSet>