-
Notifications
You must be signed in to change notification settings - Fork 2.3k
/
IndexDescriptor.java
204 lines (179 loc) · 5.89 KB
/
IndexDescriptor.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
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
/*
* Copyright (c) 2002-2018 "Neo4j,"
* Neo4j Sweden AB [http://neo4j.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.api.schema.index;
import java.util.Optional;
import org.neo4j.internal.kernel.api.IndexOrder;
import org.neo4j.internal.kernel.api.IndexReference;
import org.neo4j.internal.kernel.api.IndexValueCapability;
import org.neo4j.internal.kernel.api.TokenNameLookup;
import org.neo4j.internal.kernel.api.schema.SchemaDescriptor;
import org.neo4j.internal.kernel.api.schema.SchemaDescriptorSupplier;
import org.neo4j.internal.kernel.api.schema.SchemaUtil;
import org.neo4j.kernel.api.index.IndexProvider;
import org.neo4j.values.storable.ValueCategory;
import static java.lang.String.format;
/**
* Internal representation of a graph index, including the schema unit it targets (eg. label-property combination)
* and the type of index. UNIQUE indexes are used to back uniqueness constraints.
*
* An IndexDescriptor might represent an index that has not yet been committed, and therefore carries an optional
* user-supplied name. On commit the descriptor is upgraded to a {@link StoreIndexDescriptor} using
* {@link IndexDescriptor#withId(long)} or {@link IndexDescriptor#withIds(long, long)}.
*/
public class IndexDescriptor implements SchemaDescriptorSupplier, IndexReference
{
protected final SchemaDescriptor schema;
protected final IndexDescriptor.Type type;
protected final Optional<String> userSuppliedName;
protected final IndexProvider.Descriptor providerDescriptor;
IndexDescriptor( IndexDescriptor indexDescriptor )
{
this( indexDescriptor.schema,
indexDescriptor.type,
indexDescriptor.userSuppliedName,
indexDescriptor.providerDescriptor );
}
public IndexDescriptor( SchemaDescriptor schema,
Type type,
Optional<String> userSuppliedName,
IndexProvider.Descriptor providerDescriptor )
{
this.schema = schema;
this.type = type;
this.userSuppliedName = userSuppliedName;
this.providerDescriptor = providerDescriptor;
}
// METHODS
public Type type()
{
return type;
}
@Override
public SchemaDescriptor schema()
{
return schema;
}
@Override
public boolean isUnique()
{
return type == Type.UNIQUE;
}
@Override
public int label()
{
return schema.keyId();
}
@Override
public int[] properties()
{
return schema.getPropertyIds();
}
@Override
public String providerKey()
{
return providerDescriptor.getKey();
}
@Override
public String providerVersion()
{
return providerDescriptor.getVersion();
}
public IndexProvider.Descriptor providerDescriptor()
{
return providerDescriptor;
}
@Override
public IndexOrder[] orderCapability( ValueCategory... valueCategories )
{
return ORDER_NONE;
}
@Override
public IndexValueCapability valueCapability( ValueCategory... valueCategories )
{
return IndexValueCapability.NO;
}
/**
* Returns a user friendly description of what this index indexes.
*
* @param tokenNameLookup used for looking up names for token ids.
* @return a user friendly description of what this index indexes.
*/
public String userDescription( TokenNameLookup tokenNameLookup )
{
return format( "Index( %s, %s )", type.name(), schema.userDescription( tokenNameLookup ) );
}
@Override
public boolean equals( Object o )
{
if ( o instanceof IndexDescriptor )
{
IndexDescriptor that = (IndexDescriptor)o;
return this.type() == that.type() && this.schema().equals( that.schema() );
}
return false;
}
@Override
public int hashCode()
{
return type.hashCode() & schema.hashCode();
}
@Override
public String toString()
{
return userDescription( SchemaUtil.idTokenNameLookup );
}
/**
* Create a StoreIndexDescriptor, which represent the commit version of this index.
*
* @param id the index id of the committed index
* @return a StoreIndexDescriptor
*/
public StoreIndexDescriptor withId( long id )
{
assertValidId( id, "id" );
return new StoreIndexDescriptor( this, id );
}
/**
* Create a StoreIndexDescriptor, which represent the commit version of this index, that is owned
* by a uniqueness constraint.
*
* @param id id of the committed index
* @param owningConstraintId id of the uniqueness constraint owning this index
* @return a StoreIndexDescriptor
*/
public StoreIndexDescriptor withIds( long id, long owningConstraintId )
{
assertValidId( id, "id" );
assertValidId( owningConstraintId, "owning constraint id" );
return new StoreIndexDescriptor( this, id, owningConstraintId );
}
void assertValidId( long id, String idName )
{
if ( id < 0 )
{
throw new IllegalArgumentException( "A " + getClass().getSimpleName() + " " + idName + " must be positive, got " + id );
}
}
public enum Type
{
GENERAL,
UNIQUE
}
}