Package: Properties

Properties

Coverage

1: /**
2: * Copyright (C) 2022 Czech Technical University in Prague
3: *
4: * This program is free software: you can redistribute it and/or modify it under
5: * the terms of the GNU General Public License as published by the Free Software
6: * Foundation, either version 3 of the License, or (at your option) any
7: * later version.
8: *
9: * This program is distributed in the hope that it will be useful, but WITHOUT
10: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
11: * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
12: * details. You should have received a copy of the GNU General Public License
13: * along with this program. If not, see <http://www.gnu.org/licenses/>.
14: */
15: package cz.cvut.kbss.jopa.model.annotations;
16:
17: import java.lang.annotation.*;
18:
19: /**
20: * Denotes an attribute containing values of unmapped properties relevant for an entity.
21: * <p>
22: * The attribute has to be a {@link java.util.Map} of keys which are of a valid identifier type and represent
23: * ontological properties, e.g. {@link String}, and {@link java.util.Set}s of values of the properties. The type of the
24: * values can be either {@link String} or it can be {@link Object}, in which case the respective ontological type will
25: * be retained.
26: * <p>
27: * For example:
28: *
29: * <pre><code>Map<String, Set<String>></code></pre>
30: * <pre><code>Map<URI, Set<Object>></code></pre>
31: */
32: @Documented
33: @Retention(RetentionPolicy.RUNTIME)
34: @Target(ElementType.FIELD)
35: public @interface Properties {
36:
37: FetchType fetchType() default FetchType.LAZY;
38:
39: /**
40: * Denotes a member that is inferred (true) using the OWL reasoner or just asserted (false).
41: *
42: * @return Whether this property is read only
43: */
44: boolean readOnly() default false;
45: }