-
Notifications
You must be signed in to change notification settings - Fork 14
/
Attribute.java
101 lines (89 loc) · 3 KB
/
Attribute.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
/**
* Copyright (C) 2016 Czech Technical University in Prague
* <p>
* This program is free software: you can redistribute it and/or modify it under
* the terms of the GNU General Public License as published by the Free Software
* Foundation, either version 3 of the License, or (at your option) any
* later version.
* <p>
* This program is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
* details. You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
package cz.cvut.kbss.jopa.model.metamodel;
import cz.cvut.kbss.jopa.NonJPA;
import cz.cvut.kbss.jopa.UnusedJPA;
import cz.cvut.kbss.jopa.model.IRI;
import cz.cvut.kbss.jopa.model.annotations.CascadeType;
import cz.cvut.kbss.jopa.model.annotations.ParticipationConstraint;
/**
* Represents an attribute of a Java type.
*
* @param <X> The represented type that contains the attribute
* @param <Y> The type of the represented attribute
*/
public interface Attribute<X, Y> extends FieldSpecification<X, Y> {
enum PersistentAttributeType {
/**
* correspond to the object properties
*/
@NonJPA
DATA,
/**
* correspond to the object properties
*/
@NonJPA
OBJECT,
/**
* correspond to the object properties
*/
@NonJPA
ANNOTATION,
}
/**
* Return the persistent attribute type for the attribute.
*
* @return persistent attribute type
*/
PersistentAttributeType getPersistentAttributeType();
/**
* Return the java.lang.reflect.Member for the represented attribute.
*
* @return corresponding java.lang.reflect.Member
*/
@UnusedJPA
java.lang.reflect.Member getJavaMember();
/**
* Return the java.lang.reflect.Member for the represented attribute.
*
* @return corresponding java.lang.reflect.Member
*/
@NonJPA
IRI getIRI();
/**
* Return the set of cascade types specified for this attribute.
*
* @return corresponding array of cascade types. This method returns an empty array if no cascade type is specified.
* @throws IllegalArgumentException if getPersistentAttributeType() returns DATA or ANNOTATION.
*/
@NonJPA
CascadeType[] getCascadeTypes();
/**
* Is the attribute an association.
*
* @return boolean indicating whether the attribute corresponds to an association
*/
boolean isAssociation();
/**
* Whether the attribute can be without value.
* <p>
* Note that if {@link #getConstraints()} contains {@link ParticipationConstraint}s, this property should be
* ignored.
*
* @return boolean indicating whether the attribute can be empty
*/
boolean isNonEmpty();
ParticipationConstraint[] getConstraints();
}