oracle.spatial.hadoop.vector.geojson

Class GeoJsonRecordInfoProvider

java.lang.Object

oracle.spatial.hadoop.vector.geojson.GeoJsonRecordInfoProvider

All Implemented Interfaces:

java.io.Serializable, RecordInfoProvider<LongWritable,Text>

public class GeoJsonRecordInfoProvider
extends java.lang.Object
implements RecordInfoProvider<LongWritable,Text>, java.io.Serializable

RecordInfoProvider for GeoJSON text files. Can be used with GeoJsonInputFormat to create indexes. The geometries SRID and dimensions can be defined. If the objects are features and the user sets the flag addExtraFields to true then the properties will be added to the extra fields.

Author:

rinfante

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GeoJsonRecordInfoProvider() Creates a new instance

Method Summary

Modifier and Type	Method and Description
static boolean	addExtraFields(Configuration conf) Returns true if geojson's properties will be added as extra fields in the index, false otherwise
Configuration	getConf()
static int	getDimensions(Configuration conf) Returns the geometries dimensions.
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
JsonNode	getRecordNode() Returns the org.codehaus.jackson.JsonNode of the record.
static int	getSrid(Configuration conf) Returns the SRID.
static void	setAddExtraFields(Configuration conf, boolean addExtraFields) Sets the add extra fields flag.
void	setConf(Configuration conf)
void	setCurrentRecord(LongWritable key, Text value) Sets the record's key and value.
static void	setDimensions(Configuration conf, int dimensions) Sets the geometries dimensions.
static void	setSrid(Configuration conf, int srid) Sets the SRID.

Methods inherited from class java.lang.Object

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

Constructor Detail

GeoJsonRecordInfoProvider

public GeoJsonRecordInfoProvider()

Creates a new instance

Method Detail

addExtraFields

public static boolean addExtraFields(Configuration conf)

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

Parameters:

conf - the job configuration

Returns:

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

getConf

public Configuration getConf()

getDimensions

public static int getDimensions(Configuration conf)

Returns the geometries dimensions. By default 2.

Parameters:

conf - the job configuration

Returns:

the geometries dimensions

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<LongWritable,Text>

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<LongWritable,Text>

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<LongWritable,Text>

Returns:

the current record's id

getRecordNode

public JsonNode getRecordNode()

Returns the org.codehaus.jackson.JsonNode of the record.

Returns:

getSrid

public static int getSrid(Configuration conf)

Returns the SRID. By default 8307.

Parameters:

conf - the job configuration

Returns:

the SRID. By default 8307.

setAddExtraFields

public static void setAddExtraFields(Configuration conf,
                                     boolean addExtraFields)

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

Parameters:

conf - the job configuration

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

setConf

public void setConf(Configuration conf)

setCurrentRecord

public void setCurrentRecord(LongWritable key,
                             Text 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<LongWritable,Text>

Parameters:

key - A record's key

value - A record's value

setDimensions

public static void setDimensions(Configuration conf,
                                 int dimensions)

Sets the geometries dimensions.

Parameters:

conf - the job configuration

dimensions - the geometries dimensions

setSrid

public static void setSrid(Configuration conf,
                           int srid)

Sets the SRID.

Parameters:

conf - the job configuration

srid - the SRID