oracle.spatial.hadoop.vector

Interface RecordInfoProvider<K,V>

Type Parameters:

K - The type of the record's key

V - The type of the record's value

All Known Subinterfaces:

LocalizableRecordInfoProvider<K,V>

All Known Implementing Classes:

GeoJsonRecordInfoProvider, ShapeFileRecordInfoProvider, SpatialIndexRecordInfoProvider

public interface RecordInfoProvider<K,V>

An implementation of this interface is used to extract certain information needed by the API from any record represented as a Key,Value pair, typically, obtained from an InputFormat. The implementer should know how to interpret the given key and value to provide the requested information.

Method Summary

Methods

Modifier and Type	Method and Description
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.
oracle.spatial.geometry.JGeometry	getGeometry() Gets the geometry of the current record
java.lang.String	getId() Gets the id of the current record
void	setCurrentRecord(K key, V value) Sets the record's key and value.

Method Detail

setCurrentRecord

void setCurrentRecord(K key,
                      V value)
               throws java.lang.Exception

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.

Parameters:

key - A record's key

value - A record's value

Throws:

java.lang.Exception

getId

java.lang.String getId()

Gets the id of the current record

Returns:

the current record's id

getGeometry

oracle.spatial.geometry.JGeometry getGeometry()

Gets the geometry of the current record

Returns:

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

getExtraFields

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. 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.

Parameters:

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

Returns:

true if extra fields were added. false otherwise.