org.neo4j.kernel.impl.newapi.DefaultNodeCursor Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of neo4j-kernel Show documentation
Show all versions of neo4j-kernel Show documentation
Neo4j kernel is a lightweight, embedded Java database designed to
store data structured as graphs rather than tables. For more
information, see http://neo4j.org.
/*
* Copyright (c) "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 implements NodeCursor
{
Read read;
boolean checkHasChanges;
boolean hasChanges;
private LongIterator addedNodes;
StorageNodeCursor storeCursor;
private final StorageNodeCursor securityStoreNodeCursor;
private final StorageRelationshipTraversalCursor securityStoreRelationshipCursor;
private long currentAddedInTx;
private long single;
private boolean isSingle;
private AccessMode accessMode;
DefaultNodeCursor( CursorPool pool, StorageNodeCursor storeCursor, StorageNodeCursor securityStoreNodeCursor,
StorageRelationshipTraversalCursor securityStoreRelationshipCursor )
{
super( pool );
this.storeCursor = storeCursor;
this.securityStoreNodeCursor = securityStoreNodeCursor;
this.securityStoreRelationshipCursor = securityStoreRelationshipCursor;
}
void scan( Read read )
{
storeCursor.scan();
this.read = read;
this.isSingle = false;
this.currentAddedInTx = NO_ID;
this.checkHasChanges = true;
this.addedNodes = ImmutableEmptyLongIterator.INSTANCE;
this.accessMode = read.ktx.securityContext().mode();
if ( tracer != null )
{
tracer.onAllNodesScan();
}
}
boolean scanBatch( Read read, AllNodeScan scan, int sizeHint, LongIterator addedNodes, boolean hasChanges, AccessMode accessMode )
{
this.read = read;
this.isSingle = false;
this.currentAddedInTx = NO_ID;
this.checkHasChanges = false;
this.hasChanges = hasChanges;
this.addedNodes = addedNodes;
this.accessMode = accessMode;
boolean scanBatch = storeCursor.scanBatch( scan, sizeHint );
return addedNodes.hasNext() || scanBatch;
}
void single( long reference, Read read )
{
storeCursor.single( reference );
this.read = read;
this.single = reference;
this.isSingle = true;
this.currentAddedInTx = NO_ID;
this.checkHasChanges = true;
this.accessMode = read.ktx.securityContext().mode();
this.addedNodes = ImmutableEmptyLongIterator.INSTANCE;
}
protected boolean currentNodeIsAddedInTx()
{
return currentAddedInTx != NO_ID;
}
@Override
public long nodeReference()
{
if ( currentAddedInTx != NO_ID )
{
// Special case where the most recent next() call selected a node that exists only in tx-state.
// Internal methods getting data about this node will also check tx-state and get the data from there.
return currentAddedInTx;
}
return storeCursor.entityReference();
}
@Override
public TokenSet labels()
{
if ( currentAddedInTx != NO_ID )
{
//Node added in tx-state, no reason to go down to store and check
TransactionState txState = read.txState();
return Labels.from( txState.nodeStateLabelDiffSets( currentAddedInTx ).getAdded() );
}
else if ( hasChanges() )
{
//Get labels from store and put in intSet, unfortunately we get longs back
TransactionState txState = read.txState();
long[] longs = storeCursor.labels();
final MutableLongSet labels = new LongHashSet();
for ( long labelToken : longs )
{
labels.add( labelToken );
}
//Augment what was found in store with what we have in tx state
return Labels.from( txState.augmentLabels( labels, txState.getNodeState( storeCursor.entityReference() ) ) );
}
else
{
//Nothing in tx state, just read the data.
return Labels.from( storeCursor.labels() );
}
}
/**
* The normal labels() method takes into account TxState for both created nodes and set/remove labels.
* Some code paths need to consider created, but not changed labels.
*/
@Override
public TokenSet labelsIgnoringTxStateSetRemove()
{
if ( currentAddedInTx != NO_ID )
{
//Node added in tx-state, no reason to go down to store and check
TransactionState txState = read.txState();
return Labels.from( txState.nodeStateLabelDiffSets( currentAddedInTx ).getAdded() );
}
else
{
//Nothing in tx state, just read the data.
return Labels.from( storeCursor.labels() );
}
}
@Override
public boolean hasLabel( int label )
{
if ( hasChanges() )
{
TransactionState txState = read.txState();
LongDiffSets diffSets = txState.nodeStateLabelDiffSets( nodeReference() );
if ( diffSets.getAdded().contains( label ) )
{
return true;
}
if ( diffSets.getRemoved().contains( label ) || currentAddedInTx != NO_ID )
{
return false;
}
}
//Get labels from store and put in intSet, unfortunately we get longs back
return storeCursor.hasLabel( label );
}
@Override
public void relationships( RelationshipTraversalCursor cursor, RelationshipSelection selection )
{
((DefaultRelationshipTraversalCursor) cursor).init( this, selection, read );
}
@Override
public boolean supportsFastRelationshipsTo()
{
return currentAddedInTx == NO_ID && storeCursor.supportsFastRelationshipsTo();
}
@Override
public void relationshipsTo( RelationshipTraversalCursor relationships, RelationshipSelection selection, long neighbourNodeReference )
{
((DefaultRelationshipTraversalCursor) relationships).init( this, selection, neighbourNodeReference, read );
}
@Override
public void properties( PropertyCursor cursor, PropertySelection selection )
{
((DefaultPropertyCursor) cursor).initNode( this, selection, read, read );
}
@Override
public long relationshipsReference()
{
return currentAddedInTx != NO_ID ? NO_ID : storeCursor.relationshipsReference();
}
@Override
public Reference propertiesReference()
{
return currentAddedInTx != NO_ID ? NULL_REFERENCE : storeCursor.propertiesReference();
}
@Override
public boolean supportsFastDegreeLookup()
{
return currentAddedInTx == NO_ID && storeCursor.supportsFastDegreeLookup() && allowsTraverseAll();
}
@Override
public int[] relationshipTypes()
{
boolean hasChanges = hasChanges();
NodeState nodeTxState = hasChanges ? read.txState().getNodeState( nodeReference() ) : null;
int[] storedTypes = currentAddedInTx == NO_ID ? storeCursor.relationshipTypes() : null;
MutableIntSet types = storedTypes != null ? IntSets.mutable.of( storedTypes ) : IntSets.mutable.empty();
if ( nodeTxState != null )
{
types.addAll( nodeTxState.getAddedRelationshipTypes() );
}
return types.toArray();
}
@Override
public Degrees degrees( RelationshipSelection selection )
{
EagerDegrees degrees = new EagerDegrees();
fillDegrees( selection, degrees );
return degrees;
}
@Override
public int degree( RelationshipSelection selection )
{
SingleDegree degrees = new SingleDegree();
fillDegrees( selection, degrees );
return degrees.getTotal();
}
@Override
public int degreeWithMax( int maxDegree, RelationshipSelection selection )
{
SingleDegree degrees = new SingleDegree( maxDegree );
fillDegrees( selection, degrees );
return Math.min(degrees.getTotal(), maxDegree);
}
private void fillDegrees( RelationshipSelection selection, Degrees.Mutator degrees )
{
if ( hasChanges() )
{
var nodeTxState = read.txState().getNodeState( nodeReference() );
if ( nodeTxState != null )
{
nodeTxState.fillDegrees( selection, degrees );
}
}
if ( currentAddedInTx == NO_ID )
{
if ( allowsTraverseAll() )
{
storeCursor.degrees( selection, degrees );
}
else
{
readRestrictedDegrees( selection, degrees );
}
}
}
private void readRestrictedDegrees( RelationshipSelection selection, Degrees.Mutator degrees )
{
//When we read degrees limited by security we need to traverse all relationships and check the "other side" if we can add it
storeCursor.relationships( securityStoreRelationshipCursor, selection );
while ( securityStoreRelationshipCursor.next() )
{
int type = securityStoreRelationshipCursor.type();
if ( accessMode.allowsTraverseRelType( type ) )
{
long source = securityStoreRelationshipCursor.sourceNodeReference();
long target = securityStoreRelationshipCursor.targetNodeReference();
boolean loop = source == target;
boolean outgoing = !loop && source == nodeReference();
boolean incoming = !loop && !outgoing;
if ( !loop )
{ //No need to check labels for loops. We already know we are allowed since we have the node loaded in this cursor
securityStoreNodeCursor.single( outgoing ? target : source );
if ( !securityStoreNodeCursor.next() || !accessMode.allowsTraverseNode( securityStoreNodeCursor.labels() ) )
{
continue;
}
}
degrees.add( type, outgoing ? 1 : 0, incoming ? 1 : 0, loop ? 1 : 0 );
}
}
}
@Override
public boolean next()
{
// Check tx state
boolean hasChanges = hasChanges();
if ( hasChanges )
{
if ( addedNodes.hasNext() )
{
currentAddedInTx = addedNodes.next();
if ( tracer != null )
{
tracer.onNode( nodeReference() );
}
return true;
}
else
{
currentAddedInTx = NO_ID;
}
}
while ( storeCursor.next() )
{
boolean skip = hasChanges && read.txState().nodeIsDeletedInThisTx( storeCursor.entityReference() );
if ( !skip && allowsTraverse() )
{
if ( tracer != null )
{
tracer.onNode( nodeReference() );
}
return true;
}
}
return false;
}
boolean allowsTraverse()
{
return accessMode.allowsTraverseAllLabels() || accessMode.allowsTraverseNode( storeCursor.labels() );
}
boolean allowsTraverseAll()
{
return accessMode.allowsTraverseAllRelTypes() && accessMode.allowsTraverseAllLabels();
}
@Override
public void closeInternal()
{
if ( !isClosed() )
{
read = null;
checkHasChanges = true;
addedNodes = ImmutableEmptyLongIterator.INSTANCE;
storeCursor.close();
storeCursor.reset();
if ( securityStoreNodeCursor != null )
{
securityStoreNodeCursor.reset();
}
if ( securityStoreRelationshipCursor != null )
{
securityStoreRelationshipCursor.reset();
}
accessMode = null;
}
super.closeInternal();
}
@Override
public boolean isClosed()
{
return read == null;
}
/**
* NodeCursor should only see changes that are there from the beginning
* otherwise it will not be stable.
*/
boolean hasChanges()
{
if ( checkHasChanges )
{
computeHasChanges();
}
return hasChanges;
}
private void computeHasChanges()
{
checkHasChanges = false;
if ( hasChanges = read.hasTxStateWithChanges() )
{
if ( this.isSingle )
{
addedNodes = read.txState().nodeIsAddedInThisTx( single ) ?
PrimitiveLongCollections.single( single ) : ImmutableEmptyLongIterator.INSTANCE;
}
else
{
addedNodes = read.txState().addedAndRemovedNodes().getAdded().freeze().longIterator();
}
}
}
@Override
public String toString()
{
if ( isClosed() )
{
return "NodeCursor[closed state]";
}
else
{
return "NodeCursor[id=" + nodeReference() + ", " + storeCursor + "]";
}
}
void release()
{
IOUtils.closeAllUnchecked( storeCursor, securityStoreNodeCursor, securityStoreRelationshipCursor );
}
}