InnerJoinRecordReaderTOuter, TInner, TResult Class

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

Inheritance Hierarchy

SystemObject
  Ookii.Jumbo.IORecordReaderTResult
    Ookii.Jumbo.IOMultiInputRecordReaderTResult
      Ookii.Jumbo.IOInnerJoinRecordReaderTOuter, 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 InnerJoinRecordReaderTOuter, TInner, TResult type exposes the following members.

Constructors

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

Top

Methods

	Name	Description
	AddInput	Adds the specified input to be read by this record reader. (Overrides MultiInputRecordReaderTAddInput(IListRecordInput))
	AssignAdditionalPartitions	Assigns additional partitions to this record reader. (Overrides MultiInputRecordReaderTAssignAdditionalPartitions(IListInt32))
	CheckDisposed	Throws a ObjectDisposedException if the object has been disposed. (Inherited from MultiInputRecordReaderT)
	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 RecordReaderT)
	Dispose(Boolean)	Cleans up all resources associated with this MultiInputRecordReaderT. (Inherited from MultiInputRecordReaderT)
	EnumerateRecords	Enumerates over all the records. (Inherited from RecordReaderT)
	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 MultiInputRecordReaderT)
	GetInputReader(Int32)	Gets the record reader for the specified input of the current partition. (Inherited from MultiInputRecordReaderT)
	GetInputReader(Int32, Int32)	Returns the record reader for the specified partition and input. (Inherited from MultiInputRecordReaderT)
	GetInputReader(Int32, Int32, Boolean)	Returns the record reader for the specified partition and input. (Inherited from MultiInputRecordReaderT)
	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 MultiInputRecordReaderT)
	OnCurrentPartitionChanged	Raises the CurrentPartitionChanged event. (Inherited from MultiInputRecordReaderT)
	OnCurrentPartitionChanging	Raises the CurrentPartitionChanging event. (Inherited from MultiInputRecordReaderT)
	OnHasRecordsChanged	Raises the HasRecordsChanged event. (Inherited from RecordReaderT)
	ReadRecord	Reads a record. (Inherited from RecordReaderT)
	ReadRecordInternal	Reads a record. (Overrides RecordReaderTReadRecordInternal)
	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 MultiInputRecordReaderT)

Top

Events

	Name	Description
	CurrentPartitionChanged	Event raised when the value of the CurrentPartition property changes. (Inherited from MultiInputRecordReaderT)
	CurrentPartitionChanging	Event raised when the value of the CurrentPartition property is about to change. (Inherited from MultiInputRecordReaderT)
	HasRecordsChanged	Occurs when the value of the HasRecords property changes. (Inherited from RecordReaderT)

Top

Remarks

Classes inheriting from InnerJoinRecordReaderTOuter, TInner, TResult must specify InputTypeAttribute attributes with both TOuter and TInner.

Reference

Ookii.Jumbo.IO Namespace