oracle.spatial.hadoop.vector

Class SpatialIndexRecordInfoProvider

java.lang.Object

oracle.spatial.hadoop.vector.SpatialIndexRecordInfoProvider

All Implemented Interfaces:

RecordInfoProvider<Text,RecordInfo>

public class SpatialIndexRecordInfoProvider
extends java.lang.Object
implements RecordInfoProvider<Text,RecordInfo>

A RecordInfoProvider subclass required when either SpatialIndexInputFormat or SpatialIndexInputFormat need to be used in jobs that require both, an input format class and a RecordInfoProvider class.

Author:

hsaucedo

Constructor Summary

Constructors

Constructor and Description
SpatialIndexRecordInfoProvider()

Method Summary

Modifier and Type	Method and Description
RecordInfo	getCurrentRecordInfo()
boolean	getExtraFields(java.util.Map<java.lang.String,java.lang.String> extraFields) If the current record contains other fields different to id and geometry that are desired to be stored for fast access, they should be returned here by adding them to the passed map.
JGeometry	getGeometry() Gets the geometry of the current record
java.lang.String	getId() Gets the id of the current record
void	setCurrentRecord(Text key, RecordInfo value) Sets the record's key and value.

Methods inherited from class java.lang.Object

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

Constructor Detail

SpatialIndexRecordInfoProvider

public SpatialIndexRecordInfoProvider()

Method Detail

getCurrentRecordInfo

public RecordInfo getCurrentRecordInfo()

getExtraFields

public boolean getExtraFields(java.util.Map<java.lang.String,java.lang.String> extraFields)

Description copied from interface: RecordInfoProvider

If the current record contains other fields different to id and geometry that are desired to be stored for fast access, they should be returned here by adding them to the passed map. An example of an extra field is a field containing text that can be used to find the record's location using the MVSSuggest service.

Specified by:

getExtraFields in interface RecordInfoProvider<Text,RecordInfo>

Parameters:

extraFields - An empty map where the extra fields can be added

Returns:

true if extra fields were added. false otherwise.

getGeometry

public JGeometry getGeometry()

Description copied from interface: RecordInfoProvider

Gets the geometry of the current record

Specified by:

getGeometry in interface RecordInfoProvider<Text,RecordInfo>

Returns:

the current record's geometry or null if the record does not have spatial information

getId

public java.lang.String getId()

Description copied from interface: RecordInfoProvider

Gets the id of the current record

Specified by:

getId in interface RecordInfoProvider<Text,RecordInfo>

Returns:

the current record's id

setCurrentRecord

public void setCurrentRecord(Text key,
                             RecordInfo value)
                      throws java.lang.Exception

Description copied from interface: RecordInfoProvider

Sets the record's key and value. The key and value come from the internal InputFormat's RecordReader specified by the user. The record set here should be used to provide the information requested later by calling the getXX() methods. For example: if the InputFormat is TextInputFormat the key will be a LongWrittable and the value will be a Text.

Specified by:

setCurrentRecord in interface RecordInfoProvider<Text,RecordInfo>

Parameters:

key - A record's key

value - A record's value

Throws:

java.lang.Exception