Package: MediaFileSystem

MediaFileSystem

Coverage

1: /*
2: * *********************************************************************************************************************
3: *
4: * blueMarine II: Semantic Media Centre
5: * http://tidalwave.it/projects/bluemarine2
6: *
7: * Copyright (C) 2015 - 2021 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
12: * the License. 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
17: * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
18: * specific language governing permissions and limitations under the License.
19: *
20: * *********************************************************************************************************************
21: *
22: * git clone https://bitbucket.org/tidalwave/bluemarine2-src
23: * git clone https://github.com/tidalwave-it/bluemarine2-src
24: *
25: * *********************************************************************************************************************
26: */
27: package it.tidalwave.bluemarine2.model;
28:
29: import javax.annotation.Nonnull;
30: import java.nio.file.Path;
31: import org.springframework.core.annotation.Order;
32: import it.tidalwave.bluemarine2.model.role.EntityBrowser;
33: import it.tidalwave.bluemarine2.model.spi.Entity;
34:
35: /***********************************************************************************************************************
36: *
37: * Represents a file system (even a virtual one) that contains {@link MediaFolder}s and {@link MediaItem}s.
38: *
39: * @stereotype Datum
40: *
41: * @author Fabrizio Giudici
42: *
43: **********************************************************************************************************************/
44: @Order(50) // FIXME: perhaps we should separate a subclass that implements EntityBrowser
45: public interface MediaFileSystem extends Entity, EntityBrowser
46: {
47: /*******************************************************************************************************************
48: *
49: * Returns the root {@link MediaFolder}.
50: *
51: * @return the path
52: *
53: ******************************************************************************************************************/
54: @Override @Nonnull // FIXME: this declaration could be dropped if we don't need covariance on return type
55: public MediaFolder getRoot();
56:
57: @Nonnull
58: public Path getRootPath();
59: }