Package: PropertiesSpecification

PropertiesSpecification

Coverage

1: /**
2: * Copyright (C) 2019 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.metamodel;
16:
17: /**
18: * Instances of the type PropertiesSpecification represent persistent properties of other types than declared in the
19: * entity type.
20: *
21: * @param <X> The type the represented Map belongs to
22: * @param <E> The declared field type (presumably a {@link java.util.Map})
23: * @param <K> The type used for property identifiers
24: * @param <V> The type used for property values
25: */
26: public interface PropertiesSpecification<X, E, K, V> extends FieldSpecification<X, E> {
27:
28: /**
29: * Gets Java class whose instances are used to represent property identifier.
30: * <p>
31: * Usually {@link java.net.URI} or {@link String}.
32: *
33: * @return Property identifier class
34: */
35: Class<K> getPropertyIdentifierType();
36:
37: /**
38: * Gets Java class whose instances are used to represent property values.
39: * <p>
40: * Usually {@link Object} or {@link String}.
41: *
42: * @return Property value class
43: */
44: Class<V> getPropertyValueType();
45: }