be.SIRAPRISE.typeimplementations

Class JOIN_RELATION_RELATION

java.lang.Object

be.SIRAPRISE.typeimplementations.JOIN_RELATION_RELATION

All Implemented Interfaces:

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

public final class JOIN_RELATION_RELATION
extends java.lang.Object
implements AggregationOperatorImplementation

The relation JOIN operator takes two arguments, both of a relation type. Both relation types must be the same.
An invocation of this JOIN operator is equivalent to an invocation of JOINUSING_RELATION_RELATION, where the third argument mentions all the interval-typed attributes of the RELATION arguments' headings, in lexicographical order.

Author:

Erwin

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
JOIN_RELATION_RELATION() 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>	computePlainJoin(MyReadOnlySet<TupleBuffer> r1, MyReadOnlySet<TupleBuffer> r2) Computes the "plain" JOIN between the given relation arguments.
static java.util.Set<TupleBuffer>	computePlainJoin(MyReadOnlySet<TupleBuffer> r1, MyReadOnlySet<TupleBuffer> r2, java.util.Set<NameIdentifier> partitioningKeys) Computes the "plain" JOIN between the given relation arguments.
static RelationBuffer	computePlainJoin(RelationBuffer relationBuffer, RelationBuffer relationBuffer2)
static RelationBuffer	computeUsingJoin(RelationBuffer relationBuffer, RelationBuffer relationBuffer2, java.util.Set<NameIdentifier> partitioningKeys, MyReadOnlyLinkedHashMap<NameIdentifier,java.util.Map<java.lang.String,OperatorImplementation_V0104>> intervalTypedAttributesIntervalOperatorImplementations, java.util.Map<NameIdentifier,IntervalTypeImplementation> intervalTypedAttributesIntervalTypeImplementations)
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) Gets an instance of the operator for the given headings
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)
static JOINInvocationResultDetails	validateExpressionDetails(Heading arg1Heading, Heading arg2Heading, java.util.LinkedHashSet<NameIdentifier> usingAttributes, java.lang.String predicate1, java.lang.String predicate2, java.util.Collection<? extends KeyDef> arg1KeySpecifications, java.util.Collection<? extends KeyDef> arg2KeySpecifications)
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

@Deprecated
public JOIN_RELATION_RELATION()

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

Creates the JOIN_RELATION_RELATION

Method Detail

computePlainJoin

public static java.util.Set<TupleBuffer> computePlainJoin(MyReadOnlySet<TupleBuffer> r1,
                                                          MyReadOnlySet<TupleBuffer> r2,
                                                          java.util.Set<NameIdentifier> partitioningKeys)

Computes the "plain" JOIN between the given relation arguments. "plain" means that interval-typed join attributes must have equal values for two tuples to match, and a tuple to appear in the result.

Parameters:

r1 - the first tuples collection

r2 - the second tuples collection

partitioningKeys - the full set of join attribute names. Must be equal to the set of common attributes between r1 and r2.

Returns:

the "plain" JOIN between the given relation arguments.

computePlainJoin

public static java.util.Set<TupleBuffer> computePlainJoin(MyReadOnlySet<TupleBuffer> r1,
                                                          MyReadOnlySet<TupleBuffer> r2)

Computes the "plain" JOIN between the given relation arguments. "plain" means that interval-typed join attributes must have equal values for two tuples to match, and a tuple to appear in the result.

Parameters:

r1 - the first tuples collection

r2 - the second tuples collection

Returns:

the "plain" JOIN between the given relation arguments.

getInstance

public static AggregationOperatorImplementation getInstance(Heading heading1,
                                                            Heading heading2)

Gets an instance of the operator for the given headings

Parameters:

heading1 - The heading of the first argument to the join

heading2 - The heading of the second argument to the join

Returns:

an instance of the operator for the given heading

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.

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

computePlainJoin

public static RelationBuffer computePlainJoin(RelationBuffer relationBuffer,
                                              RelationBuffer relationBuffer2)

Parameters:

relationBuffer - A relation to be joined with the other one

relationBuffer2 - The other relation, to be joined with the former one

Returns:

the result of joining the two given relations

computeUsingJoin

public static RelationBuffer computeUsingJoin(RelationBuffer relationBuffer,
                                              RelationBuffer relationBuffer2,
                                              java.util.Set<NameIdentifier> partitioningKeys,
                                              MyReadOnlyLinkedHashMap<NameIdentifier,java.util.Map<java.lang.String,OperatorImplementation_V0104>> intervalTypedAttributesIntervalOperatorImplementations,
                                              java.util.Map<NameIdentifier,IntervalTypeImplementation> intervalTypedAttributesIntervalTypeImplementations)

Parameters:

relationBuffer - A relation to be joined with the other one

relationBuffer2 - The other relation, to be joined with the former one

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

intervalTypedAttributesIntervalOperatorImplementations - The mapping from interval-typed 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.

intervalTypedAttributesIntervalTypeImplementations - The map holding the IntervalTypeImplementation objects for all of the interval-typed attributes, through which the needed interval operators can be accessed

Returns:

the result of joining the two given relations

validateExpressionDetails

public static JOINInvocationResultDetails validateExpressionDetails(Heading arg1Heading,
                                                                    Heading arg2Heading,
                                                                    java.util.LinkedHashSet<NameIdentifier> usingAttributes,
                                                                    java.lang.String predicate1,
                                                                    java.lang.String predicate2,
                                                                    java.util.Collection<? extends KeyDef> arg1KeySpecifications,
                                                                    java.util.Collection<? extends KeyDef> arg2KeySpecifications)
                                                             throws IncompatibleJoinHeadingsException,
                                                                    AttributeNotIntervalTypedException,
                                                                    JoinUsingAttributeNotCommonBetweenArgumentsException

Parameters:

arg1Heading - A relation to be joined with the other one

arg2Heading - The other relation, to be joined with the former one

usingAttributes - the interval-typed attributes, in-order, that are to be applied in 'USING' mode by the join

predicate1 - The predicate of which the first relation argument is the extension

predicate2 - The predicate of which the second relation argument is the extension

arg1KeySpecifications - The key specifications known to be satisfied by arg1

arg2KeySpecifications - The key specifications known to be satisfied by arg2

Returns:

The technical details about the join invocation

Throws:

IncompatibleJoinHeadingsException - If the two headings are not join-compatible.

AttributeNotIntervalTypedException - If an attribute mentioned in usingAttributes is not interval-typed

JoinUsingAttributeNotCommonBetweenArgumentsException - If an attribute mentioned in the usingAttributes is not an attribute in both arguments