com.avaje.ebeanservice.docstore.api.support

Class DocStoreBeanBaseAdapter<T>

java.lang.Object

com.avaje.ebeanservice.docstore.api.support.DocStoreBeanBaseAdapter<T>

All Implemented Interfaces:

BeanDocType<T>, DocStoreBeanAdapter<T>

Direct Known Subclasses:

NoneDocStoreBeanAdapter

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

Base implementation for much of DocStoreBeanAdapter.

Field Summary

Fields

Modifier and Type	Field and Description
protected DocStoreMode	delete Behavior on delete.
protected com.avaje.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 List<DocStoreEmbeddedInvalidation>	embeddedInvalidation List of embedded paths from other documents that include this document type.
protected String	indexName ElasticSearch index name.
protected String	indexType ElasticSearch index type.
protected DocStoreMode	insert Behavior on insert.
protected boolean	mapped The type of index.
protected PathProperties	pathProps
protected String	queueId Identifier used in the queue system to identify the index.
protected com.avaje.ebeaninternal.api.SpiEbeanServer	server
protected Map<String,String>	sortableMap Map of properties to 'raw' properties.
protected DocStoreMode	update Behavior on update.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and 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, DocStoreUpdateContext 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	getDocStructure(PathProperties pathProps, boolean includeByDefault)
FetchPath	getEmbedded(String path) Return the FetchPath for the embedded document.
protected DocStoreEmbeddedInvalidation	getEmbeddedInvalidation(String queueId, String path, Set<String> properties) Return the DsInvalidationListener based on the properties, path.
FetchPath	getEmbeddedManyRoot(String path) For embedded 'many' properties we need a FetchPath relative to the root which is used to build and replace the embedded list.
String	getIndexName() Return the index name for this bean type.
String	getIndexType() Return the index type for this bean type.
DocStoreMode	getMode(com.avaje.ebeaninternal.server.core.PersistRequest.Type persistType, DocStoreMode txnMode) Determine and return how this persist type will be processed given the transaction mode.
protected int[]	getPropertyPositions(Set<String> properties) Return the property names as property index positions.
String	getQueueId() Return the unique queueId for this bean type.
boolean	hasEmbeddedInvalidation() Return true if this bean type as embedded invalidate registered.
abstract void	index(Object idValue, T entityBean, DocStoreUpdateContext txn) Process an index event which is effectively an insert or update (or put).
abstract void	insert(Object idValue, com.avaje.ebeaninternal.server.core.PersistRequestBean<T> persistRequest, DocStoreUpdateContext txn) Process an insert persist request.
boolean	isMapped() Return true if this type is mapped for doc storage.
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, com.avaje.ebeaninternal.server.core.PersistRequestBean<T> persistRequest, DocStoreUpdateContext txn) Process an update persist request.
abstract void	updateEmbedded(Object idValue, String embeddedProperty, String embeddedRawContent, DocStoreUpdateContext txn) Process an update of an embedded document.
void	updateEmbedded(com.avaje.ebeaninternal.server.core.PersistRequestBean<T> request, DocStoreUpdates docStoreUpdates) Process the persist request adding any embedded/nested document invalidation to the docStoreUpdates.

Methods inherited from class java.lang.Object

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

Field Detail

server

protected final com.avaje.ebeaninternal.api.SpiEbeanServer server

desc

protected final com.avaje.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 DocStoreMode insert

Behavior on insert.

update

protected DocStoreMode update

Behavior on update.

delete

protected final 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 Detail

DocStoreBeanBaseAdapter

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

Method Detail

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>

getIndexType

public String getIndexType()

Description copied from interface: DocStoreBeanAdapter

Return the index type for this bean type.

Specified by:

getIndexType in interface BeanDocType<T>

Specified by:

getIndexType in interface DocStoreBeanAdapter<T>

getIndexName

public String getIndexName()

Description copied from interface: DocStoreBeanAdapter

Return the index name for this bean type.

Specified by:

getIndexName in interface BeanDocType<T>

Specified by:

getIndexName 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>

getEmbeddedInvalidation

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

Return the DsInvalidationListener based on the properties, path.

getPropertyPositions

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

Return the property names as property index positions.

updateEmbedded

public void updateEmbedded(com.avaje.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.

getDocStructure

protected DocStructure getDocStructure(PathProperties pathProps,
                                       boolean includeByDefault)

getEmbedded

public FetchPath getEmbedded(String path)

Description copied from interface: BeanDocType

Return the FetchPath for the embedded document.

Specified by:

getEmbedded in interface BeanDocType<T>

getEmbeddedManyRoot

public FetchPath getEmbeddedManyRoot(String path)

Description copied from interface: BeanDocType

For embedded 'many' properties we need a FetchPath relative to the root which is used to build and replace the embedded list.

Specified by:

getEmbeddedManyRoot in interface BeanDocType<T>

isMapped

public boolean isMapped()

Description copied from interface: DocStoreBeanAdapter

Return true if this type is mapped for doc storage.

Specified by:

isMapped in interface DocStoreBeanAdapter<T>

getQueueId

public String getQueueId()

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:

getQueueId in interface DocStoreBeanAdapter<T>

getMode

public DocStoreMode getMode(com.avaje.ebeaninternal.server.core.PersistRequest.Type persistType,
                            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:

getMode 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,
                                DocStoreUpdateContext 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,
                           DocStoreUpdateContext 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,
                            com.avaje.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,
                            com.avaje.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,
                                    DocStoreUpdateContext 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