Method: getRelativePath()

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.spi;
28:
29: import javax.annotation.Nonnull;
30: import java.util.Optional;
31: import java.nio.file.Path;
32:
33: /***********************************************************************************************************************
34: *
35: * A specialisation of {@link Entity} that has, or can have, a parent - hence, a {@link Path}.
36: *
37: * @stereotype Datum
38: *
39: * @author Fabrizio Giudici
40: *
41: **********************************************************************************************************************/
42: public interface PathAwareEntity extends Entity
43: {
44: public static final Class<PathAwareEntity> _PathAwareEntity_ = PathAwareEntity.class;
45:
46: /*******************************************************************************************************************
47: *
48: * Returns the optional parent of this object.
49: *
50: * @return the parent
51: *
52: ******************************************************************************************************************/
53: @Nonnull
54: public Optional<PathAwareEntity> getParent();
55:
56: /*******************************************************************************************************************
57: *
58: * Returns the {@link Path} associated with this entity.
59: *
60: * @see #getRelativePath()
61: *
62: * @return the path
63: *
64: ******************************************************************************************************************/
65: @Nonnull
66: public Path getPath();
67:
68: /*******************************************************************************************************************
69: *
70: * Returns the relative path of this entity. For instances without a parent, this method returns the same value as
71: * {@link #getPath()}.
72: *
73: * @see #getPath()
74: *
75: * @return the relative path
76: *
77: ******************************************************************************************************************/
78: @Nonnull
79: public default Path getRelativePath()
80: {
81: return getParent().map(parent -> parent.getPath().relativize(getPath())).orElse(getPath());
82: }
83: }