Package io.jmix.mapsflowui.component.model.source

Class DataVectorSource<E>

java.lang.Object

io.jmix.mapsflowui.kit.component.model.MapObservableObject

io.jmix.mapsflowui.kit.component.model.source.Source

io.jmix.mapsflowui.kit.component.model.source.AbstractVectorSource

io.jmix.mapsflowui.component.model.source.AbstractDataVectorSource<E>

io.jmix.mapsflowui.component.model.source.DataVectorSource<E>

Type Parameters:

E - item type

All Implemented Interfaces:

GeoObjectClickNotifier<E>, AbstractVectorSource.HasOverlaps, AbstractVectorSource.HasUseSpatialIndex, AbstractVectorSource.HasVectorSourceOptions, Source.HasAttributions, Source.HasWrapX, Serializable, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

public class DataVectorSource<E>
extends AbstractDataVectorSource<E>
implements AbstractVectorSource.HasVectorSourceOptions, org.springframework.context.ApplicationContextAware, GeoObjectClickNotifier<E>

A source containing geo-objects (entities having a property of a Geometry type).

This source acts as a connector between the data (geo-objects provided by DataVectorSourceItems interface implementation) and the map UI component. It carries the data along with some additional information on how the geo-objects should be displayed on a map.

See Also:

• VectorLayer
• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class io.jmix.mapsflowui.kit.component.model.source.AbstractVectorSource

AbstractVectorSource.HasOverlaps, AbstractVectorSource.HasUseSpatialIndex, AbstractVectorSource.HasVectorSourceOptions

Nested classes/interfaces inherited from class io.jmix.mapsflowui.kit.component.model.source.Source

Source.HasAttributions, Source.HasAttributionsCollapsible, Source.HasProjection, Source.HasSourceOptions, Source.HasWrapX

Nested classes/interfaces inherited from class io.jmix.mapsflowui.kit.component.model.MapObservableObject

MapObservableObject.ObjectChangeEvent

Nested classes/interfaces inherited from interface io.jmix.mapsflowui.component.model.source.GeoObjectClickNotifier

GeoObjectClickNotifier.AbstractGeoObjectClickEvent<E>, GeoObjectClickNotifier.GeoObjectClickEvent<E>, GeoObjectClickNotifier.GeoObjectDoubleClickEvent<E>, GeoObjectClickNotifier.GeoObjectSingleClickEvent<E>

Field Summary

Fields

Modifier and Type	Field	Description
protected org.springframework.context.ApplicationContext	applicationContext
protected AbstractDataVectorSourceBinding<E>	binder
protected Function<? super E,Style>	styleProvider

Fields inherited from class io.jmix.mapsflowui.component.model.source.AbstractDataVectorSource

items

Fields inherited from class io.jmix.mapsflowui.kit.component.model.source.AbstractVectorSource

overlaps, useSpatialIndex

Fields inherited from class io.jmix.mapsflowui.kit.component.model.source.Source

attributions, attributionsCollapsible, id, projection, wrapX

Fields inherited from class io.jmix.mapsflowui.kit.component.model.MapObservableObject

children, dirty, eventBus, listener, metaProperties, parent, removedChildren, syncId

Constructor Summary

Constructors

Constructor	Description
DataVectorSource()

Method Summary

Modifier and Type	Method	Description
com.vaadin.flow.shared.Registration	addGeoObjectClickListener(Consumer<GeoObjectClickNotifier.GeoObjectClickEvent<E>> listener)	Adds geo-object click listener.
com.vaadin.flow.shared.Registration	addGeoObjectDoubleClickListener(Consumer<GeoObjectClickNotifier.GeoObjectDoubleClickEvent<E>> listener)	Adds geo-object double click listener.
com.vaadin.flow.shared.Registration	addGeoObjectSingleClickListener(Consumer<GeoObjectClickNotifier.GeoObjectSingleClickEvent<E>> listener)	Adds geo-object single click listener.
protected void	bindItems()
Boolean	getOverlaps()
Function<? super E,Style>	getStyleProvider()
Boolean	getUseSpatialIndex()
void	setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
void	setOverlaps(Boolean overlaps)	Sets whether source may have overlapping geometries.
void	setStyleProvider(Function<? super E,Style> styleProvider)	Sets the style provider for a layer's geo-objects, i.e.
void	setUseSpatialIndex(Boolean useSpatialIndex)	Sets whether to use spatial index.
protected void	unbindItems()
DataVectorSource<E>	withAttributions(List<String> attributions)	See AbstractDataVectorSource.setAttributions(List).
DataVectorSource<E>	withItems(DataVectorSourceItems<E> items)	See AbstractDataVectorSource.setItems(DataVectorSourceItems).
DataVectorSource<E>	withOverlaps(Boolean overlaps)	See setOverlaps(Boolean).
DataVectorSource<E>	withStyleProvider(Function<? super E,Style> styleProvider)	See setStyleProvider(Function).
DataVectorSource<E>	withUseSpatialIndex(Boolean useSpatialIndex)	See setUseSpatialIndex(Boolean).
DataVectorSource<E>	withWrapX(Boolean wrapX)	See AbstractDataVectorSource.setWrapX(Boolean).

Methods inherited from class io.jmix.mapsflowui.component.model.source.AbstractDataVectorSource

getAttributions, getItems, getType, getWrapX, setAttributions, setItems, setWrapX

Methods inherited from class io.jmix.mapsflowui.kit.component.model.source.Source

getAttributionsCollapsible, getId, getProjection, setAttributionsCollapsible, setId, setProjection

Methods inherited from class io.jmix.mapsflowui.kit.component.model.MapObservableObject

addChild, addListener, clearRemovedChildren, clearRemovedChildrenInDepth, equals, fireChangeEvent, getChildren, getEventBus, getMetaProperties, getRemovedChildren, getSyncId, hashCode, isDirty, isDirtyInDepth, markAsDirty, markAsDirtyInDepth, removeChild, setMapObjectChangeListener, setMetaProperty, setParent, unmarkDirtyInDepth

Methods inherited from class java.lang.Object

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

Field Details

applicationContext

protected org.springframework.context.ApplicationContext applicationContext

binder

protected AbstractDataVectorSourceBinding<E> binder

styleProvider

protected Function<? super E,Style> styleProvider

Constructor Details

DataVectorSource

public DataVectorSource()

Method Details

setApplicationContext

public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
                           throws org.springframework.beans.BeansException

Specified by:

setApplicationContext in interface org.springframework.context.ApplicationContextAware

Throws:

org.springframework.beans.BeansException

getStyleProvider

@Nullable
public Function<? super E,Style> getStyleProvider()

Returns:

style provider for a layer's geo-objects or null if not set

setStyleProvider

public void setStyleProvider(@Nullable
 Function<? super E,Style> styleProvider)

Sets the style provider for a layer's geo-objects, i.e. function that determines style for a corresponding entity's geometry that is displayed on a map.

Function should return fully described style for geo-object, otherwise, it may be not displayed. The provided style replaces existing styles in a feature.

For instance, source contains geo-objects for entity with Point datatype. For this datatype map renders MarkerFeature that has default style with icon. So to add, let's say, text under the icon, new style should contain the icon definition too. To achieve this we can create default marker style using MarkerStyle.createDefaultStyle() and edit it:

 source.setStyleProvider(shop ->
         MarkerStyle.createDefaultStyle()
                 .withText(new TextStyle()
                         .withText(shop.getName())
                         .withFont("15px sans-serif")
                         .withOffsetY(10)));
 

Parameters:

styleProvider - function that takes an entity as an argument and produces a Style for the entity's geometry

getOverlaps

public Boolean getOverlaps()

Specified by:

getOverlaps in interface AbstractVectorSource.HasOverlaps

Overrides:

getOverlaps in class AbstractVectorSource

Returns:

overlaps value or null if not set

setOverlaps

public void setOverlaps(Boolean overlaps)

Description copied from interface: AbstractVectorSource.HasOverlaps

Sets whether source may have overlapping geometries. The default value is true.

Setting this to false (e.g. for sources with polygons that represent administrative boundaries) allows the renderer to optimise fill and stroke operations.

Note, overlaps attribute is set only at creation time and cannot be changed at runtime.

Specified by:

setOverlaps in interface AbstractVectorSource.HasOverlaps

Overrides:

setOverlaps in class AbstractVectorSource

Parameters:

overlaps - overlaps option

getUseSpatialIndex

public Boolean getUseSpatialIndex()

Specified by:

getUseSpatialIndex in interface AbstractVectorSource.HasUseSpatialIndex

Overrides:

getUseSpatialIndex in class AbstractVectorSource

Returns:

useSpatialIndex value or null if not set

setUseSpatialIndex

public void setUseSpatialIndex(Boolean useSpatialIndex)

Description copied from interface: AbstractVectorSource.HasUseSpatialIndex

Sets whether to use spatial index. When features are removed and added frequently, and the total number of features is low, setting this to false may improve performance. The default value is true.

Specified by:

setUseSpatialIndex in interface AbstractVectorSource.HasUseSpatialIndex

Overrides:

setUseSpatialIndex in class AbstractVectorSource

Parameters:

useSpatialIndex - whether to use spatial index

addGeoObjectClickListener

public com.vaadin.flow.shared.Registration addGeoObjectClickListener(Consumer<GeoObjectClickNotifier.GeoObjectClickEvent<E>> listener)

Description copied from interface: GeoObjectClickNotifier

Adds geo-object click listener. Note, if the user makes double click, the GeoObjectClickNotifier.GeoObjectClickEvent will be fired twice.

Specified by:

addGeoObjectClickListener in interface GeoObjectClickNotifier<E>

Parameters:

listener - listener to add

Returns:

a registration object for removing an event listener

addGeoObjectSingleClickListener

public com.vaadin.flow.shared.Registration addGeoObjectSingleClickListener(Consumer<GeoObjectClickNotifier.GeoObjectSingleClickEvent<E>> listener)

Description copied from interface: GeoObjectClickNotifier

Adds geo-object single click listener. Single click means that an event won't be fired if the user makes double click.

Specified by:

addGeoObjectSingleClickListener in interface GeoObjectClickNotifier<E>

Parameters:

listener - listener to add

Returns:

a registration object for removing an event listener

addGeoObjectDoubleClickListener

public com.vaadin.flow.shared.Registration addGeoObjectDoubleClickListener(Consumer<GeoObjectClickNotifier.GeoObjectDoubleClickEvent<E>> listener)

Description copied from interface: GeoObjectClickNotifier

Adds geo-object double click listener.

Specified by:

addGeoObjectDoubleClickListener in interface GeoObjectClickNotifier<E>

Parameters:

listener - listener to add

Returns:

a registration object for removing an event listener

withOverlaps

public DataVectorSource<E> withOverlaps(Boolean overlaps)

See setOverlaps(Boolean).

Parameters:

overlaps - overlaps option

Returns:

current instance

withUseSpatialIndex

public DataVectorSource<E> withUseSpatialIndex(Boolean useSpatialIndex)

See setUseSpatialIndex(Boolean).

Parameters:

useSpatialIndex - whether to use spatial index

Returns:

current instance

withStyleProvider

public DataVectorSource<E> withStyleProvider(@Nullable
 Function<? super E,Style> styleProvider)

See setStyleProvider(Function).

Parameters:

styleProvider - function that takes an entity as an argument and produces a Style for the entity's geometry

Returns:

current instance

withAttributions

public DataVectorSource<E> withAttributions(List<String> attributions)

See AbstractDataVectorSource.setAttributions(List).

Parameters:

attributions - info about copyrights and licences

Returns:

current instance

withWrapX

public DataVectorSource<E> withWrapX(Boolean wrapX)

See AbstractDataVectorSource.setWrapX(Boolean).

Parameters:

wrapX - whether the source should be looped along the X coordinate

Returns:

current instance

withItems

public DataVectorSource<E> withItems(@Nullable
 DataVectorSourceItems<E> items)

See AbstractDataVectorSource.setItems(DataVectorSourceItems).

Parameters:

items - items to set

Returns:

current instance

unbindItems

protected void unbindItems()

Specified by:

unbindItems in class AbstractDataVectorSource<E>

bindItems

protected void bindItems()

Specified by:

bindItems in class AbstractDataVectorSource<E>