MultiInputRecordReaderT Class

Base class for record readers that combine multiple inputs.

Inheritance Hierarchy

SystemObject
  Ookii.Jumbo.IORecordReaderT
    Ookii.Jumbo.IOMultiInputRecordReaderT
      Ookii.Jumbo.IOInnerJoinRecordReaderTOuter, TInner, TResult
      Ookii.Jumbo.IOMultiRecordReaderT
      Ookii.Jumbo.IORoundRobinMultiInputRecordReaderT
      Ookii.Jumbo.JetMergeRecordReaderT

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

Syntax

C++

Copy

public abstract class MultiInputRecordReader<T> : RecordReader<T>, 
	IMultiInputRecordReader, IRecordReader, IDisposable

Public MustInherit Class MultiInputRecordReader(Of T)
	Inherits RecordReader(Of T)
	Implements IMultiInputRecordReader, IRecordReader, IDisposable

generic<typename T>
public ref class MultiInputRecordReader abstract : public RecordReader<T>, 
	IMultiInputRecordReader, IRecordReader, IDisposable

[<AbstractClassAttribute>]
type MultiInputRecordReader<'T> = 
    class
        inherit RecordReader<'T>
        interface IMultiInputRecordReader
        interface IRecordReader
        interface IDisposable
    end

Type Parameters

T: The type of the records.

The MultiInputRecordReaderT type exposes the following members.

Constructors

	Name	Description
	MultiInputRecordReaderT	Initializes a new instance of the MultiInputRecordReaderT class.

Top

Properties

	Name	Description
	AllowRecordReuse	Gets a value that indicates that this record reader is allowed to reuse record instances.
	BufferSize	Gets the buffer size to use to read input files.
	BytesRead	Gets the actual number of bytes read from the input. (Overrides RecordReaderTBytesRead)
	CompressionType	Gets the type of compression to use to read input files.
	CurrentInputCount	Gets the current number of inputs that have been added to the MultiInputRecordReaderT for the currently active set of partitions.
	CurrentPartition	Gets or sets the partition that calls to ReadRecord should return records for.
	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. (Overrides RecordReaderTInputBytes)
	IsDisposed	Gets a value that indicates whether the object has been disposed.
	PartitionCount	Gets the number of partitions assigned to this reader.
	PartitionNumbers	Gets the partition numbers assigned to this reader.
	Progress	Gets the combined progress of the record readers. (Overrides RecordReaderTProgress)
	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.

Top

Methods

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

Top

Events

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

Top

Remarks

Depending on the type of record reader, the records of the input record readers might not need to read records of type T.

If you accept inputs of types other than T, you must specify that using the InputTypeAttribute.

The initial value of HasRecords will be . It is up to the deriving class to set it to when appropriate.

Note
While the AddInput(IListRecordInput), WaitForInputs(Int32, Int32) and GetInputReader(Int32) methods are thread safe, no other methods of this class are guaranteed to be thread safe, and derived classes are not required to make ReadRecordInternal thread safe. Essentially, you may have only one thread reading from the MultiInputRecordReaderT, while one or more other threads add inputs to it.

Reference

Ookii.Jumbo.IO Namespace