Package org.openstreetmap.atlas.mutator.configuration.parsing.provider

Interface AtlasProvider

All Superinterfaces:

java.util.function.BiFunction<java.lang.String,org.openstreetmap.atlas.geography.sharding.Shard,java.util.Optional<org.openstreetmap.atlas.geography.atlas.Atlas>>, java.io.Serializable

All Known Implementing Classes:

AbstractFileAtlasProvider, AtlasFileAtlasProvider, PbfRawAtlasProvider

public interface AtlasProvider
extends java.util.function.BiFunction<java.lang.String,org.openstreetmap.atlas.geography.sharding.Shard,java.util.Optional<org.openstreetmap.atlas.geography.atlas.Atlas>>, java.io.Serializable

A specific interface for a function that takes a country code and shard and makes it an Atlas object optional. This type can be inferred at runtime from the class name in a configuration file provided that the implementation has a default constructor which takes a Configuration object.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	AtlasProvider.AtlasProviderConstants

Method Summary

Modifier and Type	Method	Description
static AtlasProvider	defaultProvider()
static AtlasProvider	from(java.lang.String className, org.openstreetmap.atlas.utilities.configuration.Configuration configuration)
default void	setAtlasProviderContext(java.util.Map<java.lang.String,java.lang.Object> context)	Provide more generic runtime context to the AtlasProvider, this method to be used right before running the dependent mutation.

Methods inherited from interface java.util.function.BiFunction

andThen, apply

Method Detail

defaultProvider

static AtlasProvider defaultProvider()

from

static AtlasProvider from(java.lang.String className,
                          org.openstreetmap.atlas.utilities.configuration.Configuration configuration)

setAtlasProviderContext

default void setAtlasProviderContext(java.util.Map<java.lang.String,java.lang.Object> context)

Provide more generic runtime context to the AtlasProvider, this method to be used right before running the dependent mutation.

Parameters:

context - Generic context that is needed by the provider