org.neo4j.kernel.api.txstate.ReadableTxState Maven / Gradle / Ivy
Show all versions of neo4j-kernel Show documentation
/*
* Copyright (c) 2002-2015 "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
* This interface contains the methods for reading the state from the transaction state. The implementation of these
* methods should be free of any side effects (such as initialising lazy state). Modifying methods are found in the
* {@link TransactionState} interface.
*/
public interface ReadableTxState
{
void accept( TxStateVisitor visitor ) throws ConstraintValidationKernelException, CreateConstraintFailureException;
boolean hasChanges();
// ENTITY RELATED
/**
* Returns all nodes that, in this tx, have had labelId removed.
*/
ReadableDiffSets nodesWithLabelChanged( int labelId );
/**
* Returns nodes that have been added and removed in this tx.
*/
ReadableDiffSets addedAndRemovedNodes();
/**
* Returns rels that have been added and removed in this tx.
*/
ReadableRelationshipDiffSets addedAndRemovedRelationships();
/**
* Nodes that have had labels, relationships, or properties modified in this tx.
*/
Iterable modifiedNodes();
/**
* Rels that have properties modified in this tx.
*/
Iterable modifiedRelationships();
boolean relationshipIsAddedInThisTx( long relationshipId );
boolean relationshipIsDeletedInThisTx( long relationshipId );
ReadableDiffSets nodeStateLabelDiffSets( long nodeId );
Iterator augmentGraphProperties( Iterator original );
boolean nodeIsAddedInThisTx( long nodeId );
boolean nodeIsDeletedInThisTx( long nodeId );
boolean nodeModifiedInThisTx( long nodeId );
PrimitiveIntIterator nodeRelationshipTypes( long nodeId );
int augmentNodeDegree( long node, int committedDegree, Direction direction );
int augmentNodeDegree( long node, int committedDegree, Direction direction, int relType );
PrimitiveLongIterator augmentNodesGetAll( PrimitiveLongIterator committed );
RelationshipIterator augmentRelationshipsGetAll( RelationshipIterator committed );
/**
* @return {@code true} if the relationship was visited in this state, i.e. if it was created
* by this current transaction, otherwise {@code false} where the relationship might need to be
* visited from the store.
*/
boolean relationshipVisit( long relId, RelationshipVisitor visitor ) throws EX;
// SCHEMA RELATED
ReadableDiffSets indexDiffSetsByLabel( int labelId );
ReadableDiffSets constraintIndexDiffSetsByLabel( int labelId );
ReadableDiffSets indexChanges();
ReadableDiffSets constraintIndexChanges();
Iterable constraintIndexesCreatedInTx();
ReadableDiffSets constraintsChanges();
ReadableDiffSets constraintsChangesForLabel( int labelId );
ReadableDiffSets constraintsChangesForLabelAndProperty( int labelId, int propertyKey );
ReadableDiffSets constraintsChangesForRelationshipType( int relTypeId );
ReadableDiffSets constraintsChangesForRelationshipTypeAndProperty( int relTypeId,
int propertyKey );
Long indexCreatedForConstraint( UniquenessConstraint constraint );
ReadableDiffSets indexUpdatesForScanOrSeek( IndexDescriptor index, Object value );
ReadableDiffSets indexUpdatesForRangeSeekByNumber( IndexDescriptor index,
Number lower, boolean includeLower,
Number upper, boolean includeUpper );
ReadableDiffSets indexUpdatesForRangeSeekByString( IndexDescriptor index,
String lower, boolean includeLower,
String upper, boolean includeUpper );
ReadableDiffSets indexUpdatesForRangeSeekByPrefix( IndexDescriptor index, String prefix );
NodeState getNodeState( long id );
RelationshipState getRelationshipState( long id );
Cursor augmentSingleNodeCursor( Cursor cursor, long nodeId );
Cursor augmentPropertyCursor( Cursor cursor,
PropertyContainerState propertyContainerState );
Cursor augmentSinglePropertyCursor( Cursor cursor,
PropertyContainerState propertyContainerState,
int propertyKeyId );
Cursor augmentLabelCursor( Cursor cursor, NodeState nodeState );
public Cursor augmentSingleLabelCursor( Cursor cursor, NodeState nodeState, int labelId );
Cursor augmentSingleRelationshipCursor( Cursor cursor, long relationshipId );
Cursor augmentIteratorRelationshipCursor( Cursor cursor,
RelationshipIterator iterator );
Cursor augmentNodeRelationshipCursor( Cursor cursor,
NodeState nodeState,
Direction direction,
int[] relTypes );
Cursor augmentNodesGetAllCursor( Cursor cursor );
Cursor augmentRelationshipsGetAllCursor( Cursor cursor );
Iterator augmentProcedures( Iterator procs );
ProcedureDescriptor getProcedure( ProcedureName name );
/**
* The way tokens are created is that the first time a token is needed it gets created in its own little
* token mini-transaction, separate from the surrounding transaction that creates or modifies data that need it.
* From the kernel POV it's interesting to know whether or not any tokens have been created in this tx state,
* because then we know it's a mini-transaction like this and won't have to let transaction event handlers
* know about it, for example.
*
* The same applies to schema changes, such as creating and dropping indexes and constraints.
*/
boolean hasDataChanges();
}