-
Notifications
You must be signed in to change notification settings - Fork 2.3k
/
IndexRule.java
187 lines (164 loc) · 6.21 KB
/
IndexRule.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
/*
* 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.impl.store.record;
import org.neo4j.graphdb.Label;
import org.neo4j.internal.kernel.api.schema.SchemaDescriptor;
import org.neo4j.kernel.api.index.IndexProvider;
import org.neo4j.kernel.api.schema.index.SchemaIndexDescriptor;
import org.neo4j.storageengine.api.schema.SchemaRule;
import static org.neo4j.internal.kernel.api.schema.SchemaUtil.idTokenNameLookup;
/**
* A {@link Label} can have zero or more index rules which will have data specified in the rules indexed.
*/
public class IndexRule implements SchemaRule, SchemaIndexDescriptor.Supplier
{
private final IndexProvider.Descriptor providerDescriptor;
private final SchemaIndexDescriptor descriptor;
private final Long owningConstraint;
private final long id;
private final String name;
public static IndexRule indexRule( long id, SchemaIndexDescriptor descriptor,
IndexProvider.Descriptor providerDescriptor )
{
return new IndexRule( id, providerDescriptor, descriptor, null );
}
public static IndexRule constraintIndexRule( long id, SchemaIndexDescriptor descriptor,
IndexProvider.Descriptor providerDescriptor,
Long owningConstraint )
{
return new IndexRule( id, providerDescriptor, descriptor, owningConstraint );
}
public static IndexRule indexRule( long id, SchemaIndexDescriptor descriptor,
IndexProvider.Descriptor providerDescriptor, String name )
{
return new IndexRule( id, providerDescriptor, descriptor, null, name );
}
public static IndexRule constraintIndexRule( long id, SchemaIndexDescriptor descriptor,
IndexProvider.Descriptor providerDescriptor,
Long owningConstraint, String name )
{
return new IndexRule( id, providerDescriptor, descriptor, owningConstraint, name );
}
IndexRule( long id, IndexProvider.Descriptor providerDescriptor,
SchemaIndexDescriptor descriptor, Long owningConstraint )
{
this( id, providerDescriptor, descriptor, owningConstraint, null );
}
IndexRule( long id, IndexProvider.Descriptor providerDescriptor,
SchemaIndexDescriptor descriptor, Long owningConstraint, String name )
{
this.id = id;
this.name = SchemaRule.nameOrDefault( name, "index_" + id );
if ( providerDescriptor == null )
{
throw new IllegalArgumentException( "null provider descriptor prohibited" );
}
this.descriptor = descriptor;
this.owningConstraint = owningConstraint;
this.providerDescriptor = providerDescriptor;
}
public IndexProvider.Descriptor getProviderDescriptor()
{
return providerDescriptor;
}
public boolean canSupportUniqueConstraint()
{
return descriptor.type() == SchemaIndexDescriptor.Type.UNIQUE;
}
/**
* Return the owning constraints of this index.
*
* The owning constraint can be null during the construction of a uniqueness constraint. This construction first
* creates the unique index, and then waits for the index to become fully populated and online before creating
* the actual constraint. During unique index population the owning constraint will be null.
*
* See ConstraintIndexCreator.createUniquenessConstraintIndex().
*
* @return the id of the owning constraint, or null if this has not been set yet.
* @throws IllegalStateException if this IndexRule cannot support uniqueness constraints (ei. the index is not
* unique)
*/
public Long getOwningConstraint()
{
if ( !canSupportUniqueConstraint() )
{
throw new IllegalStateException( "Can only get owner from constraint indexes." );
}
return owningConstraint;
}
public boolean isIndexWithoutOwningConstraint()
{
return canSupportUniqueConstraint() && getOwningConstraint() == null;
}
public IndexRule withOwningConstraint( long constraintId )
{
if ( !canSupportUniqueConstraint() )
{
throw new IllegalStateException( this + " is not a constraint index" );
}
return constraintIndexRule( id, descriptor, providerDescriptor, constraintId );
}
@Override
public String toString()
{
String ownerString = "";
if ( canSupportUniqueConstraint() )
{
ownerString = ", owner=" + owningConstraint;
}
return "IndexRule[id=" + id + ", descriptor=" + descriptor.userDescription( idTokenNameLookup ) +
", provider=" + providerDescriptor + ownerString + "]";
}
@Override
public SchemaDescriptor schema()
{
return descriptor.schema();
}
@Override
public SchemaIndexDescriptor getIndexDescriptor()
{
return descriptor;
}
@Override
public boolean equals( Object o )
{
if ( o instanceof IndexRule )
{
IndexRule that = (IndexRule) o;
return this.descriptor.equals( that.descriptor );
}
return false;
}
@Override
public int hashCode()
{
return this.descriptor.hashCode();
}
@Override
public long getId()
{
return id;
}
@Override
public String getName()
{
return name;
}
}