be.SIRAPRISE.typeimplementations

Class JOIN_RELATION_RELATION_STRING

java.lang.Object

be.SIRAPRISE.typeimplementations.JOIN_RELATION_RELATION_STRING

All Implemented Interfaces:

AggregationOperatorImplementation, OperatorGenerator, OperatorImplementation_V0104, OperatorImplementation_V0105, java.io.Externalizable, java.io.Serializable

public final class JOIN_RELATION_RELATION_STRING
extends java.lang.Object
implements AggregationOperatorImplementation, OperatorGenerator

The relation JOIN operator takes two arguments, both of a relation type. Both relation types must be the same. A third argument specifies the set of attributes that are to be treated in "range" mode when computing.
The effect of an interval-typed attribute being among the range attributes or not is also illustrated in INTERSECT_RELATION_RELATION_STRING.

Author:

Erwin

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
JOIN_RELATION_RELATION_STRING() Deprecated. - this constructor is available only for use in the context of the Externalizable machinery

Method Summary

Modifier and Type	Method and Description
static java.util.Set<TupleBuffer>	computeRangeJoinAndPack(java.util.Collection<TupleBuffer> r1, java.util.Collection<TupleBuffer> r2, java.util.Set<NameIdentifier> partitioningKeys, MyReadOnlyLinkedHashMap<NameIdentifier,java.util.Map<java.lang.String,OperatorImplementation_V0104>> intervalTypedAttributesIntervalOperatorImplementations) Computes the "range" JOIN between the given relations.
static java.util.Set<TupleBuffer>	computeRangeJoinAndPack(java.util.Collection<TupleBuffer> r1, java.util.Collection<TupleBuffer> r2, java.util.Set<NameIdentifier> partitioningKeys, MyReadOnlyLinkedHashMap<NameIdentifier,java.util.Map<java.lang.String,OperatorImplementation_V0104>> intervalTypedAttributesIntervalOperatorImplementations, java.util.Map<NameIdentifier,ValueBuffer> wrkAttributeValueMap, java.util.LinkedList<ValueBuffer> wrkArgList) Computes the "range" JOIN between the given relations.
static java.util.Collection<TupleBuffer>	computeRangeJoinForSamePartitionRelationsAndPack(java.util.Collection<TupleBuffer> r1, java.util.Collection<TupleBuffer> r2, MyReadOnlyLinkedHashMap<NameIdentifier,java.util.Map<java.lang.String,OperatorImplementation_V0104>> intervalTypedAttributesIntervalOperatorImplementations) Computes the range join of tuple lists whose non-interval-typed attributes are required to have the same value
static java.util.Collection<TupleBuffer>	computeRangeJoinForSamePartitionRelationsAndPack(java.util.Collection<TupleBuffer> r1, java.util.Collection<TupleBuffer> r2, MyReadOnlyLinkedHashMap<NameIdentifier,java.util.Map<java.lang.String,OperatorImplementation_V0104>> intervalTypedAttributesIntervalOperatorImplementations, java.util.Map<NameIdentifier,ValueBuffer> wrkAttributeValueMap, java.util.LinkedList<ValueBuffer> wrkArglist) Computes the range join of tuple lists whose non-interval-typed attributes are required to have the same value
OperatorImplementation_V0105	createInvocation(OperatorGeneratorArgument[] args) Creates an instance of the operator.
ValueBuffer	executeOperator(java.util.LinkedList<ValueBuffer> args) Performs the actual logic of the operator.
java.lang.String[]	getArgumentTypeNames() Gets the list of names of types of the needed argument values
ValueBuffer	getIdentityElement() Gets the identity element of the operator in its domain.
static AggregationOperatorImplementation	getInstance(Heading heading1, Heading heading2, java.util.LinkedList<NameIdentifier> treatAsRange) Gets an instance of the operator for the given headings and using attributes between them
java.util.LinkedList<OperatorGeneratorArgumentType>	getOperatorGeneratorSignature() Gets the "generator signature" of the operator generator.
TypeDeclaration	getReturnTypeDeclaration() Gets the full type declaration of the type of the return value.
java.lang.String	getReturnTypeName() Gets the name of the type of the return value
java.lang.String	getSignature() Gets the name of the operator implemented by this implementation object
boolean	isDeterministic() Tells whether the operator is deterministic with respect to the arguments of its invocations.
void	readExternal(java.io.ObjectInput in)
void	writeExternal(java.io.ObjectOutput out)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JOIN_RELATION_RELATION_STRING

@Deprecated
public JOIN_RELATION_RELATION_STRING()

Deprecated. - this constructor is available only for use in the context of the Externalizable machinery

Creates the JOIN_RELATION_RELATION

Method Detail

getInstance

public static AggregationOperatorImplementation getInstance(Heading heading1,
                                                            Heading heading2,
                                                            java.util.LinkedList<NameIdentifier> treatAsRange)

Gets an instance of the operator for the given headings and using attributes between them

Parameters:

heading1 - The heading of the first argument to the JOIN

heading2 - The heading of the second argument to the JOIN

treatAsRange - The set of (names of) interval-typed attributes, common to both arguments, that are to be treated in "range mode"

Returns:

an instance of the operator for the given headings and using attributes between them

computeRangeJoinAndPack

public static java.util.Set<TupleBuffer> computeRangeJoinAndPack(java.util.Collection<TupleBuffer> r1,
                                                                 java.util.Collection<TupleBuffer> r2,
                                                                 java.util.Set<NameIdentifier> partitioningKeys,
                                                                 MyReadOnlyLinkedHashMap<NameIdentifier,java.util.Map<java.lang.String,OperatorImplementation_V0104>> intervalTypedAttributesIntervalOperatorImplementations)

Computes the "range" JOIN between the given relations. "Range" join means that the interval-typed join attributes present in the intervalTypedAttributesIntervalOperatorImplementations argument, only need to overlap (instead of being exactly equal), for two tuples to match and a resulting tuple to appear in the result.

Parameters:

r1 - the first tuples collection

r2 - the second tuples collection

partitioningKeys - The set of all join attributes that are not to be treated in "range" mode for the computation.

intervalTypedAttributesIntervalOperatorImplementations - The mapping from attribute names to their Interval types, to gain accessibility to the interval operators. The entries are ordered in the packing order for the result.

Returns:

the "range" JOIN between the given relations.

computeRangeJoinAndPack

public static java.util.Set<TupleBuffer> computeRangeJoinAndPack(java.util.Collection<TupleBuffer> r1,
                                                                 java.util.Collection<TupleBuffer> r2,
                                                                 java.util.Set<NameIdentifier> partitioningKeys,
                                                                 MyReadOnlyLinkedHashMap<NameIdentifier,java.util.Map<java.lang.String,OperatorImplementation_V0104>> intervalTypedAttributesIntervalOperatorImplementations,
                                                                 java.util.Map<NameIdentifier,ValueBuffer> wrkAttributeValueMap,
                                                                 java.util.LinkedList<ValueBuffer> wrkArgList)

Computes the "range" JOIN between the given relations. "Range" join means that the interval-typed join attributes present in the intervalTypedAttributesIntervalOperatorImplementations argument, only need to overlap (instead of being exactly equal), for two tuples to match and a resulting tuple to appear in the result.

Parameters:

r1 - the first tuples collection

r2 - the second tuples collection

partitioningKeys - The set of all join attributes that are not to be treated in "range" mode for the computation.

intervalTypedAttributesIntervalOperatorImplementations - The mapping from attribute names to their Interval types, to gain accessibility to the interval operators. The entries are ordered in the packing order for the result. The resulting packing will also be done using this PACK specification, so it is not possible to use this implicit invocation of PACK to pack on an additional interval-typed attribute that is outside the set of join attributes.

wrkAttributeValueMap - A working map that can be used for internal tuple building. Avoids the need to allocate new attributeValueMaps inside the method.

wrkArgList - A linkedlist that can be used as a working object when invoking the interval operators

Returns:

the "range" JOIN between the given relations.

computeRangeJoinForSamePartitionRelationsAndPack

public static java.util.Collection<TupleBuffer> computeRangeJoinForSamePartitionRelationsAndPack(java.util.Collection<TupleBuffer> r1,
                                                                                                 java.util.Collection<TupleBuffer> r2,
                                                                                                 MyReadOnlyLinkedHashMap<NameIdentifier,java.util.Map<java.lang.String,OperatorImplementation_V0104>> intervalTypedAttributesIntervalOperatorImplementations)

Computes the range join of tuple lists whose non-interval-typed attributes are required to have the same value

Parameters:

r1 - The first tuples collection. All tuples t1 in r1 are presumed to have equal attribute values for all attributes not mentioned in the ranges argument (intervalTypedAttributesIntervalOperatorImplementations). This condition is not checked.

r2 - The second tuples collection. All tuples t2 in r2 are presumed to have equal attribute values as all those in r1 for all attributes not mentioned in the ranges argument (intervalTypedAttributesIntervalOperatorImplementations). This condition is not checked.

intervalTypedAttributesIntervalOperatorImplementations - The mapping from attribute names to their Interval types, to gain accessibility to the interval operators. The entries are ordered in the packing order for the result. The resulting packing will also be done using this PACK specification, so it is not possible to use this implicit invocation of PACK to pack on an additional interval-typed attribute that is outside the set of join attributes.

Returns:

the range join of the given tuple lists

computeRangeJoinForSamePartitionRelationsAndPack

public static java.util.Collection<TupleBuffer> computeRangeJoinForSamePartitionRelationsAndPack(java.util.Collection<TupleBuffer> r1,
                                                                                                 java.util.Collection<TupleBuffer> r2,
                                                                                                 MyReadOnlyLinkedHashMap<NameIdentifier,java.util.Map<java.lang.String,OperatorImplementation_V0104>> intervalTypedAttributesIntervalOperatorImplementations,
                                                                                                 java.util.Map<NameIdentifier,ValueBuffer> wrkAttributeValueMap,
                                                                                                 java.util.LinkedList<ValueBuffer> wrkArglist)

Computes the range join of tuple lists whose non-interval-typed attributes are required to have the same value

Parameters:

r1 - The first tuples collection. All tuples t1 in r1 are presumed to have equal attribute values for all attributes not mentioned in the ranges argument (intervalTypedAttributesIntervalOperatorImplementations). This condition is not checked.

r2 - The second tuples collection. All tuples t2 in r2 are presumed to have equal attribute values as all those in r1 for all attributes not mentioned in the ranges argument (intervalTypedAttributesIntervalOperatorImplementations). This condition is not checked.

intervalTypedAttributesIntervalOperatorImplementations - The mapping from interval join attribute names to their Interval types, to gain accessibility to the interval operators. The entries are ordered in the packing order for the result. The resulting packing will also be done using this PACK specification, so it is not possible to use this implicit invocation of PACK to pack on an additional interval-typed attribute that is outside the set of join attributes.

wrkAttributeValueMap - A working map that can be used for internal tuple building. Avoids the need to allocate new attributeValueMaps inside the method.

wrkArglist - A linkedlist that can be used as a working object when invoking the interval operators

Returns:

the range join of the given tuple lists

createInvocation

public OperatorImplementation_V0105 createInvocation(OperatorGeneratorArgument[] args)

Description copied from interface: OperatorGenerator

Creates an instance of the operator.

Specified by:

createInvocation in interface OperatorGenerator

Parameters:

args - The arguments from which the instance is to be created. There must be exactly as many arguments as there are elements in the list returned from OperatorGenerator.getOperatorGeneratorSignature(). The correspondence between OperatorGeneratorArgumentType values and OperatorGeneratorArgument types is given in the table below :

correspondence between OperatorGeneratorArgumentType values and OperatorGeneratorArgument types

OperatorGeneratorArgumentType value	OperatorGeneratorArgument type
EXPRESSION	NonScalarOperatorGeneratorExpressionArgument

Returns:

an instance of the operator

executeOperator

public ValueBuffer executeOperator(java.util.LinkedList<ValueBuffer> args)

Description copied from interface: OperatorImplementation_V0104

Performs the actual logic of the operator.

Specified by:

executeOperator in interface OperatorImplementation_V0104

Parameters:

args - the argument list. The list must hold as many ValueBuffer objects as there are arguments to the operator, and each ValueBuffer object holds a value for some argument to the operator. ValueBuffer objects on the list must appear in the same order as the operator argument declarations. Implementations have the option, but are not required, to do a check the conformance of the argument list (the argument count, notably) to the operator signature.

Returns:

A ValueBuffer object holding the result value of the operator execution in internal format.

getArgumentTypeNames

public java.lang.String[] getArgumentTypeNames()

Description copied from interface: OperatorImplementation_V0104

Gets the list of names of types of the needed argument values

Specified by:

getArgumentTypeNames in interface OperatorImplementation_V0104

Returns:

The names of the argument types

getIdentityElement

public ValueBuffer getIdentityElement()
                               throws NoIdentityElementException

Description copied from interface: AggregationOperatorImplementation

Gets the identity element of the operator in its domain.

Specified by:

getIdentityElement in interface AggregationOperatorImplementation

Returns:

The identity element.

Throws:

NoIdentityElementException - if no such element exists within the (finite bounds of the) operator's domain.

getOperatorGeneratorSignature

public java.util.LinkedList<OperatorGeneratorArgumentType> getOperatorGeneratorSignature()

Description copied from interface: OperatorGenerator

Gets the "generator signature" of the operator generator. There should be exactly as many OperatorGeneratorArgumentType values as there are in the result of the operator signature's getArgumentTypeNames method, and they should correspond, obviously, by ordinal position.

Specified by:

getOperatorGeneratorSignature in interface OperatorGenerator

Returns:

the "generator signature" of the operator generator.

getReturnTypeDeclaration

public TypeDeclaration getReturnTypeDeclaration()

Description copied from interface: OperatorImplementation_V0105

Gets the full type declaration of the type of the return value. Differs from the _V0104 getReturnTypeName() in that for nonscalar return types, this method also returns the heading, not just only the RELATION or TUPLE typename.

Specified by:

getReturnTypeDeclaration in interface OperatorImplementation_V0105

Returns:

the full type declaration of the type of the return value

getReturnTypeName

public java.lang.String getReturnTypeName()

Description copied from interface: OperatorImplementation_V0104

Gets the name of the type of the return value

Specified by:

getReturnTypeName in interface OperatorImplementation_V0104

Returns:

the name of the type of the return value

getSignature

public java.lang.String getSignature()

Description copied from interface: OperatorImplementation_V0104

Gets the name of the operator implemented by this implementation object

Specified by:

getSignature in interface OperatorImplementation_V0104

Returns:

the name of the operator implemented by this implementation object

isDeterministic

public boolean isDeterministic()

Description copied from interface: OperatorImplementation_V0104

Tells whether the operator is deterministic with respect to the arguments of its invocations. An operator is deterministic if and only if for any two distinct invocations, if all the argument values are the same, then the result value returned will also be the same. An example of a nondeterministic operators is RANDOM().

Specified by:

isDeterministic in interface OperatorImplementation_V0104

Returns:

true if the operator is deterministic.

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

Throws:

java.io.IOException

java.lang.ClassNotFoundException

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Throws:

java.io.IOException