Package org.apache.jackrabbit.oak.spi.query

Interface IndexRow

All Known Implementing Classes:
IndexRowImpl
public interface IndexRow
A row returned by the index.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getPath()
    The path of the node, if available.
    PropertyValue
    getValue(String columnName)
    The value of the given property, if available.
    boolean
    isVirtualRow()
    Marks if the row is virtual and behavior of getPath is undefined.

  • Method Details

    • isVirtualRow

      boolean isVirtualRow()
      Marks if the row is virtual and behavior of getPath is undefined. The implementation may choose to return null or empty string. User of a virtual row should now rely of value of getPath returned from virtual rows.
      Returns:
      if path is available for the current row

    • getPath

      String getPath()
      The path of the node, if available.
      Returns:
      the path

    • getValue

      PropertyValue getValue(String columnName)
      The value of the given property, if available. This might be a property of the given node, or a pseudo-property (a property that is only available in the index but not in the node itself, such as "jcr:score").
      Parameters:
      columnName - the column name
      Returns:
      the value, or null if not available