Package: SingularAttribute

SingularAttribute

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: import cz.cvut.kbss.jopa.UnusedJPA;
21:
22: /**
23: * Instances of the type SingularAttribute represents persistent single-valued
24: * properties or fields.
25: *
26: * @param <X>
27: * The type containing the represented attribute
28: * @param <T>
29: * The type of the represented attribute
30: */
31: public interface SingularAttribute<X, T> extends Attribute<X, T>, Bindable<T> {
32:
33: /**
34: * Is the attribute an id attribute. This method will return true if the
35: * attribute is an attribute that corresponds to a simple id, an embedded
36: * id, or an attribute of an id class.
37: *
38: * @return boolean indicating whether the attribute is an id
39: */
40: boolean isId();
41:
42: /**
43: * Is the attribute a version attribute.
44: *
45: * @return boolean indicating whether the attribute is a version attribute
46: */
47: @UnusedJPA
48: boolean isVersion();
49:
50: /**
51: * Return the type that represents the type of the attribute.
52: *
53: * @return type of attribute
54: */
55: Type<T> getType();
56: }