oracle.spatial.hadoop.vector.mapreduce.input

Class WrapperInputFormat<I,J,K,V>

java.lang.Object

<any>

oracle.spatial.hadoop.vector.mapreduce.input.WrapperInputFormat<I,J,K,V>

Type Parameters:

K - The type of the record's key. The same used by internalInputFormat

V - The type of the record's value. The same used by internalInputFormat.

Direct Known Subclasses:

FileSplitInputFormat, PointKeyInputFormat, SpatialFilterInputFormat

public abstract class WrapperInputFormat<I,J,K,V>
extends <any>

Abstract InputFormat which uses another InputFormat (internalInputFormat) to read data and allows adding additional functionality such as spatial filtering. The internal input format must be a subclass of FileInputFormat.

Author:

hsaucedo

Constructor Summary

Constructors

Constructor and Description
WrapperInputFormat()

Method Summary

Modifier and Type	Method and Description
static <K,V> <any>	createInternalInputFormat(JobContext context)
static InputSplit	getFittingInputSplit(JobContext context, <any> inputFormat, InputSplit split) Returns an instance of an InputSplit subclass appropriate for the given InputFormat.
<any>	getInternalInputFormat(JobContext context) Gets an instance of the class set as the internal input format
static <K,V> java.lang.Class<? extends <any>>	getInternalInputFormatClass(JobContext context) Gets the internal input format type which is used to actually read the data.
static <K,V> RecordInfoProvider<K,V>	getRecordInfoProvider(RecordInfoProvider<K,V> provider, JobContext job) Gets an instance of the specified RecordInfoProvider implementation
static <K,V> java.lang.Class<? extends RecordInfoProvider<K,V>>	getRecordInfoProviderClass(JobContext job) Gets the class of the RecordInfoProvider implementation
java.util.List<InputSplit>	getSplits(JobContext context)
static <K,V> void	setInternalInputFormatClass(JobContext job, java.lang.Class<? extends <any>> iInputFormat) Sets the internal input format type which is used to actually read the data.
static <K,V> void	setRecordInfoProviderClass(JobContext job, java.lang.Class<? extends RecordInfoProvider<K,V>> provider) Sets the class of the RecordInfoProvider implementation

Methods inherited from class java.lang.Object

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

Constructor Detail

WrapperInputFormat

public WrapperInputFormat()

Method Detail

createInternalInputFormat

public static <K,V> <any> createInternalInputFormat(JobContext context)

getFittingInputSplit

public static InputSplit getFittingInputSplit(JobContext context,
                                              <any> inputFormat,
                                              InputSplit split)
                                       throws java.io.IOException

Returns an instance of an InputSplit subclass appropriate for the given InputFormat. For example, if the passed split is a FileSplit instance and the InputFormat is a CombineFileInputFormat implementation, the returned split will be a instance of CombineFileSplit.

Parameters:

context - the job configuration

inputFormat - an InputFormat instance

split - an InputSplit instance

Returns:

if the passed split fits the input format, it is returned, otherwise a new one that fits is returned.

Throws:

java.io.IOException

getInternalInputFormat

public <any> getInternalInputFormat(JobContext context)

Gets an instance of the class set as the internal input format

Parameters:

context - the job configuration

Returns:

an InputFormat instance

getInternalInputFormatClass

public static <K,V> java.lang.Class<? extends <any>> getInternalInputFormatClass(JobContext context)

Gets the internal input format type which is used to actually read the data.

Parameters:

context - the job configuration

Returns:

a class which is a subclass of FileInputFormat or CombineFileInputFormat

getRecordInfoProvider

public static <K,V> RecordInfoProvider<K,V> getRecordInfoProvider(RecordInfoProvider<K,V> provider,
                                                                  JobContext job)

Gets an instance of the specified RecordInfoProvider implementation

Parameters:

provider - if null, a new instance will be returned, otherwise, the same instance will be returned. It is used to release the caller from checking if the instance is null.

job - the job configuration

Returns:

a RecordInfoProvider instance

getRecordInfoProviderClass

public static <K,V> java.lang.Class<? extends RecordInfoProvider<K,V>> getRecordInfoProviderClass(JobContext job)

Gets the class of the RecordInfoProvider implementation

Parameters:

job - the job configuration

Returns:

a class that extends from RecordInfoProvider

getSplits

public java.util.List<InputSplit> getSplits(JobContext context)
                                     throws java.io.IOException

Throws:

java.io.IOException

setInternalInputFormatClass

public static <K,V> void setInternalInputFormatClass(JobContext job,
                                                     java.lang.Class<? extends <any>> iInputFormat)

Sets the internal input format type which is used to actually read the data.

Parameters:

job - the job configuration

iInputFormat - a class which is a subclass of FileInputFormat or CombineFileInputFormat

setRecordInfoProviderClass

public static <K,V> void setRecordInfoProviderClass(JobContext job,
                                                    java.lang.Class<? extends RecordInfoProvider<K,V>> provider)

Sets the class of the RecordInfoProvider implementation

Parameters:

job - the job configuration

provider - a class that extends from RecordInfoProvider