CellCanPrune (Lucene 10.5.0 spatial-extras API)
Description: declaration: package: org.apache.lucene.spatial.prefix.tree, interface: CellCanPrune

Package org.apache.lucene.spatial.prefix.tree

# Interface CellCanPrune

All Superinterfaces:
  `Cell`

All Known Implementing Classes:
  `LegacyCell`, `PackedQuadPrefixTree.PackedQuadCell`, `QuadPrefixTree.QuadCell`

public interface CellCanPrune extends Cell
Grid cells that share nothing with other cells when calling `Cell.getNextLevelCells(Shape)` might implement this interface. Children cells for this cell will be eligible for pruning via `RecursivePrefixTreeStrategy.setPruneLeafyBranches(boolean)`.

WARNING: This API is experimental and might change in incompatible ways in the next release.

- ## Method Summary

  Modifier and Type
  Method
  Description
  `int`
  `getSubCellsSize()`
  Returns the number of children for this cell.

  ### Methods inherited from interface org.apache.lucene.spatial.prefix.tree.Cell

  `compareToNoLeaf, getLevel, getNextLevelCells, getShape, getShapeRel, getTokenBytesNoLeaf, getTokenBytesWithLeaf, isLeaf, isPrefixOf, setLeaf, setShapeRel`

- ## Method Details

  - ### getSubCellsSize

    int getSubCellsSize()
    Returns the number of children for this cell.
    Returns:
      the number of children.