Module io.ebean.core

Package io.ebeanservice.docstore.api.mapping

Class DocMappingBuilder

java.lang.Object

io.ebeanservice.docstore.api.mapping.DocMappingBuilder

public final class DocMappingBuilder
extends Object

Builds the DocumentMapping for a given bean type.

Constructor Summary

Constructors

Constructor	Description
DocMappingBuilder(PathProperties paths, io.ebean.annotation.DocStore docStore)	Create with the document structure paths and docStore deployment annotation.

Method Summary

Modifier and Type	Method	Description
void	add(DocPropertyMapping docMapping)	Add the property mapping.
void	applyMapping()	Apply any override mappings from the top level docStore annotation.
Map<String,String>	collectSortable()	Collect the mapping of properties to 'raw' properties for those marked as sortable.
DocumentMapping	create(String queueId, String indexName, String indexType)	Create the document mapping.
boolean	includesPath(String prefix, String name)	Return true if the path is included in the document.
boolean	includesProperty(String prefix, String name)	Return true if the property is included in the document.
void	pop()	Pop the nested object or list off the properties stack.
void	push(DocPropertyMapping nested)	Push the nested object or list onto the properties stack.

Methods inherited from class java.lang.Object

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

Constructor Details

DocMappingBuilder

public DocMappingBuilder(PathProperties paths,
 io.ebean.annotation.DocStore docStore)

Create with the document structure paths and docStore deployment annotation.

Method Details

includesProperty

public boolean includesProperty(String prefix,
 String name)

Return true if the property is included in the document.

includesPath

public boolean includesPath(String prefix,
 String name)

Return true if the path is included in the document.

add

public void add(DocPropertyMapping docMapping)

Add the property mapping.

push

public void push(DocPropertyMapping nested)

Push the nested object or list onto the properties stack.

pop

public void pop()

Pop the nested object or list off the properties stack.

applyMapping

public void applyMapping()

Apply any override mappings from the top level docStore annotation.

collectSortable

public Map<String,String> collectSortable()

Collect the mapping of properties to 'raw' properties for those marked as sortable.

create

public DocumentMapping create(String queueId,
 String indexName,
 String indexType)

Create the document mapping.