cc.redberry.core.tensor.iterator

Interface TraverseGuide

public interface TraverseGuide

Since:

1.0

Field Summary

Fields

Modifier and Type	Field and Description
static TraverseGuide	ALL Traverse guide, which always return TraversePermission.Enter.
static TraverseGuide	EXCEPT_FIELDS
static TraverseGuide	EXCEPT_FUNCTIONS_AND_FIELDS

Method Summary

Modifier and Type	Method and Description
TraversePermission	getPermission(Tensor tensor, Tensor parent, int indexInParent) This method specifies restrictions on iteration procedure.

Field Detail

ALL

static final TraverseGuide ALL

Traverse guide, which always return TraversePermission.Enter.

EXCEPT_FUNCTIONS_AND_FIELDS

static final TraverseGuide EXCEPT_FUNCTIONS_AND_FIELDS

EXCEPT_FIELDS

static final TraverseGuide EXCEPT_FIELDS

Method Detail

getPermission

TraversePermission getPermission(Tensor tensor,
                                 Tensor parent,
                                 int indexInParent)

This method specifies restrictions on iteration procedure. Possible kinds of restrictions specified in TraversePermission enum. Any cursor position can be characterized by three parameters: current cursor, its position tensor and position in position tensor. So, they are the method arguments.

Parameters:

parent - current cursor position tensor

indexInParent - position of the current cursor in position tensor

tensor - current cursor

Returns:

TraversePermission

See Also:

TraversePermission, TreeTraverseIterator