fri.util.database.jpa.tree.closuretable
Interface TreePath

All Known Subinterfaces:
TemporalTreePath
All Known Implementing Classes:
AbstractTreePathImpl, PersonAbstractTreePath, PersonDeletedFlagTreePath, PersonFunctionalTreePath, PersonOrganisationalTreePath, PersonTemporalTreePath, TemporalTreePathImpl, TreePathImpl

public interface TreePath

The entity type (database table) where tree paths are stored. For every descendant, all ancestor nodes are stored, including the descendant itself, which means that for every node one TreePaths object exists where descendant == ancestor.

Author:
Fritz Ritzberger, 14.10.2012

Method Summary
 ClosureTableTreeNode getAncestor()
          One of the ancestor tree nodes of the descendant, or the descendant itself.
 int getDepth()
          The 0-n level this descendant tree node occurs, 0 is self-reference.
 ClosureTableTreeNode getDescendant()
          The (descendant) tree node (of the ancestor).
 int getOrderIndex()
          The 0-n child position this descendant occurs at.
 void setAncestor(ClosureTableTreeNode ancestor)
           
 void setDepth(int depth)
           
 void setDescendant(ClosureTableTreeNode descendant)
           
 void setOrderIndex(int orderIndex)
           
 

Method Detail

getAncestor

ClosureTableTreeNode getAncestor()
One of the ancestor tree nodes of the descendant, or the descendant itself. The private Java property name for this MUST BE "ancestor" in any implementation, as that name is used in DAO queries.


setAncestor

void setAncestor(ClosureTableTreeNode ancestor)

getDescendant

ClosureTableTreeNode getDescendant()
The (descendant) tree node (of the ancestor). The private Java property name for this MUST BE "descendant" in any implementation, as that name is used in DAO queries.


setDescendant

void setDescendant(ClosureTableTreeNode descendant)

getDepth

int getDepth()
The 0-n level this descendant tree node occurs, 0 is self-reference. The private Java property name for this MUST BE "depth" in any implementation, as that name is used in DAO queries.


setDepth

void setDepth(int depth)

getOrderIndex

int getOrderIndex()
The 0-n child position this descendant occurs at. The private Java property name for this MUST BE "orderIndex" in any implementation, as that name is used in DAO queries.


setOrderIndex

void setOrderIndex(int orderIndex)