Package: SourceAwareFinder

SourceAwareFinder

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.spi;
28:
29: import javax.annotation.Nonnull;
30: import java.util.Optional;
31: import it.tidalwave.util.Id;
32:
33: /***********************************************************************************************************************
34: *
35: * @author Fabrizio Giudici
36: *
37: **********************************************************************************************************************/
38: public interface SourceAwareFinder<ENTITY, FINDER> // extends ExtendedFinderSupport<ENTITY, BaseFinder<ENTITY, FINDER>>
39: {
40: @Nonnull
41: public FINDER withId (@Nonnull final Id id);
42:
43: /*******************************************************************************************************************
44: *
45: * Specifies the data source of this finder.
46: *
47: * @param source the source
48: * @return the {@code Finder}, in fluent fashion
49: *
50: ******************************************************************************************************************/
51: @Nonnull
52: public FINDER importedFrom (@Nonnull final Id source);
53:
54: /*******************************************************************************************************************
55: *
56: * Specifies the data source of this finder.
57: *
58: * @param optionalSource the source
59: * @return the {@code Finder}, in fluent fashion
60: *
61: ******************************************************************************************************************/
62: @Nonnull
63: public FINDER importedFrom (@Nonnull final Optional<Id> optionalSource);
64:
65: /*******************************************************************************************************************
66: *
67: * Specifies the fallback data source of this finder.
68: *
69: * @param fallback the fallback source
70: * @return the {@code Finder}, in fluent fashion
71: *
72: ******************************************************************************************************************/
73: @Nonnull
74: public FINDER withFallback (@Nonnull final Id fallback);
75:
76: /*******************************************************************************************************************
77: *
78: * Specifies the fallback data source of this finder.
79: *
80: * @param optionalFallback the fallback source
81: * @return the {@code Finder}, in fluent fashion
82: *
83: ******************************************************************************************************************/
84: @Nonnull
85: public FINDER withFallback (@Nonnull final Optional<Id> optionalFallback);
86: }