Module io.ebean.core

Package io.ebeanservice.docstore.api.support

Class DocStructure

java.lang.Object

io.ebeanservice.docstore.api.support.DocStructure

public final class DocStructure
extends Object

Document structure for mapping to document store.

Constructor Summary

Constructors

Constructor	Description
DocStructure(PathProperties pathProps)	Create given an initial deployment doc mapping.

Method Summary

Modifier and Type	Method	Description
void	addNested(String path, PathProperties embeddedDoc)	Add an embedded property with it's document structure.
void	addProperty(String name)	Add a property at the root level.
PathProperties	doc()	Return the document structure.
FetchPath	embedded(String path)	Return the document structure for an embedded path.
FetchPath	embeddedManyRoot(String path)
<T> void	prepareMany(io.ebeaninternal.server.deploy.BeanDescriptor<T> desc)	For 'many' nested properties we need an additional root based graph to fetch and update.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DocStructure

public DocStructure(PathProperties pathProps)

Create given an initial deployment doc mapping.

Method Details

addProperty

public void addProperty(String name)

Add a property at the root level.

addNested

public void addNested(String path,
 PathProperties embeddedDoc)

Add an embedded property with it's document structure.

doc

public PathProperties doc()

Return the document structure.

embedded

public FetchPath embedded(String path)

Return the document structure for an embedded path.

embeddedManyRoot

public FetchPath embeddedManyRoot(String path)

prepareMany

public <T> void prepareMany(io.ebeaninternal.server.deploy.BeanDescriptor<T> desc)

For 'many' nested properties we need an additional root based graph to fetch and update.