org.locationtech.spatial4j.context

Class SpatialContextFactory

java.lang.Object

org.locationtech.spatial4j.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

org.locationtech.spatial4j.context.SpatialContext or org.locationtech.spatial4j.context.jts.JtsSpatialContext

geo

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

shapeFactoryClass

Java class of the ShapeFactory.

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()

readers

Comma separated list of ShapeReader class names

writers

Comma separated list of ShapeWriter class names

binaryCodecClass

Java class of the BinaryCodec

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	hasFormatConfig
boolean	normWrapLongitude
List<Class<? extends ShapeReader>>	readers
Class<? extends ShapeFactory>	shapeFactoryClass
Rectangle	worldBounds
List<Class<? extends ShapeWriter>>	writers

Constructor Summary

Constructors

Constructor and Description
SpatialContextFactory()

Method Summary

Modifier and Type	Method and Description
void	addReaderIfNoggitExists(Class<? extends ShapeReader> reader)
protected void	checkDefaultFormats() If no formats were defined in the config, this will make sure GeoJSON and WKT are registered
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	initFormats() Check args for 'readers' and 'writers'.
protected void	initWorldBounds()
BinaryCodec	makeBinaryCodec(SpatialContext ctx)
SupportedFormats	makeFormats(SpatialContext ctx)
ShapeFactory	makeShapeFactory(SpatialContext ctx)
static SpatialContext	makeSpatialContext(Map<String,String> args, ClassLoader classLoader) Creates a new SpatialContext based on configuration in args.
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

shapeFactoryClass

public Class<? extends ShapeFactory> shapeFactoryClass

binaryCodecClass

public Class<? extends BinaryCodec> binaryCodecClass

readers

public final List<Class<? extends ShapeReader>> readers

writers

public final List<Class<? extends ShapeWriter>> writers

hasFormatConfig

public boolean hasFormatConfig

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()

initFormats

protected void initFormats()

Check args for 'readers' and 'writers'. The value should be a comma separated list of class names. The legacy parameter 'wktShapeParserClass' is also supported to add a specific WKT prarser

makeFormats

public SupportedFormats makeFormats(SpatialContext ctx)

checkDefaultFormats

protected void checkDefaultFormats()

If no formats were defined in the config, this will make sure GeoJSON and WKT are registered

addReaderIfNoggitExists

public void addReaderIfNoggitExists(Class<? extends ShapeReader> reader)

initWorldBounds

protected void initWorldBounds()

newSpatialContext

public SpatialContext newSpatialContext()

Subclasses should simply construct the instance from the initialized configuration.

makeShapeFactory

public ShapeFactory makeShapeFactory(SpatialContext ctx)

makeBinaryCodec

public BinaryCodec makeBinaryCodec(SpatialContext ctx)