From 44aa2a9a94bc33ef7c5e6d28fb129031bc4d1454 Mon Sep 17 00:00:00 2001 From: AuroraLS3 <24460436+AuroraLS3@users.noreply.github.com> Date: Sun, 21 Nov 2021 13:54:42 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20plan-pla?= =?UTF-8?q?yer-analytics/Plan@e0a4779ab61f7c5ca2b7ba833668e4c4b2dce062=20?= =?UTF-8?q?=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- all/allclasses-index.html | 640 +++++++++--------- ...Mapping.html => DataService.Pipeline.html} | 8 +- all/com/djrapitops/plan/DataService.html | 296 ++++---- all/com/djrapitops/plan/DataSvc.html | 281 +++++--- ...ataModule.html => DataPipelineModule.html} | 16 +- .../plan/modules/package-summary.html | 2 +- .../djrapitops/plan/modules/package-tree.html | 2 +- all/com/djrapitops/plan/package-summary.html | 6 +- all/com/djrapitops/plan/package-tree.html | 2 +- all/index-all.html | 88 +-- all/member-search-index.js | 2 +- all/overview-tree.html | 4 +- all/type-search-index.js | 2 +- 13 files changed, 731 insertions(+), 618 deletions(-) rename all/com/djrapitops/plan/{DataService.Mapping.html => DataService.Pipeline.html} (96%) rename all/com/djrapitops/plan/modules/{GatheringDataModule.html => DataPipelineModule.html} (93%) diff --git a/all/allclasses-index.html b/all/allclasses-index.html index dcee3fe8a..a308d3fcc 100644 --- a/all/allclasses-index.html +++ b/all/allclasses-index.html @@ -574,572 +574,570 @@ loadScripts(document, 'script');
DataMap
 
-
DataProvider<T>
-
+
DataPipelineModule
+
 
+
DataProvider<T>
+
Representation of all values a Provider annotation provides.
-
DataService
-
-
Service for sourcing, mapping and consuming data.
-
-
DataService.Mapping
+
DataService
 
-
DataStoreQueries
-
+ +
 
+ +
Static method class for single item store queries.
- -
 
- +
 
- -
+ +
 
+ +
Represents a value given to ExtensionDataBuilder.
- -
+ +
Object that can be called to place data about players to the database.
- -
+ +
Abstract formatter for a timestamp.
- -
+ +
Interface for objects that have a epoch ms date.
- -
+ +
Formatter for a DateHolder object that uses a different formatter.
- -
+ +
Compares DateHolder objects so that most recent is last.
- -
+ +
Compares DateHolder objects so that most recent is first.
- -
 
- -
+ +
 
+ +
Basic TreeMap that uses Epoch MS as keys.
- -
+ +
Object that has a value tied to a date.
- -
 
- -
+ +
 
+ +
Formatter for a timestamp which includes days as the smallest entry.
- -
+ +
Database Lock that prevents queries and transactions from taking place before database schema is ready.
- -
+ +
Task for cleaning the active database.
- -
+ +
Thrown when something goes wrong with Database#init.
- -
+ +
The task which handles the upkeep of the Connection
- -
 
- -
+ +
 
+ +
Runtime exception for wrapping database errors.
- -
+ +
System that holds the active databases.
- -
+ +
An enum which stores the name, the config name and if the Database supports MySQL Queries
- -
 
- -
+ +
 
+ +
Event Listener for EntityDeathEvents.
- -
+ +
Event Listener for detecting player and mob deaths.
- -
 
- -
+ +
 
+ +
Formatter for decimal points that depends on settings.
- -
+ +
Lang implementation for in depth help language when /command ? is used.
- -
+ +
Contains width of characters in the chat with default font.
- -
+ +
Patch that replaces plan_ips with plan_geolocations table.
- -
 
- -
+ +
 
+ +
Represents a data-point given by a Provider method of a DataExtension.
- -
+ +
Adds disk usage information to tps table.
- -
+ +
Setting values that are in "Display_options" section.
- -
 
- -
+ +
 
+ +
Method annotation to provide a double value.
- -
+ +
Setting implementation for Double (floating point) value settings.
- -
+ +
DataContainer implementation that delegates the method calls to other DataContainer implementations.
- -
 
- -
+ +
 
+ +
Enum representing big elements of a plugin.
- -
+ +
Thrown when something goes wrong with Plan initialization.
- -
 
- -
+ +
 
+ +
Formatter for entity names, that capitalizes the first word and removes symbols.
- -
+ +
Contains context for an error that might help debugging it.
- -
 
- -
 
- -
+ +
 
+ +
 
+ +
Page to display error stacktrace.
- -
+ +
Lang implementation for all error pages.
- -
 
- -
+ +
 
+ +
Html String generator for /login and /register page.
- -
 
- -
 
- -
+ +
 
+ +
 
+ +
SQL executing batch statement that closes appropriate elements.
- -
+ +
SQL executing statement that closes appropriate elements.
- -
+ +
Interface for everything that updates rows in the database.
- -
+ +
Handles export for different pages.
- -
+ +
Exception thrown by Exporter if something goes wrong with export.
- -
+ +
Export utility that takes care of path replacement for different resources referenced in other files.
- -
+ +
Schedules export tasks so that they are not all run at once.
- -
+ +
Setting values that are in "Export" section.
- -
+ +
System in charge of exporting html.
- -
 
- +
 
- +
 
- -
+ +
 
+ +
Query for selecting a percentage of true for each boolean provided for players.
- -
+ +
Query for selecting average and total for each double value provided for players.
- -
+ +
Query for selecting Tables out of groups for players.
- -
+ +
Query for selecting average and total for each number value provided for players.
- -
+ +
Query for selecting average for each percentage value provided for players.
- -
+ +
Represents boolean data returned by a BooleanProvider method.
- -
+ +
Represents data of a single extension about a server.
- -
 
- -
+ +
 
+ +
Builder API for Extension data.
- -
+ +
Describes information about an extension value given by a Provider method.
- -
+ +
Represents double data returned by a DoubleProvider or PercentageProvider method.
- -
+ +
Implementation detail, for extracting methods from DataExtension.
- -
+ +
Table information about 'plan_extension_groups'.
- -
+ +
Table information about 'plan_extension_icons'.
- -
+ +
Information about a DataExtension stored in the database.
- -
+ +
Queries for information about DataExtensions stored in the database.
- -
+ +
Implementation detail, abstracts away some method reflection to a more usable API.
- -
 
- -
+ +
 
+ +
Implementation detail, abstracts away method type reflection to a more usable API.
- -
+ +
Represents double data returned by a DoubleProvider or PercentageProvider method.
- -
+ +
Query all ExtensionData by Server UUIDs.
- -
+ +
Query player's Groups by Plugin ID inside ExtensionData objects.
- -
+ +
Query player tables from tableprovider table.
- -
+ +
Table information about 'plan_extension_user_table_values'.
- -
+ +
Table information about 'plan_extension_user_values'.
- -
+ +
Table information about 'plan_extension_plugins'.
- -
+ +
Table information about 'plan_extension_providers'.
- -
+ +
Query Extension data of x most recent players matching a query
- -
+ +
In charge of registering built in DataExtension implementations.
- -
+ +
Query ExtensionData of a server.
- -
+ +
Task for updating DataExtension server values periodically.
- -
+ +
Query Extension data of x most recent players on a server.
- -
+ +
Query server tables from tableprovider table.
- -
+ +
Table information about 'plan_extension_server_table_values'.
- -
+ +
Table information about 'plan_extension_server_values'.
- -
+ +
Interface for registering DataExtensions.
- -
 
- -
+ +
 
+ +
Class responsible for generating and generating settings for DataExtensions to the config.
- -
+ +
Patch to add 'show_in_players_table' to 'plan_extension_providers'
- -
+ +
Represents double data returned by a DoubleProvider or PercentageProvider method.
- -
+ +
Implementation for ExtensionService.
- -
+ +
Represents data on an extension tab.
- -
 
- -
+ +
 
+ +
Represents table data from a single TableProvider.
- -
+ +
Table information about 'plan_extension_tables'.
- -
+ +
Adds values_for field to plan_extension_tables
- -
+ +
Increases the length of Strings in extension tables to 250 to avoid cutoffs and exceptions.
- -
+ +
Table information about 'plan_extension_tabs'.
- -
 
- -
+ +
 
+ +
Represents information defined in a DataExtension class.
- -
 
- +
 
- -
+ +
 
+ +
Config system for Fabric.
- -
+ +
Fabric database system that initializes the required SQLite and MySQL database objects.
- -
+ +
Interface for all listeners on the Fabric platform.
- -
 
- -
+ +
 
+ +
Listener system for the Fabric platform.
- -
 
- -
+ +
 
+ +
Task that handles player ping calculation on Fabric based servers.
- -
 
- +
 
- +
 
- +
 
- +
 
- -
+ +
 
+ +
server.properties fetcher for Fabric
- -
+ +
Dagger module for providing ServerProperties on Fabric.
- -
+ +
ServerShutdownSave implementation for Fabric-based servers.
- -
+ +
Module for binding Fabric-specific classes as interface implementations.
- -
 
- -
 
- -
+ +
 
+ +
 
+ +
System for checking if new Version is available when the System initializes, altering the link for Fabric.
- -
+ +
Reason for WebUserAuthException.
- -
 
- -
+ +
 
+ +
Enum to determine font-awesome icon family.
- -
Deprecated. + +
Deprecated.
This Class exists to keep plugins that used PluginData from breaking.
- -
 
- -
+ +
 
+ +
Resource implementation for a File.
- -
+ +
Class for watching files for changes.
- -
+ +
Represents a query filter for /query page.
- -
 
- +
 
- -
+ +
 
+ +
Represents a query filter.
- -
 
- -
 
- -
 
- -
 
- + +
 
+
 
- -
+ +
 
+ +
 
+ +
 
+ +
Thrown when Connection gets a 403 response.
- -
+ +
Setting values that are in "Formatting" section.
- -
+ +
Interface for formatting a value into a String.
- -
+ +
Factory for new instances of different Formatters.
- -
+ +
Enum for determining additional formatter for a value given by a NumberProvider.
- -
 
- -
-
Event Listener for PlayerGameModeChangeEvents.
-
- + +
 
+
Event Listener for PlayerGameModeChangeEvents.
- +
Event Listener for PlayerGameModeChangeEvents.
- -
 
+ +
+
Event Listener for PlayerGameModeChangeEvents.
+
Lang implementation for single words.
diff --git a/all/com/djrapitops/plan/DataService.Mapping.html b/all/com/djrapitops/plan/DataService.Pipeline.html similarity index 96% rename from all/com/djrapitops/plan/DataService.Mapping.html rename to all/com/djrapitops/plan/DataService.Pipeline.html index f50edc006..72714e9bb 100644 --- a/all/com/djrapitops/plan/DataService.Mapping.html +++ b/all/com/djrapitops/plan/DataService.Pipeline.html @@ -3,10 +3,10 @@ -DataService.Mapping (Plan 5.4-SNAPSHOT API) +DataService.Pipeline (Plan 5.4-SNAPSHOT API) - + @@ -72,7 +72,7 @@ loadScripts(document, 'script');
-

Interface DataService.Mapping

+

Interface DataService.Pipeline

@@ -80,7 +80,7 @@ loadScripts(document, 'script');
DataService

-
public static interface DataService.Mapping
+
public static interface DataService.Pipeline
    diff --git a/all/com/djrapitops/plan/DataService.html b/all/com/djrapitops/plan/DataService.html index 22936338c..fd9fb81c4 100644 --- a/all/com/djrapitops/plan/DataService.html +++ b/all/com/djrapitops/plan/DataService.html @@ -81,30 +81,6 @@ loadScripts(document, 'script');
    public interface DataService
    -
    Service for sourcing, mapping and consuming data. -

    - The service is in charge of two data flows: - - push, given to consumers - - pull, obtained from sources -

    - The mappers facilitate a one way type transformation if needed. -

    - The interface is very abstract about how data is obtained, - but here are my general ideas of where the abstraction is coming from. - - push cause one or multiple consumers to modify stored data - - pull cause one or multiple suppliers to fetch stored data - - mappers are stateless type transformers in memory -

    - Example use-case: - - PlayerJoinEvent is mapped to a generic event - - that generic event is then consumed and mapped until the data is in a database. -

    - - Some kind of data is wanted to place on a web page - - It is requested and the suppliers and mappers give the wanted type of data. -

    - Further research needed: - - Can this limited type system represent types of data that need parameters - (such as differentiate between two servers data)

@@ -134,58 +110,82 @@ loadScripts(document, 'script');
Modifier and Type
Method
Description
-
<A,​ -B> B
-
mapTo​(Class<B> toType, - A from)
+
<T> Optional<T>
+
pull​(Class<T> type)
 
-
<S> Optional<S>
-
pull​(Class<S> type)
+
<K,​ +T> Optional<T>
+
pull​(Class<T> type, + K identifier)
 
-
default <S,​ -P> Optional<S>
-
pull​(Class<S> type, - Class<P> parameterType)
+
default <K,​ +T> void
+
push​(K identifier, + T value)
 
-
default <S,​ -P> Optional<S>
-
pull​(Class<S> type, - Supplier<P> parameter)
-
 
-
<S,​ -P> Optional<S>
-
pull​(Class<S> type, - P parameter)
-
 
- -
push​(Class<M> type, - M data)
+
<K,​ +T> void
+
push​(K identifier, + T value, + Class<T> type)
 
- -
registerConsumer​(Class<M> type, - Consumer<M> consumer)
+
<K,​ +T> DataService
+
registerDatabasePullSource​(Class<K> identifierType, + Class<T> type, + Function<K,​Query<T>> source)
 
-
<P,​ -S> DataService
-
registerDBSupplier​(Class<S> type, - Class<P> parameterType, - Function<P,​Query<S>> supplierWithParameter)
+ +
registerDatabasePullSource​(Class<T> type, + Supplier<Query<T>> source)
 
-
<A,​ +
<K,​ +T> DataService
+
registerDatabaseSink​(Class<K> identifierType, + Class<T> type, + BiFunction<K,​T,​Transaction> consumer)
+
 
+
<K,​ +A,​ B> DataService
-
registerMapper​(Class<A> typeA, - Class<B> typeB, +
registerMapper​(Class<K> identifierType, + Class<A> from, + Class<B> to, + BiFunction<K,​A,​B> mapper)
+
 
+
<K,​ +A,​ +B> DataService
+
registerMapper​(Class<K> identifierType, + Class<A> from, + Class<B> to, Function<A,​B> mapper)
 
-
<P,​ -S> DataService
-
registerSupplier​(Class<S> type, - Class<P> parameterType, - Function<P,​S> supplierWithParameter)
+
<K1,​ +K2,​ +A,​ +B>
DataService
+
registerMapper​(Class<K1> fromIdentifier, + Class<A> from, + Class<K2> toIdentifier, + Class<B> to, + TriConsumer<K1,​A,​BiConsumer<K2,​B>> mapper)
 
- -
registerSupplier​(Class<S> type, - Supplier<S> supplier)
+
<K,​ +T> DataService
+
registerPullSource​(Class<K> identifierType, + Class<T> type, + Function<K,​T> source)
+
 
+ +
registerPullSource​(Class<T> type, + Supplier<T> source)
+
 
+
<K,​ +T> DataService
+
registerSink​(Class<K> identifierType, + Class<T> type, + BiConsumer<K,​T> consumer)
 
@@ -202,89 +202,119 @@ S> D

Method Details

diff --git a/all/com/djrapitops/plan/DataSvc.html b/all/com/djrapitops/plan/DataSvc.html index d7fc028e4..ac9f3dad4 100644 --- a/all/com/djrapitops/plan/DataSvc.html +++ b/all/com/djrapitops/plan/DataSvc.html @@ -96,7 +96,7 @@ implements D

Nested Class Summary

+DataService.Pipeline
@@ -123,49 +123,78 @@ implements D
Modifier and Type
Method
Description
-
<A,​ -B> B
-
mapTo​(Class<B> toType, - A from)
-
 
-
<S,​ -P> Optional<S>
-
pull​(Class<S> type, - P parameter)
-
 
<T> Optional<T>
pull​(Class<T> type)
 
- -
push​(Class<A> type, - A data)
+
<K,​ +T> Optional<T>
+
pull​(Class<T> type, + K identifier)
 
- -
registerConsumer​(Class<A> type, - Consumer<A> consumer)
+
<K,​ +T> void
+
push​(K identifier, + T value, + Class<T> type)
 
-
<P,​ -S> DataService
-
registerDBSupplier​(Class<S> type, - Class<P> parameterType, - Function<P,​Query<S>> queryVisitor)
+
<K,​ +T> DataService
+
registerDatabasePullSource​(Class<K> identifierType, + Class<T> type, + Function<K,​Query<T>> source)
 
-
<A,​ + +
registerDatabasePullSource​(Class<T> type, + Supplier<Query<T>> source)
+
 
+
<K,​ +T> DataService
+
registerDatabaseSink​(Class<K> identifierType, + Class<T> type, + BiFunction<K,​T,​Transaction> consumer)
+
 
+
<K,​ +A,​ B> DataService
-
registerMapper​(Class<A> typeA, - Class<B> typeB, +
registerMapper​(Class<K> identifierType, + Class<A> from, + Class<B> to, + BiFunction<K,​A,​B> mapper)
+
 
+
<K,​ +A,​ +B> DataService
+
registerMapper​(Class<K> identifierType, + Class<A> from, + Class<B> to, Function<A,​B> mapper)
-
 
- -
registerSupplier​(Class<A> type, - Supplier<A> supplier)
 
-
<P,​ -S> DataService
-
registerSupplier​(Class<S> type, - Class<P> parameterType, - Function<P,​S> supplierWithParameter)
+
<K1,​ +K2,​ +A,​ +B>
DataService
+
registerMapper​(Class<K1> fromIdentifier, + Class<A> from, + Class<K2> toIdentifier, + Class<B> to, + TriConsumer<K1,​A,​BiConsumer<K2,​B>> mapper)
 
+
<K,​ +T> DataService
+
registerPullSource​(Class<K> identifierType, + Class<T> type, + Function<K,​T> source)
+
 
+ +
registerPullSource​(Class<T> type, + Supplier<T> source)
+
 
+
<K,​ +T> DataService
+
registerSink​(Class<K> identifierType, + Class<T> type, + BiConsumer<K,​T> consumer)
+
 
@@ -174,7 +203,7 @@ S> D clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.djrapitops.plan.DataService

-pull, pull
+push
@@ -202,13 +231,100 @@ S> D

Method Details