-
Notifications
You must be signed in to change notification settings - Fork 2.3k
/
IndexStoreView.java
144 lines (125 loc) · 5.04 KB
/
IndexStoreView.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
135
136
137
138
139
140
141
142
143
144
/*
* Copyright (c) 2002-2018 "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.api.index;
import java.util.function.IntPredicate;
import org.neo4j.collection.primitive.PrimitiveIntSet;
import org.neo4j.helpers.collection.Visitor;
import org.neo4j.kernel.api.exceptions.EntityNotFoundException;
import org.neo4j.kernel.api.index.PropertyAccessor;
import org.neo4j.kernel.api.labelscan.NodeLabelUpdate;
import org.neo4j.register.Register.DoubleLongRegister;
import org.neo4j.storageengine.api.schema.PopulationProgress;
import org.neo4j.values.storable.Value;
import org.neo4j.values.storable.Values;
/** The indexing services view of the universe. */
public interface IndexStoreView extends PropertyAccessor, PropertyLoader
{
/**
* Retrieve all nodes in the database which has got one or more of the given labels AND
* one or more of the given property key ids. This scan additionally accepts a visitor
* for label updates for a joint scan.
*
* @param labelIds array of label ids to generate updates for. Empty array means all.
* @param propertyKeyIdFilter property key ids to generate updates for.
* @param propertyUpdateVisitor visitor which will see all generated {@link NodeUpdates}.
* @param labelUpdateVisitor visitor which will see all generated {@link NodeLabelUpdate}.
* @param forceStoreScan overrides decision about which source to scan from. If {@code true}
* then store scan will be used, otherwise if {@code false} then the best suited will be used.
* @return a {@link StoreScan} to start and to stop the scan.
*/
<FAILURE extends Exception> StoreScan<FAILURE> visitNodes(
int[] labelIds, IntPredicate propertyKeyIdFilter,
Visitor<NodeUpdates, FAILURE> propertyUpdateVisitor,
Visitor<NodeLabelUpdate, FAILURE> labelUpdateVisitor,
boolean forceStoreScan );
/**
* Produces {@link NodeUpdates} objects from reading node {@code nodeId}, its labels and properties
* and puts those updates into node updates container.
*
* @param nodeId id of node to load.
* @return node updates container
*/
NodeUpdates nodeAsUpdates( long nodeId );
DoubleLongRegister indexUpdatesAndSize( long indexId, DoubleLongRegister output );
DoubleLongRegister indexSample( long indexId, DoubleLongRegister output );
void replaceIndexCounts( long indexId, long uniqueElements, long maxUniqueElements, long indexSize );
void incrementIndexUpdates( long indexId, long updatesDelta );
@SuppressWarnings( "rawtypes" )
StoreScan EMPTY_SCAN = new StoreScan()
{
@Override
public void run() throws Exception
{
}
@Override
public void stop()
{
}
@Override
public PopulationProgress getProgress()
{
return PopulationProgress.DONE;
}
};
IndexStoreView EMPTY = new IndexStoreView()
{
@Override
public void loadProperties( long nodeId, PrimitiveIntSet propertyIds, PropertyLoadSink sink )
{
}
@Override
public Value getPropertyValue( long nodeId, int propertyKeyId ) throws EntityNotFoundException
{
return Values.NO_VALUE;
}
@SuppressWarnings( "unchecked" )
@Override
public <FAILURE extends Exception> StoreScan<FAILURE> visitNodes( int[] labelIds,
IntPredicate propertyKeyIdFilter, Visitor<NodeUpdates,FAILURE> propertyUpdateVisitor,
Visitor<NodeLabelUpdate,FAILURE> labelUpdateVisitor, boolean forceStoreScan )
{
return EMPTY_SCAN;
}
@Override
public void replaceIndexCounts( long indexId, long uniqueElements, long maxUniqueElements,
long indexSize )
{
}
@Override
public NodeUpdates nodeAsUpdates( long nodeId )
{
return null;
}
@Override
public DoubleLongRegister indexUpdatesAndSize( long indexId, DoubleLongRegister output )
{
return output;
}
@Override
public DoubleLongRegister indexSample( long indexId, DoubleLongRegister output )
{
return output;
}
@Override
public void incrementIndexUpdates( long indexId, long updatesDelta )
{
}
};
}