Skip to content

Commit

Permalink
docs: enhance column template
Browse files Browse the repository at this point in the history
Signed-off-by: Otavio Santana <otaviopolianasantana@gmail.com>
  • Loading branch information
otaviojava committed Mar 2, 2024
1 parent 1fb4736 commit e2a1732
Show file tree
Hide file tree
Showing 20 changed files with 91 additions and 1,851 deletions.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
*
* Copyright (c) 2023 Contributors to the Eclipse Foundation
* Copyright (c) 2024 Contributors to the Eclipse Foundation
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* and Apache License v2.0 which accompanies this distribution.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,24 @@
import java.util.function.Function;

/**
* The producer of {@link ColumnTemplate}
* This class is responsible for producing instances of {@link ColumnTemplate}.
* It implements the {@link Function} interface, which allows it to accept a {@link DatabaseManager}
* and produce a corresponding {@link ColumnTemplate} instance.
* <p>
* The produced {@link ColumnTemplate} instance is configured with the necessary dependencies such as
* {@link EntityConverter}, {@link EventPersistManager}, {@link EntitiesMetadata}, and {@link Converters}.
* </p>
* <p>
* Usage of this class enables the creation of ready-to-use {@link ColumnTemplate} instances for interacting
* with column-based data structures in a semistructured database.
* </p>
*
* @see ColumnTemplate
* @see DatabaseManager
* @see EntityConverter
* @see EventPersistManager
* @see EntitiesMetadata
* @see Converters
*/
@ApplicationScoped
public class ColumnTemplateProducer implements Function<DatabaseManager, ColumnTemplate> {
Expand All @@ -54,6 +71,10 @@ public ColumnTemplate apply(DatabaseManager manager) {
}


/**
* Inner class that serves as the actual implementation of {@link ColumnTemplate}.
* It extends {@link AbstractSemistructuredTemplate} and implements {@link ColumnTemplate}.
*/
@Vetoed
static class ProducerColumnTemplate extends AbstractSemistructuredTemplate implements ColumnTemplate {

Expand Down

This file was deleted.

Loading

0 comments on commit e2a1732

Please sign in to comment.