-
Notifications
You must be signed in to change notification settings - Fork 2.3k
/
RecordAccess.java
100 lines (80 loc) · 3.16 KB
/
RecordAccess.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
/*
* Copyright (c) 2002-2017 "Neo Technology,"
* Network Engine for Objects in Lund AB [http://neotechnology.com]
*
* This file is part of Neo4j.
*
* Neo4j 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 org.neo4j.kernel.impl.transaction.state;
/**
* Provides access to records, both for reading and for writing.
*/
public interface RecordAccess<KEY,RECORD,ADDITIONAL>
{
/**
* Gets an already loaded record, or loads it as part of this call if it wasn't. The {@link RecordProxy}
* returned has means of communicating when to get access to the actual record for reading or writing.
* With that information any additional loading or storing can be inferred for the specific
* use case (implementation).
*
* @param key the record key.
* @param additionalData additional data to put in the record after loaded.
* @return a {@link RecordProxy} for the record for {@code key}.
*/
RecordProxy<KEY, RECORD, ADDITIONAL> getOrLoad( KEY key, ADDITIONAL additionalData );
RecordProxy<KEY, RECORD, ADDITIONAL> getIfLoaded( KEY key );
RecordProxy<KEY,RECORD,ADDITIONAL> setTo( KEY key, RECORD newRecord, ADDITIONAL additionalData );
/**
* Creates a new record with the given {@code key}. Any {@code additionalData} is set in the
* record before returning.
*
* @param key the record key.
* @param additionalData additional data to put in the record after loaded.
* @return a {@link RecordProxy} for the record for {@code key}.
*/
RecordProxy<KEY, RECORD, ADDITIONAL> create( KEY key, ADDITIONAL additionalData );
/**
* Closes the record access.
*/
void close();
int changeSize();
Iterable<RecordProxy<KEY,RECORD,ADDITIONAL>> changes();
/**
* A proxy for a record that encapsulates load/store actions to take, knowing when the underlying record is
* requested for reading or for writing.
*/
public interface RecordProxy<KEY, RECORD, ADDITIONAL>
{
KEY getKey();
RECORD forChangingLinkage();
RECORD forChangingData();
RECORD forReadingLinkage();
RECORD forReadingData();
ADDITIONAL getAdditionalData();
RECORD getBefore();
boolean isChanged();
boolean isCreated();
}
/**
* Hook for loading and creating records.
*/
public interface Loader<KEY,RECORD,ADDITIONAL>
{
RECORD newUnused( KEY key, ADDITIONAL additionalData );
RECORD load( KEY key, ADDITIONAL additionalData );
void ensureHeavy( RECORD record );
RECORD clone( RECORD record );
}
}