-
Notifications
You must be signed in to change notification settings - Fork 14
/
FieldSpecification.java
87 lines (77 loc) · 2.39 KB
/
FieldSpecification.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
/**
* Copyright (C) 2019 Czech Technical University in Prague
*
* 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.
*
* 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.model.annotations.FetchType;
/**
* Specifies a field of a managed type.
* @param <X> Declaring class
* @param <E> Type of the field
*/
public interface FieldSpecification<X, E> {
/**
* Return the managed type representing the type in which the attribute was
* declared.
*
* @return declaring type
*/
ManagedType<X> getDeclaringType();
/**
* Return the Java type of the represented attribute.
*
* @return Java type
*/
Class<E> getJavaType();
/**
* Return the java.lang.reflect.Member for the represented attribute.
*
* @return corresponding java.lang.reflect.Member
*/
@NonJPA
java.lang.reflect.Field getJavaField();
/**
* Whether the association is lazily loaded or must be eagerly fetched.
*
* @return Fetch type of the field specification
*/
@NonJPA
FetchType getFetchType();
/**
* Whether this field can contain inferred data.
*
* @return Whether field is inferred
* @see #includeExplicit()
*/
boolean isInferred();
/**
* If this field is inferred, can it contain explicit data as well?
*
* @return Whether inferred field can contain explicit knowledge
* @see #isInferred()
*/
boolean includeExplicit();
/**
* Return the name of the attribute.
*
* @return name
*/
String getName();
/**
* Is the attribute collection-valued (represents a Collection, Set, List, or Map).
*
* @return boolean indicating whether the attribute is collection-valued
*/
boolean isCollection();
}