Package: PropertiesSpecification

PropertiesSpecification

Coverage

1: /*
2: * JOPA
3: * Copyright (C) 2024 Czech Technical University in Prague
4: *
5: * This library is free software; you can redistribute it and/or
6: * modify it under the terms of the GNU Lesser General Public
7: * License as published by the Free Software Foundation; either
8: * version 3.0 of the License, or (at your option) any later version.
9: *
10: * This library is distributed in the hope that it will be useful,
11: * but WITHOUT ANY WARRANTY; without even the implied warranty of
12: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13: * Lesser General Public License for more details.
14: *
15: * You should have received a copy of the GNU Lesser General Public
16: * License along with this library.
17: */
18: package cz.cvut.kbss.jopa.model.metamodel;
19:
20: /**
21: * Instances of the type PropertiesSpecification represent persistent properties of other types than declared in the
22: * entity type.
23: *
24: * @param <X> The type the represented Map belongs to
25: * @param <E> The declared field type (presumably a {@link java.util.Map})
26: * @param <K> The type used for property identifiers
27: * @param <V> The type used for property values
28: */
29: public interface PropertiesSpecification<X, E, K, V> extends FieldSpecification<X, E> {
30:
31: /**
32: * Gets Java class whose instances are used to represent property identifier.
33: * <p>
34: * Usually {@link java.net.URI} or {@link String}.
35: *
36: * @return Property identifier class
37: */
38: Class<K> getPropertyIdentifierType();
39:
40: /**
41: * Gets Java class whose instances are used to represent property values.
42: * <p>
43: * Usually {@link Object} or {@link String}.
44: *
45: * @return Property value class
46: */
47: Class<V> getPropertyValueType();
48: }