com.savoirtech.hecate.pojo.dao

Interface PojoDao<P>

All Known Implementing Classes:

DefaultPojoDao

public interface PojoDao<P>

Method Summary

Modifier and Type	Method and Description
void	delete(P pojo) Deletes a POJO.
void	delete(com.savoirtech.hecate.core.statement.StatementOptions options, P pojo) Deletes a POJO using the supplied StatementOptions.
void	delete(com.savoirtech.hecate.core.update.UpdateGroup group, P pojo) Deletes a POJO using the supplied UpdateGroup.
void	delete(com.savoirtech.hecate.core.update.UpdateGroup group, com.savoirtech.hecate.core.statement.StatementOptions options, P pojo) Deletes a POJO using the supplied StatementOptions within the supplied UpdateGroup.
CompletableFuture<Void>	deleteAsync(P pojo) Asynchronously deletes a POJO.
CompletableFuture<Void>	deleteAsync(com.savoirtech.hecate.core.statement.StatementOptions options, P pojo) Asynchronously deletes a POJO using the supplied StatementOptions.
void	deleteByKey(Object... components) Deletes a POJO by its primary key.
void	deleteByKey(com.savoirtech.hecate.core.statement.StatementOptions options, Object... components) Deletes a POJO by its primary key using the supplied StatementOptions.
void	deleteByKey(com.savoirtech.hecate.core.update.UpdateGroup group, com.savoirtech.hecate.core.statement.StatementOptions options, Object... components) Deletes a POJO by its primary key using the supplied (@link StatmentOptions} and within the supplied UpdateGroup.
CompletableFuture<Void>	deleteByKeyAsync(Object... components) Asynchronously deletes a POJO by its primary key.
CompletableFuture<Void>	deleteByKeyAsync(com.savoirtech.hecate.core.statement.StatementOptions options, Object... components) Asynchronously deletes a POJO by its primary key using the supplied StatementOptions.
PojoQueryBuilder<P>	find() Returns a PojoQueryBuilder which can be used to build a query to find P objects.
PojoQuery<P>	find(Function<com.datastax.oss.driver.api.querybuilder.select.Select,com.datastax.oss.driver.api.querybuilder.select.Select> builder) Returns a PojoQuery which uses a custom where clause to find P objects.
P	findByKey(Object... components) Finds an POJO by its primary key.
P	findByKey(com.savoirtech.hecate.core.statement.StatementOptions options, Object... components) Finds an POJO by its primary key, using the provided StatementOptions.
PojoMultiQuery<P>	findByKeys() Returns a PojoMultiQuery which can be used to search for multiple entities by their primary keys.
PojoMultiQuery<P>	findByKeys(com.savoirtech.hecate.core.statement.StatementOptions options) Returns a PojoMultiQuery which can be used to search for multiple entities by their primary keys, using the provided StatementOptions for each query.
void	save(P pojo) Saves a POJO.
void	save(P pojo, int ttl) Saves a POJO using the supplied TTL value.
void	save(com.savoirtech.hecate.core.statement.StatementOptions options, P pojo) Saves a POJO using the supplied StatementOptions.
void	save(com.savoirtech.hecate.core.statement.StatementOptions options, P pojo, int ttl) Saves a POJO using the supplied StatementOptions and TTL value.
void	save(com.savoirtech.hecate.core.update.UpdateGroup group, P pojo) Saves a POJO within the supplied UpdateGroup.
void	save(com.savoirtech.hecate.core.update.UpdateGroup group, P pojo, int ttl) Saves a POJO within the supplied UpdateGroup with the supplied TTL value.
void	save(com.savoirtech.hecate.core.update.UpdateGroup group, com.savoirtech.hecate.core.statement.StatementOptions options, P pojo) Saves a POJO using the supplied StatementOptions and within the supplied UpdateGroup.
void	save(com.savoirtech.hecate.core.update.UpdateGroup group, com.savoirtech.hecate.core.statement.StatementOptions options, P pojo, int ttl) Saves a POJO using the supplied StatementOptions, within the supplied UpdateGroup, and using the supplied TTL value.
CompletableFuture<Void>	saveAsync(P pojo) Asynchronously saves a POJO.
CompletableFuture<Void>	saveAsync(P pojo, int ttl) Asynchronously saves a POJO using the supplied TTL value.
CompletableFuture<Void>	saveAsync(com.savoirtech.hecate.core.statement.StatementOptions options, P pojo) Asynchronously saves a POJO using the supplied StatementOptions.
CompletableFuture<Void>	saveAsync(com.savoirtech.hecate.core.statement.StatementOptions options, P pojo, int ttl) Asynchronously saves a POJO using the supplied StatementOptions and TTL value.

Method Detail

delete

void delete(P pojo)

Deletes a POJO.

Parameters:

pojo - the POJO

delete

void delete(com.savoirtech.hecate.core.statement.StatementOptions options,
            P pojo)

Deletes a POJO using the supplied StatementOptions.

Parameters:

options - the statement options

pojo - the POJO

delete

void delete(com.savoirtech.hecate.core.update.UpdateGroup group,
            P pojo)

Deletes a POJO using the supplied UpdateGroup.

Parameters:

group - the update group

pojo - the POJO

delete

void delete(com.savoirtech.hecate.core.update.UpdateGroup group,
            com.savoirtech.hecate.core.statement.StatementOptions options,
            P pojo)

Deletes a POJO using the supplied StatementOptions within the supplied UpdateGroup.

Parameters:

group - the update group

options - the statement options

pojo - the POJO

deleteAsync

CompletableFuture<Void> deleteAsync(P pojo)

Asynchronously deletes a POJO.

Parameters:

pojo - the POJO

Returns:

a future which will be completed when the POJO is deleted

deleteAsync

CompletableFuture<Void> deleteAsync(com.savoirtech.hecate.core.statement.StatementOptions options,
                                    P pojo)

Asynchronously deletes a POJO using the supplied StatementOptions.

Parameters:

options - the statement options

pojo - the POJO

Returns:

a future which will be completed when the POJO is deleted

deleteByKey

void deleteByKey(Object... components)

Deletes a POJO by its primary key.

Parameters:

components - the components of the primary key

deleteByKey

void deleteByKey(com.savoirtech.hecate.core.statement.StatementOptions options,
                 Object... components)

Deletes a POJO by its primary key using the supplied StatementOptions.

Parameters:

options - the statement options

components - the components of the primary key

deleteByKey

void deleteByKey(com.savoirtech.hecate.core.update.UpdateGroup group,
                 com.savoirtech.hecate.core.statement.StatementOptions options,
                 Object... components)

Deletes a POJO by its primary key using the supplied (@link StatmentOptions} and within the supplied UpdateGroup.

Parameters:

group - the update group

options - the statement options

components - the components of the primary key

deleteByKeyAsync

CompletableFuture<Void> deleteByKeyAsync(Object... components)

Asynchronously deletes a POJO by its primary key.

Parameters:

components - the components of the primary key

Returns:

a future which will be completed when the POJO is deleted

deleteByKeyAsync

CompletableFuture<Void> deleteByKeyAsync(com.savoirtech.hecate.core.statement.StatementOptions options,
                                         Object... components)

Asynchronously deletes a POJO by its primary key using the supplied StatementOptions.

Parameters:

options - the statement options

components - the components of the primary key

Returns:

a future which will be completed when the POJO is deleted

find

PojoQueryBuilder<P> find()

Returns a PojoQueryBuilder which can be used to build a query to find P objects.

Returns:

the query builder

find

PojoQuery<P> find(Function<com.datastax.oss.driver.api.querybuilder.select.Select,com.datastax.oss.driver.api.querybuilder.select.Select> builder)

Returns a PojoQuery which uses a custom where clause to find P objects.

Parameters:

builder - a function which builds a custom where clause

Returns:

the query

findByKey

P findByKey(Object... components)

Finds an POJO by its primary key.

Parameters:

components - the components of the primary key

Returns:

the POJO corresponding to the primary key

findByKey

P findByKey(com.savoirtech.hecate.core.statement.StatementOptions options,
            Object... components)

Finds an POJO by its primary key, using the provided StatementOptions.

Parameters:

options - the statement options

components - the components of the primary key

Returns:

the POJO corresponding to the primary key

findByKeys

PojoMultiQuery<P> findByKeys()

Returns a PojoMultiQuery which can be used to search for multiple entities by their primary keys.

Returns:

the query

findByKeys

PojoMultiQuery<P> findByKeys(com.savoirtech.hecate.core.statement.StatementOptions options)

Returns a PojoMultiQuery which can be used to search for multiple entities by their primary keys, using the provided StatementOptions for each query.

Parameters:

options - the statement options

Returns:

the query

save

void save(P pojo)

Saves a POJO.

Parameters:

pojo - the POJO

save

void save(P pojo,
          int ttl)

Saves a POJO using the supplied TTL value.

Parameters:

pojo - the POJO

ttl - the TTL

save

void save(com.savoirtech.hecate.core.statement.StatementOptions options,
          P pojo)

Saves a POJO using the supplied StatementOptions.

Parameters:

options - the statement options

pojo - the POJO

save

void save(com.savoirtech.hecate.core.update.UpdateGroup group,
          P pojo)

Saves a POJO within the supplied UpdateGroup.

Parameters:

group - the update group

pojo - the POJO

save

void save(com.savoirtech.hecate.core.statement.StatementOptions options,
          P pojo,
          int ttl)

Saves a POJO using the supplied StatementOptions and TTL value.

Parameters:

options - the statement options

pojo - the POJO

ttl - the TTL

save

void save(com.savoirtech.hecate.core.update.UpdateGroup group,
          P pojo,
          int ttl)

Saves a POJO within the supplied UpdateGroup with the supplied TTL value.

Parameters:

group - the update group

pojo - the POJO

ttl - the TTL

save

void save(com.savoirtech.hecate.core.update.UpdateGroup group,
          com.savoirtech.hecate.core.statement.StatementOptions options,
          P pojo)

Saves a POJO using the supplied StatementOptions and within the supplied UpdateGroup.

Parameters:

group - the update group

options - the statement options

pojo - the POJO

save

void save(com.savoirtech.hecate.core.update.UpdateGroup group,
          com.savoirtech.hecate.core.statement.StatementOptions options,
          P pojo,
          int ttl)

Saves a POJO using the supplied StatementOptions, within the supplied UpdateGroup, and using the supplied TTL value.

Parameters:

group - the update group

options - the statement options

pojo - the POJO

ttl - the TTL

saveAsync

CompletableFuture<Void> saveAsync(P pojo)

Asynchronously saves a POJO.

Parameters:

pojo - the POJO

Returns:

a future which will be completed when the POJO is saved

saveAsync

CompletableFuture<Void> saveAsync(P pojo,
                                  int ttl)

Asynchronously saves a POJO using the supplied TTL value.

Parameters:

pojo - the POJO

ttl - the TTL

Returns:

a future which will be completed when the POJO is saved

saveAsync

CompletableFuture<Void> saveAsync(com.savoirtech.hecate.core.statement.StatementOptions options,
                                  P pojo)

Asynchronously saves a POJO using the supplied StatementOptions.

Parameters:

options - the statement options

pojo - the POJO

Returns:

a future which will be completed when the POJO is saved

saveAsync

CompletableFuture<Void> saveAsync(com.savoirtech.hecate.core.statement.StatementOptions options,
                                  P pojo,
                                  int ttl)

Asynchronously saves a POJO using the supplied StatementOptions and TTL value.

Parameters:

options - the statement options

pojo - the POJO

ttl - the TTL

Returns:

a future which will be completed when the POJO is saved