org.neo4j.storageengine.api

Interface NodeItem

All Superinterfaces:

EntityItem

public interface NodeItem
extends EntityItem

Represents a single node from a cursor.

Field Summary

Fields

Modifier and Type	Field and Description
static ToIntFunction<LabelItem>	GET_LABEL Convenience function for extracting a label id from a LabelItem.
static ToIntFunction<IntSupplier>	GET_RELATIONSHIP_TYPE Convenience function for extracting a relationship type id from a IntSupplier.

Method Summary

Modifier and Type	Method and Description
int	degree(Direction direction) Returns degree, e.g.
int	degree(Direction direction, int typeId) Returns degree, e.g.
org.neo4j.cursor.Cursor<DegreeItem>	degrees()
org.neo4j.collection.primitive.PrimitiveIntIterator	getLabels()
org.neo4j.kernel.impl.api.store.RelationshipIterator	getRelationships(Direction direction)
org.neo4j.kernel.impl.api.store.RelationshipIterator	getRelationships(Direction direction, int[] typeIds)
org.neo4j.collection.primitive.PrimitiveIntIterator	getRelationshipTypes()
boolean	hasLabel(int labelId)
boolean	isDense()
org.neo4j.cursor.Cursor<LabelItem>	label(int labelId)
org.neo4j.cursor.Cursor<LabelItem>	labels()
org.neo4j.cursor.Cursor<RelationshipItem>	relationships(Direction direction)
org.neo4j.cursor.Cursor<RelationshipItem>	relationships(Direction direction, int... typeIds)
org.neo4j.cursor.Cursor<IntSupplier>	relationshipTypes()

Methods inherited from interface org.neo4j.storageengine.api.EntityItem

getProperty, getPropertyKeys, hasProperty, id, properties, property

Field Detail

GET_LABEL

static final ToIntFunction<LabelItem> GET_LABEL

Convenience function for extracting a label id from a LabelItem.

GET_RELATIONSHIP_TYPE

static final ToIntFunction<IntSupplier> GET_RELATIONSHIP_TYPE

Convenience function for extracting a relationship type id from a IntSupplier.

Method Detail

labels

org.neo4j.cursor.Cursor<LabelItem> labels()

Returns:

label cursor for current node

Throws:

IllegalStateException - if no current node is selected

label

org.neo4j.cursor.Cursor<LabelItem> label(int labelId)

Parameters:

labelId - for specific label to find

Returns:

label cursor for current node

Throws:

IllegalStateException - if no current node is selected

relationships

org.neo4j.cursor.Cursor<RelationshipItem> relationships(Direction direction,
                                                        int... typeIds)

Returns:

relationship cursor for current node

Throws:

IllegalStateException - if no current node is selected

relationships

org.neo4j.cursor.Cursor<RelationshipItem> relationships(Direction direction)

Returns:

relationship cursor for current node

Throws:

IllegalStateException - if no current node is selected

relationshipTypes

org.neo4j.cursor.Cursor<IntSupplier> relationshipTypes()

Returns:

relationship types, wrapped in IntSupplier instances for relationships attached to this node.

Throws:

IllegalStateException - if no current node is selected

degree

int degree(Direction direction)

Returns degree, e.g. number of relationships for this node.

Parameters:

direction - Direction filter when counting relationships, e.g. only outgoing or incoming.

Returns:

degree of relationships in the given direction.

degree

int degree(Direction direction,
           int typeId)

Returns degree, e.g. number of relationships for this node.

Parameters:

direction - Direction filter on when counting relationships, e.g. only outgoing or incoming.

typeId - relationship type id to filter when counting relationships.

Returns:

degree of relationships in the given direction and relationship type.

isDense

boolean isDense()

Returns:

whether or not this node has been marked as being dense, i.e. exceeding a certain threshold of number of relationships.

degrees

org.neo4j.cursor.Cursor<DegreeItem> degrees()

Returns:

Cursor over all DegreeItem, i.e. all combinations of Direction and relationship type ids for this node.

hasLabel

boolean hasLabel(int labelId)

Parameters:

labelId - label token id to check.

Returns:

whether or not this node has the given label.

getLabels

org.neo4j.collection.primitive.PrimitiveIntIterator getLabels()

Returns:

label ids attached to this node.

getRelationships

org.neo4j.kernel.impl.api.store.RelationshipIterator getRelationships(Direction direction,
                                                                      int[] typeIds)

Parameters:

direction - Direction to filter on.

typeIds - relationship type ids to filter on.

Returns:

relationship ids for the given direction and relationship types.

getRelationships

org.neo4j.kernel.impl.api.store.RelationshipIterator getRelationships(Direction direction)

Parameters:

direction - Direction to filter on.

Returns:

relationship ids for the given direction.

getRelationshipTypes

org.neo4j.collection.primitive.PrimitiveIntIterator getRelationshipTypes()

Returns:

relationship type ids for all relationships attached to this node.