1 | // License: GPL. For details, see LICENSE file.
|
---|
2 | package org.openstreetmap.josm.gui.layer;
|
---|
3 |
|
---|
4 | import java.io.File;
|
---|
5 | import java.io.IOException;
|
---|
6 |
|
---|
7 | import org.openstreetmap.josm.data.Data;
|
---|
8 | import org.openstreetmap.josm.data.osm.Lockable;
|
---|
9 | import org.openstreetmap.josm.gui.io.AbstractIOTask;
|
---|
10 | import org.openstreetmap.josm.gui.io.AbstractUploadDialog;
|
---|
11 | import org.openstreetmap.josm.gui.progress.ProgressMonitor;
|
---|
12 |
|
---|
13 | /**
|
---|
14 | * A modifiable layer.
|
---|
15 | * @since 7358
|
---|
16 | */
|
---|
17 | public abstract class AbstractModifiableLayer extends Layer implements DownloadFromServer, UploadToServer, SaveToFile, Lockable {
|
---|
18 |
|
---|
19 | /**
|
---|
20 | * Property used to know if this layer has to be saved on disk.
|
---|
21 | * @since 18287
|
---|
22 | */
|
---|
23 | public static final String REQUIRES_SAVE_TO_DISK_PROP = AbstractModifiableLayer.class.getName() + ".requiresSaveToDisk";
|
---|
24 | static final String IS_DIRTY_SYMBOL = "*";
|
---|
25 |
|
---|
26 | /**
|
---|
27 | * Constructs a new {@code ModifiableLayer}.
|
---|
28 | * @param name Layer name
|
---|
29 | */
|
---|
30 | protected AbstractModifiableLayer(String name) {
|
---|
31 | super(name);
|
---|
32 | }
|
---|
33 |
|
---|
34 | @Override
|
---|
35 | public boolean isDownloadable() {
|
---|
36 | // Override if needed
|
---|
37 | return false;
|
---|
38 | }
|
---|
39 |
|
---|
40 | @Override
|
---|
41 | public boolean isUploadable() {
|
---|
42 | // Override if needed
|
---|
43 | return false;
|
---|
44 | }
|
---|
45 |
|
---|
46 | @Override
|
---|
47 | public boolean requiresUploadToServer() {
|
---|
48 | // Override if needed
|
---|
49 | return false;
|
---|
50 | }
|
---|
51 |
|
---|
52 | @Override
|
---|
53 | public boolean requiresSaveToFile() {
|
---|
54 | // Override if needed
|
---|
55 | return false;
|
---|
56 | }
|
---|
57 |
|
---|
58 | @Override
|
---|
59 | public boolean isUploadDiscouraged() {
|
---|
60 | // Override if needed
|
---|
61 | return false;
|
---|
62 | }
|
---|
63 |
|
---|
64 | /**
|
---|
65 | * Determines if this layer is "dirty", i.e. requires save or upload
|
---|
66 | * @return if this layer is "dirty"
|
---|
67 | * @since 18287
|
---|
68 | */
|
---|
69 | public boolean isDirty() {
|
---|
70 | // Override if needed
|
---|
71 | return requiresSaveToFile() || (requiresUploadToServer() && !isUploadDiscouraged());
|
---|
72 | }
|
---|
73 |
|
---|
74 | /**
|
---|
75 | * Determines if data managed by this layer has been modified.
|
---|
76 | * @return true if data has been modified; false, otherwise
|
---|
77 | */
|
---|
78 | public abstract boolean isModified();
|
---|
79 |
|
---|
80 | @Override
|
---|
81 | public void onPostSaveToFile() {
|
---|
82 | // Override if needed
|
---|
83 | }
|
---|
84 |
|
---|
85 | /**
|
---|
86 | * Initializes the layer after a successful upload to the server.
|
---|
87 | */
|
---|
88 | @Override
|
---|
89 | public void onPostUploadToServer() {
|
---|
90 | // Override if needed
|
---|
91 | }
|
---|
92 |
|
---|
93 | @Override
|
---|
94 | public AbstractIOTask createUploadTask(ProgressMonitor monitor) {
|
---|
95 | // Override if needed
|
---|
96 | return null;
|
---|
97 | }
|
---|
98 |
|
---|
99 | @Override
|
---|
100 | public AbstractUploadDialog getUploadDialog() {
|
---|
101 | // Override if needed
|
---|
102 | return null;
|
---|
103 | }
|
---|
104 |
|
---|
105 | @Override
|
---|
106 | public boolean isUploadInProgress() {
|
---|
107 | // Override if needed
|
---|
108 | return false;
|
---|
109 | }
|
---|
110 |
|
---|
111 | @Override
|
---|
112 | public void lock() {
|
---|
113 | // Override if needed
|
---|
114 | }
|
---|
115 |
|
---|
116 | @Override
|
---|
117 | public void unlock() {
|
---|
118 | // Override if needed
|
---|
119 | }
|
---|
120 |
|
---|
121 | @Override
|
---|
122 | public boolean isLocked() {
|
---|
123 | // Override if needed
|
---|
124 | return false;
|
---|
125 | }
|
---|
126 |
|
---|
127 | /**
|
---|
128 | * Perform the autosave action for the layer
|
---|
129 | *
|
---|
130 | * @param file The file to save to
|
---|
131 | * @return {@code true} if the layer was successfully saved
|
---|
132 | * @throws IOException If there was an IO exception from saving
|
---|
133 | * @since 16548
|
---|
134 | */
|
---|
135 | public boolean autosave(File file) throws IOException {
|
---|
136 | // Override if needed;
|
---|
137 | return false;
|
---|
138 | }
|
---|
139 |
|
---|
140 | /**
|
---|
141 | * Get the data for the modifiable layer
|
---|
142 | *
|
---|
143 | * @return The data object
|
---|
144 | * @since 16548
|
---|
145 | */
|
---|
146 | public Data getData() {
|
---|
147 | // Override if needed;
|
---|
148 | return null;
|
---|
149 | }
|
---|
150 | }
|
---|