InnerJoinRecordReader<TOuter, TInner, TResult> Class

Record reader that performs a two-way inner equi-join from two sorted input record readers.

Inheritance Hierarchy

System.Object
  Ookii.Jumbo.IO.RecordReader<TResult>
    Ookii.Jumbo.IO.MultiInputRecordReader<TResult>
      Ookii.Jumbo.IO.InnerJoinRecordReader<TOuter, TInner, TResult>

Namespace: Ookii.Jumbo.IO
Assembly: Ookii.Jumbo (in Ookii.Jumbo.dll) Version: 0.3.0+dc1307f20e065bb638e0b73a34cd216f57e486f1

Syntax

C++

Copy

public abstract class InnerJoinRecordReader<TOuter, TInner, TResult> : MultiInputRecordReader<TResult>
where TResult : new()

Public MustInherit Class InnerJoinRecordReader(Of TOuter, TInner, TResult As New)
	Inherits MultiInputRecordReader(Of TResult)

generic<typename TOuter, typename TInner, typename TResult>
where TResult : gcnew()
public ref class InnerJoinRecordReader abstract : public MultiInputRecordReader<TResult>

[<AbstractClassAttribute>]
type InnerJoinRecordReader<'TOuter, 'TInner, 'TResult when 'TResult : new()> = 
    class
        inherit MultiInputRecordReader<'TResult>
    end

Type Parameters

TOuter: The type of the records of the outer relation.
TInner: The type of the records of the inner relation.
TResult: The type of the result records.

The InnerJoinRecordReader<TOuter, TInner, TResult> type exposes the following members.

Constructors

	Name	Description
	InnerJoinRecordReader<TOuter, TInner, TResult>	Initializes a new instance of the InnerJoinRecordReader<TOuter, TInner, TResult> class.

Top

Properties

	Name	Description
	AllowRecordReuse	Gets a value that indicates that this record reader is allowed to reuse record instances. (Inherited from MultiInputRecordReader<T>)
	BufferSize	Gets the buffer size to use to read input files. (Inherited from MultiInputRecordReader<T>)
	BytesRead	Gets the actual number of bytes read from the input. (Inherited from MultiInputRecordReader<T>)
	CompressionType	Gets the type of compression to use to read input files. (Inherited from MultiInputRecordReader<T>)
	CurrentInputCount	Gets the current number of inputs that have been added to the MultiInputRecordReader<T> for the currently active set of partitions. (Inherited from MultiInputRecordReader<T>)
	CurrentPartition	Gets or sets the partition that calls to ReadRecord() should return records for. (Inherited from MultiInputRecordReader<T>)
	CurrentRecord	Gets the current record. (Inherited from RecordReader<T>)
	HasFinished	Gets a value indicating whether this instance has read all records. (Inherited from RecordReader<T>)
	HasRecords	Gets a value that indicates whether there are records available on the data source that this reader is reading from. (Inherited from RecordReader<T>)
	InputBytes	Gets the size of the records before deserialization of all record readers. (Inherited from MultiInputRecordReader<T>)
	IsDisposed	Gets a value that indicates whether the object has been disposed. (Inherited from MultiInputRecordReader<T>)
	PartitionCount	Gets the number of partitions assigned to this reader. (Inherited from MultiInputRecordReader<T>)
	PartitionNumbers	Gets the partition numbers assigned to this reader. (Inherited from MultiInputRecordReader<T>)
	Progress	Gets the combined progress of the record readers. (Inherited from MultiInputRecordReader<T>)
	ReadTime	Gets the time spent reading. (Inherited from RecordReader<T>)
	RecordsRead	Gets the number of records that has been read by this record reader. (Inherited from RecordReader<T>)
	SourceName	Gets or sets the an informational string indicating the source of the records. (Inherited from RecordReader<T>)
	TotalInputCount	Gets the total number of inputs readers that this record reader will have. (Inherited from MultiInputRecordReader<T>)

Top

Methods

	Name	Description
	AddInput	Adds the specified input to be read by this record reader. (Overrides MultiInputRecordReader<T>.AddInput(IList<RecordInput>))
	AssignAdditionalPartitions	Assigns additional partitions to this record reader. (Overrides MultiInputRecordReader<T>.AssignAdditionalPartitions(IList<Int32>))
	CheckDisposed	Throws a ObjectDisposedException if the object has been disposed. (Inherited from MultiInputRecordReader<T>)
	Compare	When implemented in a derived class, compares an object from the outer relation to one from the inner relation based on the join condition.
	CreateJoinResult	When implemented in a derived class, creates an object of type TResult that holds the result of the join.
	Dispose()	Cleans up all resources held by this StreamRecordReader{T}. (Inherited from RecordReader<T>)
	Dispose(Boolean)	Cleans up all resources associated with this MultiInputRecordReader<T>. (Inherited from MultiInputRecordReader<T>)
	EnumerateRecords	Enumerates over all the records. (Inherited from RecordReader<T>)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object)
	GetHashCode	Serves as the default hash function. (Inherited from Object)
	GetInput	Returns the specified input. (Inherited from MultiInputRecordReader<T>)
	GetInputReader(Int32)	Gets the record reader for the specified input of the current partition. (Inherited from MultiInputRecordReader<T>)
	GetInputReader(Int32, Int32)	Returns the record reader for the specified partition and input. (Inherited from MultiInputRecordReader<T>)
	GetInputReader(Int32, Int32, Boolean)	Returns the record reader for the specified partition and input. (Inherited from MultiInputRecordReader<T>)
	GetType	Gets the Type of the current instance. (Inherited from Object)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
	NextPartition	Moves the current partition to the next partition. (Inherited from MultiInputRecordReader<T>)
	OnCurrentPartitionChanged	Raises the CurrentPartitionChanged event. (Inherited from MultiInputRecordReader<T>)
	OnCurrentPartitionChanging	Raises the CurrentPartitionChanging event. (Inherited from MultiInputRecordReader<T>)
	OnHasRecordsChanged	Raises the HasRecordsChanged event. (Inherited from RecordReader<T>)
	ReadRecord	Reads a record. (Inherited from RecordReader<T>)
	ReadRecordInternal	Reads a record. (Overrides RecordReader<T>.ReadRecordInternal())
	ToString	Returns a string that represents the current object. (Inherited from Object)
	WaitForInputs	Waits until the specified number of inputs becomes available for all currently active partitions. (Inherited from MultiInputRecordReader<T>)

Top

Events

	Name	Description
	CurrentPartitionChanged	Event raised when the value of the CurrentPartition property changes. (Inherited from MultiInputRecordReader<T>)
	CurrentPartitionChanging	Event raised when the value of the CurrentPartition property is about to change. (Inherited from MultiInputRecordReader<T>)
	HasRecordsChanged	Occurs when the value of the HasRecords property changes. (Inherited from RecordReader<T>)

Top

Remarks

Classes inheriting from InnerJoinRecordReader<TOuter, TInner, TResult> must specify InputTypeAttribute attributes with both TOuter and TInner.

Reference

Ookii.Jumbo.IO Namespace