Skip to content

Commit

Permalink
docs: enhance documentation
Browse files Browse the repository at this point in the history 
Signed-off-by: Otavio Santana <otaviopolianasantana@gmail.com>
  • Loading branch information
@otaviojava
otaviojava committed Mar 2, 2024
1 parent d65bef3 commit a8366db
Show file tree
Hide file tree
Showing 8 changed files with 95 additions and 70 deletions.
101 changes: 63 additions & 38 deletions ...emistructured/AbstractColumnTemplate.java → ...tured/AbstractSemistructuredTemplate.java
View file
Expand Up @@ -47,32 +47,57 @@
import static java.util.Objects.requireNonNull;

/**
* The template method to {@link SemistructuredTemplate}
* An abstract implementation of the {@link SemistructuredTemplate} interface providing
* a template method for working with semi-structured NoSQL databases.
* Concrete subclasses must implement methods to provide necessary dependencies and configuration.
*
* @see SemistructuredTemplate
*/
public abstract class AbstractColumnTemplate implements SemistructuredTemplate {
public abstract class AbstractSemistructuredTemplate implements SemistructuredTemplate {

private static final QueryParser PARSER = new QueryParser();

protected abstract ColumnEntityConverter getConverter();
/**
* Retrieves the converter used to convert between entity objects and communication entities.
*
* @return the entity converter
*/
protected abstract ColumnEntityConverter converter();

/**
* Retrieves the manager responsible for database operations.
*
* @return the database manager
*/
protected abstract DatabaseManager manager();

protected abstract DatabaseManager getManager();
/**
* Retrieves the manager responsible for persisting column events.
*
* @return the event manager
*/
protected abstract ColumnEventPersistManager eventManager();

protected abstract ColumnEventPersistManager getEventManager();

protected abstract EntitiesMetadata getEntities();
protected abstract EntitiesMetadata entities();

protected abstract Converters getConverters();
/**
* Retrieves the converters for handling entity conversions.
*
* @return the converters
*/
protected abstract Converters converters();

private final UnaryOperator<CommunicationEntity> insert = e -> getManager().insert(e);
private final UnaryOperator<CommunicationEntity> insert = e -> manager().insert(e);

private final UnaryOperator<CommunicationEntity> update = e -> getManager().update(e);
private final UnaryOperator<CommunicationEntity> update = e -> manager().update(e);

private CommunicationObserverParser observer;


private CommunicationObserverParser getObserver() {
if (Objects.isNull(observer)) {
observer = new MapperObserver(getEntities());
observer = new MapperObserver(entities());
}
return observer;
}
Expand All @@ -88,7 +113,7 @@ public <T> T insert(T entity) {
public <T> T insert(T entity, Duration ttl) {
requireNonNull(entity, "entity is required");
requireNonNull(ttl, "ttl is required");
return persist(entity, e -> getManager().insert(e, ttl));
return persist(entity, e -> manager().insert(e, ttl));
}


Expand Down Expand Up @@ -124,7 +149,7 @@ public <T> Iterable<T> insert(Iterable<T> entities, Duration ttl) {
@Override
public void delete(DeleteQuery query) {
requireNonNull(query, "query is required");
getManager().delete(query);
manager().delete(query);
}


Expand All @@ -136,12 +161,12 @@ public <T> Stream<T> select(SelectQuery query) {

@Override
public long count(SelectQuery query) {
return getManager().count(query);
return manager().count(query);
}

@Override
public boolean exists(SelectQuery query) {
return getManager().exists(query);
return manager().exists(query);
}

@Override
Expand All @@ -166,11 +191,11 @@ public <T> Optional<T> singleResult(SelectQuery query) {
public <T, K> Optional<T> find(Class<T> type, K id) {
requireNonNull(type, "type is required");
requireNonNull(id, "id is required");
EntityMetadata entityMetadata = getEntities().get(type);
EntityMetadata entityMetadata = entities().get(type);
FieldMetadata idField = entityMetadata.id()
.orElseThrow(() -> IdNotFoundException.newInstance(type));

Object value = ConverterUtil.getValue(id, entityMetadata, idField.fieldName(), getConverters());
Object value = ConverterUtil.getValue(id, entityMetadata, idField.fieldName(), converters());
SelectQuery query = SelectQuery.select().from(entityMetadata.name())
.where(idField.name()).eq(value).build();

Expand All @@ -182,21 +207,21 @@ public <T, K> void delete(Class<T> type, K id) {
requireNonNull(type, "type is required");
requireNonNull(id, "id is required");

EntityMetadata entityMetadata = getEntities().get(type);
EntityMetadata entityMetadata = entities().get(type);
FieldMetadata idField = entityMetadata.id()
.orElseThrow(() -> IdNotFoundException.newInstance(type));
Object value = ConverterUtil.getValue(id, entityMetadata, idField.fieldName(), getConverters());
Object value = ConverterUtil.getValue(id, entityMetadata, idField.fieldName(), converters());

DeleteQuery query = DeleteQuery.delete().from(entityMetadata.name())
.where(idField.name()).eq(value).build();
getManager().delete(query);
manager().delete(query);
}


@Override
public <T> Stream<T> query(String query) {
requireNonNull(query, "query is required");
return PARSER.query(query, getManager(), getObserver()).map(c -> getConverter().toEntity(c));
return PARSER.query(query, manager(), getObserver()).map(c -> converter().toEntity(c));
}

@Override
Expand All @@ -216,41 +241,41 @@ public <T> Optional<T> singleResult(String query) {

@Override
public PreparedStatement prepare(String query) {
return new ColumnPreparedStatement(PARSER.prepare(query, getManager(), getObserver()), getConverter());
return new ColumnPreparedStatement(PARSER.prepare(query, manager(), getObserver()), converter());
}


@Override
public long count(String columnFamily) {
return getManager().count(columnFamily);
return manager().count(columnFamily);
}


@Override
public <T> long count(Class<T> type) {
requireNonNull(type, "entity class is required");
return getManager().count(findAllQuery(type));
return manager().count(findAllQuery(type));
}

private <T> Stream<T> executeQuery(SelectQuery query) {
requireNonNull(query, "query is required");
Stream<CommunicationEntity> entities = getManager().select(query);
Function<CommunicationEntity, T> function = e -> getConverter().toEntity(e);
return entities.map(function).peek(getEventManager()::firePostEntity);
Stream<CommunicationEntity> entities = manager().select(query);
Function<CommunicationEntity, T> function = e -> converter().toEntity(e);
return entities.map(function).peek(eventManager()::firePostEntity);
}

@Override
public <T> QueryMapper.MapperFrom select(Class<T> type) {
Objects.requireNonNull(type, "type is required");
EntityMetadata metadata = getEntities().get(type);
return new ColumnMapperSelect(metadata, getConverters(), this);
EntityMetadata metadata = entities().get(type);
return new ColumnMapperSelect(metadata, converters(), this);
}

@Override
public <T> QueryMapper.MapperDeleteFrom delete(Class<T> type) {
Objects.requireNonNull(type, "type is required");
EntityMetadata metadata = getEntities().get(type);
return new ColumnMapperDelete(metadata, getConverters(), this);
EntityMetadata metadata = entities().get(type);
return new ColumnMapperDelete(metadata, converters(), this);
}

@Override
Expand All @@ -262,26 +287,26 @@ public <T> Stream<T> findAll(Class<T> type) {
@Override
public <T> void deleteAll(Class<T> type) {
Objects.requireNonNull(type, "type is required");
EntityMetadata metadata = getEntities().get(type);
EntityMetadata metadata = entities().get(type);
if(metadata.inheritance().isPresent()){
InheritanceMetadata inheritanceMetadata = metadata.inheritance().orElseThrow();
if(!inheritanceMetadata.parent().equals(metadata.type())){
getManager().delete(DeleteQuery.delete().from(metadata.name())
manager().delete(DeleteQuery.delete().from(metadata.name())
.where(inheritanceMetadata.discriminatorColumn())
.eq(inheritanceMetadata.discriminatorValue()).build());
return;
}
}
getManager().delete(DeleteQuery.delete().from(metadata.name()).build());
manager().delete(DeleteQuery.delete().from(metadata.name()).build());
}

protected <T> T persist(T entity, UnaryOperator<CommunicationEntity> persistAction) {
return Stream.of(entity)
.map(toUnary(getEventManager()::firePreEntity))
.map(getConverter()::toColumn)
.map(toUnary(eventManager()::firePreEntity))
.map(converter()::toColumn)
.map(persistAction)
.map(t -> getConverter().toEntity(entity, t))
.map(toUnary(getEventManager()::firePostEntity))
.map(t -> converter().toEntity(entity, t))
.map(toUnary(eventManager()::firePostEntity))
.findFirst()
.orElseThrow();
}
Expand All @@ -294,7 +319,7 @@ private <T> UnaryOperator<T> toUnary(Consumer<T> consumer) {
}

private <T> SelectQuery findAllQuery(Class<T> type){
EntityMetadata metadata = getEntities().get(type);
EntityMetadata metadata = entities().get(type);

if(metadata.inheritance().isPresent()){
InheritanceMetadata inheritanceMetadata = metadata.inheritance().orElseThrow();
Expand Down
2 changes: 1 addition & 1 deletion ...ed/src/main/java/org/eclipse/jnosql/mapping/semistructured/ColumnEventPersistManager.java
View file
Expand Up @@ -27,7 +27,7 @@
* 1) firePreColumn
* 2) firePostColumn
*
* @see AbstractColumnTemplate
* @see AbstractSemistructuredTemplate
*/
@ApplicationScoped
public class ColumnEventPersistManager {
Expand Down
26 changes: 13 additions & 13 deletions ...tured/src/main/java/org/eclipse/jnosql/mapping/semistructured/ColumnTemplateProducer.java
View file
Expand Up @@ -43,13 +43,13 @@ public class ColumnTemplateProducer implements Function<DatabaseManager, Semistr
@Override
public SemistructuredTemplate apply(DatabaseManager manager) {
Objects.requireNonNull(manager, "manager is required");
return new ProducerColumnTemplate(converter, manager,
return new ProducerSemistructuredTemplate(converter, manager,
eventManager, entities, converters);
}


@Vetoed
static class ProducerColumnTemplate extends AbstractColumnTemplate {
static class ProducerSemistructuredTemplate extends AbstractSemistructuredTemplate {

private ColumnEntityConverter converter;

Expand All @@ -61,43 +61,43 @@ static class ProducerColumnTemplate extends AbstractColumnTemplate {

private Converters converters;

ProducerColumnTemplate(ColumnEntityConverter converter,
DatabaseManager manager,
ColumnEventPersistManager eventManager,
EntitiesMetadata entities,
Converters converters) {
ProducerSemistructuredTemplate(ColumnEntityConverter converter,
DatabaseManager manager,
ColumnEventPersistManager eventManager,
EntitiesMetadata entities,
Converters converters) {
this.converter = converter;
this.manager = manager;
this.eventManager = eventManager;
this.entities = entities;
this.converters = converters;
}

ProducerColumnTemplate() {
ProducerSemistructuredTemplate() {
}

@Override
protected ColumnEntityConverter getConverter() {
protected ColumnEntityConverter converter() {
return converter;
}

@Override
protected DatabaseManager getManager() {
protected DatabaseManager manager() {
return manager;
}

@Override
protected ColumnEventPersistManager getEventManager() {
protected ColumnEventPersistManager eventManager() {
return eventManager;
}

@Override
protected EntitiesMetadata getEntities() {
protected EntitiesMetadata entities() {
return entities;
}

@Override
protected Converters getConverters() {
protected Converters converters() {
return converters;
}
}
Expand Down
20 changes: 10 additions & 10 deletions ...semistructured/DefaultColumnTemplate.java → ...ctured/DefaultSemistructuredTemplate.java
View file
Expand Up @@ -27,7 +27,7 @@
@Default
@Database(DatabaseType.COLUMN)
@ApplicationScoped
class DefaultColumnTemplate extends AbstractColumnTemplate {
class DefaultSemistructuredTemplate extends AbstractSemistructuredTemplate {

private ColumnEntityConverter converter;

Expand All @@ -40,41 +40,41 @@ class DefaultColumnTemplate extends AbstractColumnTemplate {
private Converters converters;

@Inject
DefaultColumnTemplate(ColumnEntityConverter converter, Instance<DatabaseManager> manager,
ColumnEventPersistManager eventManager,
EntitiesMetadata entities, Converters converters) {
DefaultSemistructuredTemplate(ColumnEntityConverter converter, Instance<DatabaseManager> manager,
ColumnEventPersistManager eventManager,
EntitiesMetadata entities, Converters converters) {
this.converter = converter;
this.manager = manager;
this.eventManager = eventManager;
this.entities = entities;
this.converters = converters;
}

DefaultColumnTemplate(){
DefaultSemistructuredTemplate(){
}

@Override
protected ColumnEntityConverter getConverter() {
protected ColumnEntityConverter converter() {
return converter;
}

@Override
protected DatabaseManager getManager() {
protected DatabaseManager manager() {
return manager.get();
}

@Override
protected ColumnEventPersistManager getEventManager() {
protected ColumnEventPersistManager eventManager() {
return eventManager;
}

@Override
protected EntitiesMetadata getEntities() {
protected EntitiesMetadata entities() {
return entities;
}

@Override
protected Converters getConverters() {
protected Converters converters() {
return converters;
}
}
4 changes: 2 additions & 2 deletions ...rc/test/java/org/eclipse/jnosql/mapping/semistructured/ColumnTemplateInheritanceTest.java
View file
Expand Up @@ -60,7 +60,7 @@ class ColumnTemplateInheritanceTest {

private DatabaseManager managerMock;

private DefaultColumnTemplate template;
private DefaultSemistructuredTemplate template;


@BeforeEach
Expand All @@ -70,7 +70,7 @@ void setUp() {

Instance<DatabaseManager> instance = Mockito.mock(Instance.class);
when(instance.get()).thenReturn(managerMock);
this.template = new DefaultColumnTemplate(converter, instance,
this.template = new DefaultSemistructuredTemplate(converter, instance,
documentEventPersistManager, entities, converters);
}

Expand Down

0 comments on commit a8366db

Please sign in to comment.