1 /*
2 * *************************************************************************************************************************************************************
3 *
4 * MapView: a JavaFX map renderer for tile-based servers
5 * http://tidalwave.it/projects/mapview
6 *
7 * Copyright (C) 2024 - 2025 by Tidalwave s.a.s. (http://tidalwave.it)
8 *
9 * *************************************************************************************************************************************************************
10 *
11 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
12 * You may obtain a copy of the License at
13 *
14 * http://www.apache.org/licenses/LICENSE-2.0
15 *
16 * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
17 * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
18 *
19 * *************************************************************************************************************************************************************
20 *
21 * git clone https://bitbucket.org/tidalwave/mapview-src
22 * git clone https://github.com/tidalwave-it/mapview-src
23 *
24 * *************************************************************************************************************************************************************
25 */
26 package it.tidalwave.mapviewer.impl;
27
28 import jakarta.annotation.Nonnull;
29 import jakarta.annotation.Nullable;
30 import java.util.Optional;
31 import java.nio.file.Path;
32 import java.net.URI;
33 import it.tidalwave.mapviewer.TileSource;
34
35 /***************************************************************************************************************************************************************
36 *
37 * This abstraction for a tile allows to have more code independent of JavaFX and this more easily testable.
38 *
39 * @author Fabrizio Giudici
40 *
41 **************************************************************************************************************************************************************/
42 public interface AbstractTile
43 {
44 /***********************************************************************************************************************************************************
45 * Sets the image loading it from a given path.
46 * @param imagePath the path of the image
47 * @return the image
48 **********************************************************************************************************************************************************/
49 @Nonnull
50 public Optional<Object> setImageByPath (@Nullable Path imagePath);
51
52 /***********************************************************************************************************************************************************
53 * Sets the image from a given bitmap.
54 * @param bitmap the bitmap (can be {@code null}
55 **********************************************************************************************************************************************************/
56 public void setImageByBitmap (@Nullable Object bitmap);
57
58 /***********************************************************************************************************************************************************
59 * {@return the URI of this tile}.
60 **********************************************************************************************************************************************************/
61 @Nonnull
62 public URI getUri();
63
64 /***********************************************************************************************************************************************************
65 * {@return the source of this tile}.
66 **********************************************************************************************************************************************************/
67 @Nonnull
68 public TileSource getSource();
69
70 /***********************************************************************************************************************************************************
71 * {@return the zoom level of this tile}.
72 **********************************************************************************************************************************************************/
73 public int getZoom();
74 }