be.SIRAPRISE.typeimplementations

Class TupleBuffer

java.lang.Object

be.SIRAPRISE.typeimplementations.ValueBuffer

be.SIRAPRISE.typeimplementations.NonScalarValueBuffer

be.SIRAPRISE.typeimplementations.TupleBuffer

public class TupleBuffer
extends NonScalarValueBuffer

A TupleBuffer is the ValueBuffer type for tuple values.

Author:

Erwin Smout

Constructor Summary

Constructors

Constructor and Description
TupleBuffer(boolean mapReferenceLocal, java.util.Map<NameIdentifier,ValueBuffer> attributeValueMap) Creates the TupleBuffer
TupleBuffer(Heading heading, java.nio.ByteBuffer attributeValueEncoding) Creates the TupleBuffer
TupleBuffer(java.util.Map<NameIdentifier,ValueBuffer> attributeValueMap, int dummy) Creates the TupleBuffer
TupleBuffer(java.util.Map<java.lang.String,ValueBuffer> attributeValueMap) Deprecated. - replace with TupleBuffer(Map, int)
TupleBuffer(java.util.Map<java.lang.String,ValueBuffer> attributeValueMap, boolean mapReferenceLocal) Deprecated. - replace with TupleBuffer(boolean, Map)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Tells whether or not this TupleBuffer is equal to another object.
boolean	equalsTupleBuffer(TupleBuffer obj) Tells whether or not this TupleBuffer is equal to another TupleBuffer.
static TupleBuffer	fromStream1_0(Heading heading, java.io.DataInputStream in) Reads an encoded TupleBuffer from the given Stream
MyReadOnlyMap<NameIdentifier,ValueBuffer>	getAttributeIdentifierValueMap() Gets The tuple that this valueBuffer wraps around
MyReadOnlyMap<java.lang.String,ValueBuffer>	getAttributeValueMap() Deprecated. - replace with getAttributeIdentifierValueMap()
java.nio.ByteBuffer	getByteBuffer() Gets a read-only bytebuffer holding an encoding of the value
int	hashCode()
static void	toStream1_0(TupleBuffer tupleBuffer, Heading heading, java.io.DataOutputStream outputStream) Streams the given tupleBuffer to the given outputStream
java.lang.String	toString()
ValueBuffer	valueBuffer(NameIdentifier attributeName) Gets the ValueBuffer holding the value associated with the given attribute name
ValueBuffer	valueBuffer(java.lang.String attributeName) Deprecated. - replace with valueBuffer(NameIdentifier)

Methods inherited from class be.SIRAPRISE.typeimplementations.ValueBuffer

intern

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TupleBuffer

public TupleBuffer(boolean mapReferenceLocal,
                   java.util.Map<NameIdentifier,ValueBuffer> attributeValueMap)

Creates the TupleBuffer

Parameters:

attributeValueMap - The mapping from attribute names to attribute values that constitutes the tuple value

mapReferenceLocal - can be set to true if the caller can ascertain that no references to attributeValueMap will be left after the calling method exits. This is the case if : (a) the map was created as a local variable in the caller, (b) it was not passed to any methods that could keep this reference somewhere in the state of their objects, and (c) it will not be passed to other methods after this constructor returns. Iow, if the caller can ascertain that the map will become eligible for garbage collection after it exits.

TupleBuffer

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

Creates the TupleBuffer

Parameters:

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

attributeValueEncoding - the internal encoding of a tuple value

TupleBuffer

public TupleBuffer(java.util.Map<NameIdentifier,ValueBuffer> attributeValueMap,
                   int dummy)

Creates the TupleBuffer

Parameters:

attributeValueMap - The mapping from attribute names to attribute values that constitutes the tuple value

dummy - Unused parameter because java has no way to distinguish constructors depending on the generics of Collection parameters

TupleBuffer

@Deprecated
public TupleBuffer(java.util.Map<java.lang.String,ValueBuffer> attributeValueMap)

Deprecated. - replace with TupleBuffer(Map, int)

Creates the TupleBuffer

Parameters:

attributeValueMap - The mapping from attribute names to attribute values that constitutes the tuple value

TupleBuffer

@Deprecated
public TupleBuffer(java.util.Map<java.lang.String,ValueBuffer> attributeValueMap,
                               boolean mapReferenceLocal)

Deprecated. - replace with TupleBuffer(boolean, Map)

Creates the TupleBuffer

Parameters:

attributeValueMap - The mapping from attribute names to attribute values that constitutes the tuple value

mapReferenceLocal - can be set to true if the caller can ascertain that no references to attributeValueMap will be left after the calling method exits. This is the case if : (a) the map was created as a local variable in the caller, (b) it was not passed to any methods that could keep this reference somewhere in the state of their objects, and (c) it will not be passed to other methods after this constructor returns. Iow, if the caller can ascertain that the map will become eligible for garbage collection after it exits.

Method Detail

fromStream1_0

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

Reads an encoded TupleBuffer from the given Stream

Parameters:

heading - The heading that the (tuple encoded in the) TupleBuffer conforms to

in - the stream to read

Returns:

The TupleBuffer

Throws:

java.io.IOException - If an IO exception occurs

toStream1_0

public static void toStream1_0(TupleBuffer tupleBuffer,
                               Heading heading,
                               java.io.DataOutputStream outputStream)
                        throws java.io.IOException

Streams the given tupleBuffer to the given outputStream

Parameters:

tupleBuffer - the TupleBuffer to be streamed

heading - the heading that the tuplebuffer conforms to

outputStream - the output Stream

Throws:

java.io.IOException - If an IO exception occurs

equals

public final boolean equals(java.lang.Object obj)

Tells whether or not this TupleBuffer is equal to another object. A TupleBuffer can only be equal to another TupleBuffer, and never to any other type of object. Two TupleBuffer are equal if, and only if, their mappings (from attribute names to attribute values) are equal.

Overrides:

equals in class java.lang.Object

Parameters:

obj - The object to which this buffer is to be compared

Returns:

true if, and only if, this TupleBuffer is equal to the given object

equalsTupleBuffer

public final boolean equalsTupleBuffer(TupleBuffer obj)

Tells whether or not this TupleBuffer is equal to another TupleBuffer. Two TupleBuffer are equal if, and only if, their mappings (from attribute names to attribute values) are equal.

Parameters:

obj - The object to which this buffer is to be compared

Returns:

true if, and only if, this TupleBuffer is equal to the given object

getAttributeIdentifierValueMap

public final MyReadOnlyMap<NameIdentifier,ValueBuffer> getAttributeIdentifierValueMap()

Gets The tuple that this valueBuffer wraps around

Returns:

The tuple that this valueBuffer wraps around

getAttributeValueMap

@Deprecated
public final MyReadOnlyMap<java.lang.String,ValueBuffer> getAttributeValueMap()

Deprecated. - replace with getAttributeIdentifierValueMap()

Gets The tuple that this valueBuffer wraps around

Returns:

The tuple that this valueBuffer wraps around

getByteBuffer

public final java.nio.ByteBuffer getByteBuffer()

Description copied from class: ValueBuffer

Gets a read-only bytebuffer holding an encoding of the value

Specified by:

getByteBuffer in class ValueBuffer

Returns:

A read-only bytebuffer holding an encoding of the value

hashCode

public final int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public final java.lang.String toString()

Overrides:

toString in class java.lang.Object

valueBuffer

public final ValueBuffer valueBuffer(NameIdentifier attributeName)

Gets the ValueBuffer holding the value associated with the given attribute name

Parameters:

attributeName - The name of the attribute whose value is to be returned

Returns:

the ValueBuffer holding the value associated with the given attribute name

valueBuffer

@Deprecated
public final ValueBuffer valueBuffer(java.lang.String attributeName)

Deprecated. - replace with valueBuffer(NameIdentifier)

Gets the ValueBuffer holding the value associated with the given attribute name

Parameters:

attributeName - The name of the attribute whose value is to be returned

Returns:

the ValueBuffer holding the value associated with the given attribute name