com.spatial4j.core.context

Class SpatialContextFactory

java.lang.Object

com.spatial4j.core.context.SpatialContextFactory

Direct Known Subclasses:

JtsSpatialContextFactory

public class SpatialContextFactory
extends Object

Factory for a SpatialContext based on configuration data. Call makeSpatialContext(java.util.Map, ClassLoader) to construct one via String name-value pairs. To construct one via code then create a factory instance, set the fields, then call newSpatialContext().

The following keys are looked up in the args map:

spatialContextFactory

com.spatial4j.core.context.SpatialContext or com.spatial4j.core.context.jts.JtsSpatialContext

geo

true (default)| false -- see SpatialContext.isGeo()

distCalculator

haversine | lawOfCosines | vincentySphere | cartesian | cartesian^2 -- see DistanceCalculator

worldBounds

ENVELOPE(xMin, xMax, yMax, yMin) -- see SpatialContext.getWorldBounds()

normWrapLongitude

true | false (default) -- see SpatialContext.isNormWrapLongitude()

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,String>	args Set by makeSpatialContext(java.util.Map, ClassLoader).
Class<? extends BinaryCodec>	binaryCodecClass
protected ClassLoader	classLoader Set by makeSpatialContext(java.util.Map, ClassLoader).
DistanceCalculator	distCalc
boolean	geo
boolean	normWrapLongitude
Class<? extends WktShapeParser>	wktShapeParserClass
Rectangle	worldBounds

Constructor Summary

Constructors

Constructor and Description
SpatialContextFactory()

Method Summary

Modifier and Type	Method and Description
protected void	init(Map<String,String> args, ClassLoader classLoader)
protected void	initCalculator()
protected void	initField(String name) Gets name from args and populates a field by the same name with the value.
protected void	initWorldBounds()
BinaryCodec	makeBinaryCodec(SpatialContext ctx)
static SpatialContext	makeSpatialContext(Map<String,String> args, ClassLoader classLoader) Creates a new SpatialContext based on configuration in args.
WktShapeParser	makeWktShapeParser(SpatialContext ctx)
SpatialContext	newSpatialContext() Subclasses should simply construct the instance from the initialized configuration.

Methods inherited from class java.lang.Object

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

Field Detail

args

protected Map<String,String> args

Set by makeSpatialContext(java.util.Map, ClassLoader).

classLoader

protected ClassLoader classLoader

Set by makeSpatialContext(java.util.Map, ClassLoader).

geo

public boolean geo

distCalc

public DistanceCalculator distCalc

worldBounds

public Rectangle worldBounds

normWrapLongitude

public boolean normWrapLongitude

wktShapeParserClass

public Class<? extends WktShapeParser> wktShapeParserClass

binaryCodecClass

public Class<? extends BinaryCodec> binaryCodecClass

Constructor Detail

SpatialContextFactory

public SpatialContextFactory()

Method Detail

makeSpatialContext

public static SpatialContext makeSpatialContext(Map<String,String> args,
                                                ClassLoader classLoader)

Creates a new SpatialContext based on configuration in args. See the class definition for what keys are looked up in it. The factory class is looked up via "spatialContextFactory" in args then falling back to a Java system property (with initial caps). If neither are specified then SpatialContextFactory is chosen.

Parameters:

args - Non-null map of name-value pairs.

classLoader - Optional, except when a class name is provided to an argument.

init

protected void init(Map<String,String> args,
                    ClassLoader classLoader)

initField

protected void initField(String name)

Gets name from args and populates a field by the same name with the value.

initCalculator

protected void initCalculator()

initWorldBounds

protected void initWorldBounds()

newSpatialContext

public SpatialContext newSpatialContext()

Subclasses should simply construct the instance from the initialized configuration.

makeWktShapeParser

public WktShapeParser makeWktShapeParser(SpatialContext ctx)

makeBinaryCodec

public BinaryCodec makeBinaryCodec(SpatialContext ctx)