-
Notifications
You must be signed in to change notification settings - Fork 2.3k
/
NativeSchemaKey.java
130 lines (112 loc) · 3.88 KB
/
NativeSchemaKey.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
/*
* 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.index.schema;
import org.neo4j.index.internal.gbptree.GBPTree;
import org.neo4j.kernel.impl.store.TemporalValueWriterAdapter;
import org.neo4j.values.storable.Value;
/**
* Includes value and entity id (to be able to handle non-unique values).
* This is the abstraction of what NativeSchemaIndex with friends need from a schema key.
* Note that it says nothing about how keys are compared, serialized, read, written, etc. That is the job of Layout.
*/
abstract class NativeSchemaKey<SELF extends NativeSchemaKey<SELF>> extends TemporalValueWriterAdapter<RuntimeException>
{
private static final boolean DEFAULT_COMPARE_ID = true;
private long entityId;
private boolean compareId = DEFAULT_COMPARE_ID;
/**
* Marks that comparisons with this key requires also comparing entityId, this allows functionality
* of inclusive/exclusive bounds of range queries.
* This is because {@link GBPTree} only support from inclusive and to exclusive.
* <p>
* Note that {@code compareId} is only an in memory state.
*/
void setCompareId( boolean compareId )
{
this.compareId = compareId;
}
boolean getCompareId()
{
return compareId;
}
long getEntityId()
{
return entityId;
}
void setEntityId( long entityId )
{
this.entityId = entityId;
}
final void from( long entityId, Value... values )
{
initialize( entityId );
// copy value state and store in this key instance
assertValidValue( values ).writeTo( this );
}
/**
* Initializes this key with entity id and resets other flags to default values.
* Doesn't touch value data.
*
* @param entityId entity id to set for this key.
*/
void initialize( long entityId )
{
this.compareId = DEFAULT_COMPARE_ID;
this.entityId = entityId;
}
private Value assertValidValue( Value... values )
{
if ( values.length > 1 )
{
throw new IllegalArgumentException( "Tried to create composite key with non-composite schema key layout" );
}
if ( values.length < 1 )
{
throw new IllegalArgumentException( "Tried to create key without value" );
}
return assertCorrectType( values[0] );
}
protected abstract Value assertCorrectType( Value value );
String propertiesAsString()
{
return asValue().toString();
}
abstract Value asValue();
final void initAsLowest()
{
initialize( Long.MIN_VALUE );
initValueAsLowest();
}
abstract void initValueAsLowest();
final void initAsHighest()
{
initialize( Long.MAX_VALUE );
initValueAsHighest();
}
abstract void initValueAsHighest();
/**
* Compares the value of this key to that of another key.
* This method is expected to be called in scenarios where inconsistent reads may happen (and later retried).
*
* @param other the key to compare to.
* @return comparison against the {@code other} key.
*/
abstract int compareValueTo( SELF other );
}