Module io.ebean.core

Package io.ebeanservice.docstore.api.support

Class DocStoreBeanBaseAdapter<T>

java.lang.Object

io.ebeanservice.docstore.api.support.DocStoreBeanBaseAdapter<T>

All Implemented Interfaces:

BeanDocType<T>, DocStoreBeanAdapter<T>

public abstract class DocStoreBeanBaseAdapter<T>
extends Object
implements DocStoreBeanAdapter<T>

Base implementation for much of DocStoreBeanAdapter.

Field Summary

Fields

Modifier and Type	Field	Description
protected final io.ebean.annotation.DocStoreMode	delete	Behavior on delete.
protected final io.ebeaninternal.server.deploy.BeanDescriptor<T>	desc	The associated BeanDescriptor.
protected DocStructure	docStructure	Nested path properties defining the doc structure for indexing.
protected DocumentMapping	documentMapping
protected final List<DocStoreEmbeddedInvalidation>	embeddedInvalidation	List of embedded paths from other documents that include this document type.
protected final String	indexName	ElasticSearch index name.
protected final String	indexType	ElasticSearch index type.
protected final io.ebean.annotation.DocStoreMode	insert	Behavior on insert.
protected final boolean	mapped	The type of index.
protected final PathProperties	pathProps
protected final String	queueId	Identifier used in the queue system to identify the index.
protected final io.ebeaninternal.api.SpiEbeanServer	server
protected Map<String,String>	sortableMap	Map of properties to 'raw' properties.
protected io.ebean.annotation.DocStoreMode	update	Behavior on update.

Constructor Summary

Constructors

Constructor	Description
DocStoreBeanBaseAdapter(io.ebeaninternal.server.deploy.BeanDescriptor<T> desc, io.ebeaninternal.server.deploy.meta.DeployBeanDescriptor<T> deploy)

Method Summary

Modifier and Type	Method	Description
void	applyPath(Query<T> query)	Apply the document structure to the query so that it fetches the required properties to build the document (typically in JSON form).
DocumentMapping	createDocMapping()	Create the document mapping.
abstract void	deleteById(Object idValue, DocUpdateContext txn)	Process a delete by id of a given document.
protected String	derive(BeanType<?> desc, String suppliedValue)	Return the supplied value or default to the bean name lower case.
protected DocStructure	derivePathProperties(PathProperties pathProps)	Return the pathProperties which defines the JSON document to index.
protected DocStructure	docStructure(PathProperties pathProps, boolean includeByDefault)
FetchPath	embedded(String path)
protected DocStoreEmbeddedInvalidation	embeddedInvalidation(String queueId, String path, Set<String> properties)	Return the DsInvalidationListener based on the properties, path.
FetchPath	embeddedManyRoot(String path)
boolean	hasEmbeddedInvalidation()	Return true if this bean type as embedded invalidate registered.
abstract void	index(Object idValue, T entityBean, DocUpdateContext txn)	Process an index event which is effectively an insert or update (or put).
String	indexName()	Return the index name for this bean type.
String	indexType()	Return the index type for this bean type.
abstract void	insert(Object idValue, io.ebeaninternal.server.core.PersistRequestBean<T> persistRequest, DocStoreUpdateContext txn)	Process an insert persist request.
boolean	mapped()	Return true if this type is mapped for doc storage.
io.ebean.annotation.DocStoreMode	mode(io.ebeaninternal.server.core.PersistRequest.Type persistType, io.ebean.annotation.DocStoreMode txnMode)	Determine and return how this persist type will be processed given the transaction mode.
protected int[]	propertyPositions(Set<String> properties)	Return the property names as property index positions.
String	queueId()	Return the unique queueId for this bean type.
String	rawProperty(String property)	Return an un-analysed property to use instead of the given property.
void	registerInvalidationPath(String queueId, String path, Set<String> properties)	Register a doc store invalidation listener for the given bean type, path and properties.
void	registerPaths()	Register invalidation paths for embedded documents.
abstract void	update(Object idValue, io.ebeaninternal.server.core.PersistRequestBean<T> persistRequest, DocStoreUpdateContext txn)	Process an update persist request.
void	updateEmbedded(io.ebeaninternal.server.core.PersistRequestBean<T> request, DocStoreUpdates docStoreUpdates)	Process the persist request adding any embedded/nested document invalidation to the docStoreUpdates.
abstract void	updateEmbedded(Object idValue, String embeddedProperty, String embeddedRawContent, DocUpdateContext txn)	Process an update of an embedded document.

Methods inherited from class java.lang.Object

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

Field Details

server

protected final io.ebeaninternal.api.SpiEbeanServer server

desc

protected final io.ebeaninternal.server.deploy.BeanDescriptor<T> desc

The associated BeanDescriptor.

mapped

protected final boolean mapped

The type of index.

queueId

protected final String queueId

Identifier used in the queue system to identify the index.

indexType

protected final String indexType

ElasticSearch index type.

indexName

protected final String indexName

ElasticSearch index name.

insert

protected final io.ebean.annotation.DocStoreMode insert

Behavior on insert.

update

protected io.ebean.annotation.DocStoreMode update

Behavior on update.

delete

protected final io.ebean.annotation.DocStoreMode delete

Behavior on delete.

embeddedInvalidation

protected final List<DocStoreEmbeddedInvalidation> embeddedInvalidation

List of embedded paths from other documents that include this document type. As such an update to this doc type means that those embedded documents need to be updated.

pathProps

protected final PathProperties pathProps

sortableMap

protected Map<String,String> sortableMap

Map of properties to 'raw' properties.

docStructure

protected DocStructure docStructure

Nested path properties defining the doc structure for indexing.

documentMapping

protected DocumentMapping documentMapping

Constructor Details

DocStoreBeanBaseAdapter

public DocStoreBeanBaseAdapter(io.ebeaninternal.server.deploy.BeanDescriptor<T> desc,
 io.ebeaninternal.server.deploy.meta.DeployBeanDescriptor<T> deploy)

Method Details

hasEmbeddedInvalidation

public boolean hasEmbeddedInvalidation()

Description copied from interface: DocStoreBeanAdapter

Return true if this bean type as embedded invalidate registered.

Specified by:

hasEmbeddedInvalidation in interface DocStoreBeanAdapter<T>

createDocMapping

public DocumentMapping createDocMapping()

Description copied from interface: DocStoreBeanAdapter

Create the document mapping.

Specified by:

createDocMapping in interface DocStoreBeanAdapter<T>

indexType

public String indexType()

Description copied from interface: DocStoreBeanAdapter

Return the index type for this bean type.

Specified by:

indexType in interface BeanDocType<T>

Specified by:

indexType in interface DocStoreBeanAdapter<T>

indexName

public String indexName()

Description copied from interface: DocStoreBeanAdapter

Return the index name for this bean type.

Specified by:

indexName in interface BeanDocType<T>

Specified by:

indexName in interface DocStoreBeanAdapter<T>

applyPath

public void applyPath(Query<T> query)

Description copied from interface: DocStoreBeanAdapter

Apply the document structure to the query so that it fetches the required properties to build the document (typically in JSON form).

Specified by:

applyPath in interface BeanDocType<T>

Specified by:

applyPath in interface DocStoreBeanAdapter<T>

rawProperty

public String rawProperty(String property)

Description copied from interface: DocStoreBeanAdapter

Return an un-analysed property to use instead of the given property.

For analysed properties that we want to sort on we will map the property to an additional 'raw' property that we can use for sorting etc.

Specified by:

rawProperty in interface BeanDocType<T>

Specified by:

rawProperty in interface DocStoreBeanAdapter<T>

registerPaths

public void registerPaths()

Register invalidation paths for embedded documents.

Specified by:

registerPaths in interface DocStoreBeanAdapter<T>

registerInvalidationPath

public void registerInvalidationPath(String queueId,
 String path,
 Set<String> properties)

Register a doc store invalidation listener for the given bean type, path and properties.

Specified by:

registerInvalidationPath in interface DocStoreBeanAdapter<T>

embeddedInvalidation

protected DocStoreEmbeddedInvalidation embeddedInvalidation(String queueId,
 String path,
 Set<String> properties)

Return the DsInvalidationListener based on the properties, path.

propertyPositions

protected int[] propertyPositions(Set<String> properties)

Return the property names as property index positions.

updateEmbedded

public void updateEmbedded(io.ebeaninternal.server.core.PersistRequestBean<T> request,
 DocStoreUpdates docStoreUpdates)

Description copied from interface: DocStoreBeanAdapter

Process the persist request adding any embedded/nested document invalidation to the docStoreUpdates.

This is expected to check the specific properties to see what other documents they are nested in and register invalidation events based on that.

Specified by:

updateEmbedded in interface DocStoreBeanAdapter<T>

Parameters:

request - The persist request

docStoreUpdates - Invalidation events are registered to this docStoreUpdates

derivePathProperties

protected DocStructure derivePathProperties(PathProperties pathProps)

Return the pathProperties which defines the JSON document to index. This can add derived/embedded/nested parts to the document.

docStructure

protected DocStructure docStructure(PathProperties pathProps,
 boolean includeByDefault)

embedded

public FetchPath embedded(String path)

Specified by:

embedded in interface BeanDocType<T>

embeddedManyRoot

public FetchPath embeddedManyRoot(String path)

Specified by:

embeddedManyRoot in interface BeanDocType<T>

mapped

public boolean mapped()

Description copied from interface: DocStoreBeanAdapter

Return true if this type is mapped for doc storage.

Specified by:

mapped in interface DocStoreBeanAdapter<T>

queueId

public String queueId()

Description copied from interface: DocStoreBeanAdapter

Return the unique queueId for this bean type. This is expected to be a relatively short unique string (rather than a fully qualified class name).

Specified by:

queueId in interface DocStoreBeanAdapter<T>

mode

public io.ebean.annotation.DocStoreMode mode(io.ebeaninternal.server.core.PersistRequest.Type persistType,
 io.ebean.annotation.DocStoreMode txnMode)

Description copied from interface: DocStoreBeanAdapter

Determine and return how this persist type will be processed given the transaction mode.

Some transactions (like bulk updates) might specifically turn off indexing for example.

Specified by:

mode in interface DocStoreBeanAdapter<T>

derive

protected String derive(BeanType<?> desc,
 String suppliedValue)

Return the supplied value or default to the bean name lower case.

deleteById

public abstract void deleteById(Object idValue,
 DocUpdateContext txn)
                         throws IOException

Description copied from interface: DocStoreBeanAdapter

Process a delete by id of a given document.

Specified by:

deleteById in interface BeanDocType<T>

Specified by:

deleteById in interface DocStoreBeanAdapter<T>

Throws:

IOException

index

public abstract void index(Object idValue,
 T entityBean,
 DocUpdateContext txn)
                    throws IOException

Description copied from interface: DocStoreBeanAdapter

Process an index event which is effectively an insert or update (or put).

Specified by:

index in interface BeanDocType<T>

Specified by:

index in interface DocStoreBeanAdapter<T>

Throws:

IOException

insert

public abstract void insert(Object idValue,
 io.ebeaninternal.server.core.PersistRequestBean<T> persistRequest,
 DocStoreUpdateContext txn)
                     throws IOException

Description copied from interface: DocStoreBeanAdapter

Process an insert persist request.

Specified by:

insert in interface DocStoreBeanAdapter<T>

Throws:

IOException

update

public abstract void update(Object idValue,
 io.ebeaninternal.server.core.PersistRequestBean<T> persistRequest,
 DocStoreUpdateContext txn)
                     throws IOException

Description copied from interface: DocStoreBeanAdapter

Process an update persist request.

Specified by:

update in interface DocStoreBeanAdapter<T>

Throws:

IOException

updateEmbedded

public abstract void updateEmbedded(Object idValue,
 String embeddedProperty,
 String embeddedRawContent,
 DocUpdateContext txn)
                             throws IOException

Description copied from interface: DocStoreBeanAdapter

Process an update of an embedded document.

Specified by:

updateEmbedded in interface BeanDocType<T>

Specified by:

updateEmbedded in interface DocStoreBeanAdapter<T>

Parameters:

idValue - the id of the bean effected by an embedded document update

embeddedProperty - the path of the property

embeddedRawContent - the embedded content for this property in JSON form

txn - the doc store transaction to use to process the update

Throws:

IOException