oracle.spatial.hadoop.vector.shapefile

Class ShapeFileRecordInfoProvider

java.lang.Object

oracle.spatial.hadoop.vector.shapefile.ShapeFileRecordInfoProvider

All Implemented Interfaces:

RecordInfoProvider<org.apache.hadoop.io.LongWritable,org.apache.hadoop.io.MapWritable>, org.apache.hadoop.conf.Configurable

public class ShapeFileRecordInfoProvider
extends java.lang.Object
implements RecordInfoProvider<org.apache.hadoop.io.LongWritable,org.apache.hadoop.io.MapWritable>, org.apache.hadoop.conf.Configurable

RecordInfoProvider for ESRI Shapefiles. Can be used with ShapeFileInputFormat to create indexes. The value is a Map containing all the Shapefile attributes including ShapeFileInputFormat.GEOMETRY_ATTRIBUTE. The geometries SRID can be defined. If the user sets the flag addExtraFields to true then the Shapefile attributes will be added to the extra fields.

Constructor Summary

Constructors

Constructor and Description
ShapeFileRecordInfoProvider() Creates a new instance

Method Summary

Modifier and Type	Method and Description
static boolean	addExtraFields(org.apache.hadoop.conf.Configuration conf) Returns true if shapefile's attributes will be added as extra fields in the index, false otherwise
org.apache.hadoop.conf.Configuration	getConf()
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
java.util.Map	getRecordValue() Returns the map record value.
static int	getSrid(org.apache.hadoop.conf.Configuration conf) Returns the SRID.
static void	setAddExtraFields(org.apache.hadoop.conf.Configuration conf, boolean addExtraFields) Sets the add extra fields flag.
void	setConf(org.apache.hadoop.conf.Configuration conf)
void	setCurrentRecord(org.apache.hadoop.io.LongWritable key, org.apache.hadoop.io.MapWritable value) Sets the record's key and value.
static void	setSrid(org.apache.hadoop.conf.Configuration conf, int srid) Sets the SRID.

Methods inherited from class java.lang.Object

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

Constructor Detail

ShapeFileRecordInfoProvider

public ShapeFileRecordInfoProvider()

Creates a new instance

Method Detail

setCurrentRecord

public void setCurrentRecord(org.apache.hadoop.io.LongWritable key,
                             org.apache.hadoop.io.MapWritable value)

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<org.apache.hadoop.io.LongWritable,org.apache.hadoop.io.MapWritable>

Parameters:

key - A record's key

value - A record's value

getId

public java.lang.String getId()

Description copied from interface: RecordInfoProvider

Gets the id of the current record

Specified by:

getId in interface RecordInfoProvider<org.apache.hadoop.io.LongWritable,org.apache.hadoop.io.MapWritable>

Returns:

the current record's id

getGeometry

public oracle.spatial.geometry.JGeometry getGeometry()

Description copied from interface: RecordInfoProvider

Gets the geometry of the current record

Specified by:

getGeometry in interface RecordInfoProvider<org.apache.hadoop.io.LongWritable,org.apache.hadoop.io.MapWritable>

Returns:

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

getSrid

public static int getSrid(org.apache.hadoop.conf.Configuration conf)

Returns the SRID. By default 8307.

Parameters:

conf - the job configuration

Returns:

the SRID. By default 8307.

setSrid

public static void setSrid(org.apache.hadoop.conf.Configuration conf,
                           int srid)

Sets the SRID.

Parameters:

conf - the job configuration

srid - the SRID

addExtraFields

public static boolean addExtraFields(org.apache.hadoop.conf.Configuration conf)

Returns true if shapefile's attributes will be added as extra fields in the index, false otherwise

Parameters:

conf - the job configuration

Returns:

true if shapefile's attributes will be added as extra fields in the index, false otherwise

setAddExtraFields

public static void setAddExtraFields(org.apache.hadoop.conf.Configuration conf,
                                     boolean addExtraFields)

Sets the add extra fields flag. If true then shapefile's attributes will be added as extra fields in the index.

Parameters:

conf - the job configuration

addExtraFields - If true then shapefile's attributes will be added as extra fields in the index

getRecordValue

public java.util.Map getRecordValue()

Returns the map record value.

Returns:

the map record value

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<org.apache.hadoop.io.LongWritable,org.apache.hadoop.io.MapWritable>

Parameters:

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

Returns:

true if extra fields were added. false otherwise.

getConf

public org.apache.hadoop.conf.Configuration getConf()

Specified by:

getConf in interface org.apache.hadoop.conf.Configurable

setConf

public void setConf(org.apache.hadoop.conf.Configuration conf)

Specified by:

setConf in interface org.apache.hadoop.conf.Configurable