be.SIRAPRISE.typeimplementations

Class RelationBuffer

java.lang.Object

be.SIRAPRISE.typeimplementations.ValueBuffer

be.SIRAPRISE.typeimplementations.NonScalarValueBuffer

be.SIRAPRISE.typeimplementations.TupleCollectionBuffer

be.SIRAPRISE.typeimplementations.RelationBuffer

public final class RelationBuffer
extends TupleCollectionBuffer

A RelationBuffer is the ValueBuffer type for relation values.

Author:

Erwin Smout

Field Summary

Fields inherited from class be.SIRAPRISE.typeimplementations.TupleCollectionBuffer

TUPLEMARK

Constructor Summary

Constructors

Constructor and Description
RelationBuffer(java.util.Collection<TupleBuffer> tupleBuffers) Creates the RelationBuffer
RelationBuffer(java.util.Collection<TupleBuffer> tupleBuffers, boolean setReferenceLocal) Creates the RelationBuffer
RelationBuffer(Heading heading, java.nio.ByteBuffer attributeValueEncoding) Creates the RelationBuffer
RelationBuffer(java.util.Set<TupleBuffer> tupleBuffers) Creates the buffer and sets its value
RelationBuffer(java.util.Set<TupleBuffer> tupleBuffers, boolean setReferenceLocal) Creates the buffer and sets its value

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
boolean	equalsRelationBuffer(RelationBuffer obj) Compares this RelationBuffer with another one for equality.
static java.util.Set<TupleBuffer>	fromStream1_0(Heading heading, java.io.DataInputStream in)
MyReadOnlyCollection<TupleBuffer>	getTupleBufferCollection() Gets the collection of tuple buffers
MyReadOnlySet<TupleBuffer>	getTupleBufferSet() Gets the relation value
int	hashCode()
static void	toStream1_0(java.util.Collection<TupleBuffer> tupleBufferCollection, Heading heading, java.io.DataOutputStream outputStream) Writes the given tuple buffer collection to the given Stream
java.lang.String	toString()

Methods inherited from class be.SIRAPRISE.typeimplementations.TupleCollectionBuffer

getByteBuffer

Methods inherited from class be.SIRAPRISE.typeimplementations.ValueBuffer

intern

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RelationBuffer

public RelationBuffer(java.util.Collection<TupleBuffer> tupleBuffers)

Creates the RelationBuffer

Parameters:

tupleBuffers - The collection of tupleBuffers that should be part of the relation value

RelationBuffer

public RelationBuffer(java.util.Collection<TupleBuffer> tupleBuffers,
                      boolean setReferenceLocal)

Creates the RelationBuffer

Parameters:

tupleBuffers - The collection of tupleBuffers that should be part of the relation value

setReferenceLocal - can be set to true if the caller guarantees that the tupleBuffers are local to the caller, and no reference to it will be left dangling in any other part of the system.

RelationBuffer

public RelationBuffer(Heading heading,
                      java.nio.ByteBuffer attributeValueEncoding)

Creates the RelationBuffer

Parameters:

heading - the nonscalar type definition that the relation value encoding is known to conform to

attributeValueEncoding - the internal encoding of a relation value

RelationBuffer

public RelationBuffer(java.util.Set<TupleBuffer> tupleBuffers)

Creates the buffer and sets its value

Parameters:

tupleBuffers - The value to be held in this buffer

RelationBuffer

public RelationBuffer(java.util.Set<TupleBuffer> tupleBuffers,
                      boolean setReferenceLocal)

Creates the buffer and sets its value

Parameters:

tupleBuffers - The value to be held in this buffer

setReferenceLocal - can be set to true if the caller guarantees that the tupleBuffers are local to the caller, and no reference to it will be left dangling in any other part of the system.

Method Detail

fromStream1_0

public static java.util.Set<TupleBuffer> fromStream1_0(Heading heading,
                                                       java.io.DataInputStream in)
                                                throws java.io.IOException

Parameters:

heading - The heading that the collection of tuples is supposed to conform to

in - the stream to read

Returns:

The set of tuple buffers encoded in the given stream according to the 1_0 format

Throws:

java.io.IOException - If an IO exception occurs

toStream1_0

public static void toStream1_0(java.util.Collection<TupleBuffer> tupleBufferCollection,
                               Heading heading,
                               java.io.DataOutputStream outputStream)
                        throws java.io.IOException

Writes the given tuple buffer collection to the given Stream

Parameters:

tupleBufferCollection - the TubleBuffer collection to be Streamed

heading - The heading the TupleBuffers conform to

outputStream - the stream to write to

Throws:

java.io.IOException - if an IO exception occurs

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

equalsRelationBuffer

public boolean equalsRelationBuffer(RelationBuffer obj)

Compares this RelationBuffer with another one for equality. RelationBuffer objects are equal iff their tupleBufferSets are equal.

Parameters:

obj - the RelationBuffer to compare for equality with this one

Returns:

true iff this RelationBuffer has a tupleBufferSet that is equal to the other one's.

getTupleBufferCollection

public MyReadOnlyCollection<TupleBuffer> getTupleBufferCollection()

Description copied from class: TupleCollectionBuffer

Gets the collection of tuple buffers

Specified by:

getTupleBufferCollection in class TupleCollectionBuffer

Returns:

the collection of tuple buffers

getTupleBufferSet

public MyReadOnlySet<TupleBuffer> getTupleBufferSet()

Gets the relation value

Returns:

The relation value

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object