Package org.hibernate.search.backend.lucene.search.projection.dsl

Interface DocumentTree

@Incubating
public interface DocumentTree

Represents an indexed document tree.

With Hibernate Search, indexed objects that use nested object structure will be indexed as child documents. This document tree recreates the tree structure of such indexed nested documents.

Method Summary

Modifier and Type	Method	Description
Document	document()
Map<String,Collection<DocumentTree>>	nested()

Method Details

document

Document document()

Returns:

The document that represents the current node in the tree.

nested

Map<String,Collection<DocumentTree>> nested()

Returns:

A map representing nested document nodes relative to the current node. The map key represents the name of a nested field within the current node, while the map value contains tree nodes representing the documents of that nested field.