-
Notifications
You must be signed in to change notification settings - Fork 2.3k
/
Read.java
134 lines (109 loc) · 5.13 KB
/
Read.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
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
/*
* 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.internal.kernel.api;
import org.neo4j.internal.kernel.api.exceptions.KernelException;
/**
* Defines the graph read operations of the Kernel.
*/
public interface Read
{
/**
* @param index {@link IndexReference} referencing index to query.
* @param cursor the cursor to use for consuming the results.
* @param indexOrder requested {@link IndexOrder} of result. Must be among the capabilities of {@link IndexReference referenced index}.
* @param query Combination of {@link IndexQuery index queries} to run against referenced index.
*/
void nodeIndexSeek( IndexReference index, NodeValueIndexCursor cursor, IndexOrder indexOrder, IndexQuery... query )
throws KernelException;
void nodeIndexScan( IndexReference index, NodeValueIndexCursor cursor, IndexOrder indexOrder ) throws KernelException;
void nodeLabelScan( int label, NodeLabelIndexCursor cursor );
/**
* Scan for nodes that have a <i>disjunction</i> of the specified labels.
* i.e. MATCH (n) WHERE n:Label1 OR n:Label2 OR ...
*/
void nodeLabelUnionScan( NodeLabelIndexCursor cursor, int... labels );
/**
* Scan for nodes that have a <i>conjunction</i> of the specified labels.
* i.e. MATCH (n) WHERE n:Label1 AND n:Label2 AND ...
*/
void nodeLabelIntersectionScan( NodeLabelIndexCursor cursor, int... labels );
Scan<NodeLabelIndexCursor> nodeLabelScan( int label );
void allNodesScan( NodeCursor cursor );
Scan<NodeCursor> allNodesScan();
/**
* @param reference a reference from {@link NodeCursor#nodeReference()}, {@link
* RelationshipDataAccessor#sourceNodeReference()},
* {@link RelationshipDataAccessor#targetNodeReference()}, {@link NodeIndexCursor#nodeReference()},
* {@link RelationshipIndexCursor#sourceNodeReference()}, or {@link RelationshipIndexCursor#targetNodeReference()}.
* @param cursor the cursor to use for consuming the results.
*/
void singleNode( long reference, NodeCursor cursor );
/**
* @param reference
* a reference from {@link RelationshipDataAccessor#relationshipReference()}.
* @param cursor
* the cursor to use for consuming the results.
*/
void singleRelationship( long reference, RelationshipScanCursor cursor );
void allRelationshipsScan( RelationshipScanCursor cursor );
Scan<RelationshipScanCursor> allRelationshipsScan();
void relationshipLabelScan( int label, RelationshipScanCursor cursor );
Scan<RelationshipScanCursor> relationshipLabelScan( int label );
/**
* @param nodeReference
* a reference from {@link NodeCursor#nodeReference()}.
* @param reference
* a reference from {@link NodeCursor#relationshipGroupReference()}.
* @param cursor
* the cursor to use for consuming the results.
*/
void relationshipGroups( long nodeReference, long reference, RelationshipGroupCursor cursor );
/**
* @param nodeReference
* a reference from {@link NodeCursor#nodeReference()}.
* @param reference
* a reference from {@link RelationshipGroupCursor#outgoingReference()},
* {@link RelationshipGroupCursor#incomingReference()},
* or {@link RelationshipGroupCursor#loopsReference()}.
* @param cursor
* the cursor to use for consuming the results.
*/
void relationships( long nodeReference, long reference, RelationshipTraversalCursor cursor );
/**
* @param reference
* a reference from {@link NodeCursor#propertiesReference()}.
* @param cursor
* the cursor to use for consuming the results.
*/
void nodeProperties( long reference, PropertyCursor cursor );
/**
* @param reference
* a reference from {@link RelationshipDataAccessor#propertiesReference()}.
* @param cursor
* the cursor to use for consuming the results.
*/
void relationshipProperties( long reference, PropertyCursor cursor );
void graphProperties( PropertyCursor cursor );
// hints to the page cache about data we will be accessing in the future:
void futureNodeReferenceRead( long reference );
void futureRelationshipsReferenceRead( long reference );
void futureNodePropertyReferenceRead( long reference );
void futureRelationshipPropertyReferenceRead( long reference );
}