-
Notifications
You must be signed in to change notification settings - Fork 2.3k
/
SpatialSchemaKey.java
180 lines (158 loc) · 5.38 KB
/
SpatialSchemaKey.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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
/*
* 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 java.util.Arrays;
import org.neo4j.gis.spatial.index.curves.SpaceFillingCurve;
import org.neo4j.values.storable.CoordinateReferenceSystem;
import org.neo4j.values.storable.NumberValue;
import org.neo4j.values.storable.PointValue;
import org.neo4j.values.storable.Value;
import org.neo4j.values.storable.Values;
import static java.lang.String.format;
/**
* Includes value and entity id (to be able to handle non-unique values).
* A value can be any {@link PointValue} and is represented as a {@code long} to store the 1D mapped version
*/
class SpatialSchemaKey implements NativeSchemaKey
{
static final int SIZE =
Long.BYTES + /* raw value bits */
Long.BYTES; /* entityId */
private long entityId;
private boolean compareId;
long rawValueBits;
CoordinateReferenceSystem crs;
SpaceFillingCurve curve;
SpatialSchemaKey( CoordinateReferenceSystem crs, SpaceFillingCurve curve )
{
this.crs = crs;
this.curve = curve;
}
@Override
public void setCompareId( boolean entityIdIsSpecialTieBreaker )
{
this.compareId = entityIdIsSpecialTieBreaker;
}
@Override
public boolean getCompareId()
{
return compareId;
}
@Override
public long getEntityId()
{
return entityId;
}
@Override
public void setEntityId( long entityId )
{
this.entityId = entityId;
}
@Override
public void from( long entityId, Value... values )
{
extractRawBits( assertValidValue( values ) );
this.entityId = entityId;
compareId = false;
}
@Override
public String propertiesAsString()
{
return asValue().toString();
}
@Override
public NumberValue asValue()
{
// This is used in the index sampler to estimate value diversity. Since the spatial index does not store values
// the uniqueness of the space filling curve number is the best estimate. This can become a bad estimate for
// indexes with badly defined Envelopes for the space filling curves, such that many points exist within the
// same tile.
return (NumberValue) Values.of( rawValueBits );
}
@Override
public void initAsLowest()
{
//TODO: Get dimension
double[] limit = new double[2];
Arrays.fill(limit, Double.NEGATIVE_INFINITY);
writePoint( limit );
entityId = Long.MIN_VALUE;
compareId = true;
}
@Override
public void initAsHighest()
{
//TODO: Get dimension
// These coords will generate the largest value on the spacial curve
double[] limit = {Double.POSITIVE_INFINITY, Double.NEGATIVE_INFINITY};
writePoint( limit );
entityId = Long.MAX_VALUE;
compareId = true;
}
public void fromDerivedValue( long entityId, long derivedValue )
{
rawValueBits = derivedValue;
this.entityId = entityId;
this.compareId = false;
}
/**
* This method will compare along the curve, which is not a spatial comparison, but is correct
* for comparison within the space filling index as long as the original spatial range has already
* been decomposed into a collection of 1D curve ranges before calling down into the GPTree.
*/
int compareValueTo( SpatialSchemaKey other )
{
return Long.compare( rawValueBits, other.rawValueBits );
}
private PointValue assertValidValue( Value... values )
{
// TODO: support multiple values, right?
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" );
}
if ( !Values.isGeometryValue( values[0] ) )
{
throw new IllegalArgumentException(
"Key layout does only support geometries, tried to create key from " + values[0] );
}
return (PointValue) values[0];
}
private void extractRawBits( PointValue value )
{
writePoint( value.coordinate() );
}
/**
* Extracts raw bits from a {@link PointValue} and store as state of this {@link SpatialSchemaKey} instance.
*/
private void writePoint( double[] coordinate )
{
rawValueBits = curve.derivedValueFor( coordinate );
}
@Override
public String toString()
{
return format( "rawValue=%d,value=%s,entityId=%d", rawValueBits, "unknown", entityId );
}
}