Updated javadoc of extension queries

Some of them were for wrong class and contained
lots of unnecessary or out of date information
This commit is contained in:
Rsl1122 2020-01-02 17:15:50 +02:00
parent 0a1c20c070
commit 3e734ec505
13 changed files with 51 additions and 76 deletions

View File

@ -30,10 +30,6 @@ import java.util.UUID;
*/ */
public enum MethodType { public enum MethodType {
@Deprecated
PLAYER_UUID,
@Deprecated
PLAYER_NAME,
PLAYER, PLAYER,
GROUP, GROUP,
SERVER; SERVER;

View File

@ -40,17 +40,15 @@ import java.util.UUID;
import static com.djrapitops.plan.storage.database.sql.building.Sql.*; import static com.djrapitops.plan.storage.database.sql.building.Sql.*;
/** /**
* Query aggregated boolean values from player value table. * Query for selecting a percentage of true for each boolean provided for players.
* <p> * <p>
* Returns Map: PluginID - ExtensionServerData.Factory. * Returns Map: PluginID - {@link ExtensionData.Builder}.
* <p> * <p>
* How it is done: * How it is done:
* - Combines three queries, one that selects true boolean count, one that selects boolean value count and one that selects provider information. * 1. Query count of boolean values
* - Data query is sorted into a multi-map: PluginID - Tab Name - Tab Data * 2. Query count of boolean=true
* - (Tab Name can be empty.) * 3. Combine with provider information
* - Multi-map is sorted into ExtensionPlayerData objects by PluginID, one per ID * 4. Map into ExtensionData objects by PluginID, one per ID
* <p>
* There are multiple data extraction methods to make extracting the value query easier.
* *
* @author Rsl1122 * @author Rsl1122
*/ */

View File

@ -40,17 +40,14 @@ import java.util.UUID;
import static com.djrapitops.plan.storage.database.sql.building.Sql.*; import static com.djrapitops.plan.storage.database.sql.building.Sql.*;
/** /**
* Query aggregated boolean values from player value table. * Query for selecting average and total for each double value provided for players.
* <p> * <p>
* Returns Map: PluginID - ExtensionServerData.Factory. * Returns Map: PluginID - {@link ExtensionData.Builder}.
* <p> * <p>
* How it is done: * How it is done:
* - Combines three queries, one that selects true boolean count, one that selects boolean value count and one that selects provider information. * 1. Query averages and totals
* - Data query is sorted into a multi-map: PluginID - Tab Name - Tab Data * 2. Join with provider information query
* - (Tab Name can be empty.) * 3. Map into ExtensionData objects by PluginID, one per ID
* - Multi-map is sorted into ExtensionPlayerData objects by PluginID, one per ID
* <p>
* There are multiple data extraction methods to make extracting the value query easier.
* *
* @author Rsl1122 * @author Rsl1122
*/ */

View File

@ -38,9 +38,14 @@ import java.util.UUID;
import static com.djrapitops.plan.storage.database.sql.building.Sql.*; import static com.djrapitops.plan.storage.database.sql.building.Sql.*;
/** /**
* Query aggregated Group values from groups table. * Query for selecting Tables out of groups for players.
* <p> * <p>
* Returns Map: PluginID - ExtensionServerData.Factory. * Returns Map: PluginID - {@link ExtensionData.Builder}.
* <p>
* How it's done:
* 1. Query count for each group name
* 2. Join with provider information
* 3. Map to ExtensionData objects, one per Plugin ID
* *
* @author Rsl1122 * @author Rsl1122
*/ */

View File

@ -41,17 +41,14 @@ import java.util.UUID;
import static com.djrapitops.plan.storage.database.sql.building.Sql.*; import static com.djrapitops.plan.storage.database.sql.building.Sql.*;
/** /**
* Query aggregated boolean values from player value table. * Query for selecting average and total for each number value provided for players.
* <p> * <p>
* Returns Map: PluginID - ExtensionServerData.Factory. * Returns Map: PluginID - {@link ExtensionData.Builder}.
* <p> * <p>
* How it is done: * How it is done:
* - Combines three queries, one that selects true boolean count, one that selects boolean value count and one that selects provider information. * 1. Query averages and totals
* - Data query is sorted into a multi-map: PluginID - Tab Name - Tab Data * 2. Join with provider information query
* - (Tab Name can be empty.) * 3. Map into ExtensionData objects by PluginID, one per ID
* - Multi-map is sorted into ExtensionPlayerData objects by PluginID, one per ID
* <p>
* There are multiple data extraction methods to make extracting the value query easier.
* *
* @author Rsl1122 * @author Rsl1122
*/ */

View File

@ -40,17 +40,14 @@ import java.util.UUID;
import static com.djrapitops.plan.storage.database.sql.building.Sql.*; import static com.djrapitops.plan.storage.database.sql.building.Sql.*;
/** /**
* Query aggregated boolean values from player value table. * Query for selecting average for each percentage value provided for players.
* <p> * <p>
* Returns Map: PluginID - ExtensionServerData.Factory. * Returns Map: PluginID - {@link ExtensionData.Builder}.
* <p> * <p>
* How it is done: * How it is done:
* - Combines three queries, one that selects true boolean count, one that selects boolean value count and one that selects provider information. * 1. Query averages
* - Data query is sorted into a multi-map: PluginID - Tab Name - Tab Data * 2. Join with provider information query
* - (Tab Name can be empty.) * 3. Map into ExtensionData objects by PluginID, one per ID
* - Multi-map is sorted into ExtensionPlayerData objects by PluginID, one per ID
* <p>
* There are multiple data extraction methods to make extracting the value query easier.
* *
* @author Rsl1122 * @author Rsl1122
*/ */

View File

@ -44,14 +44,11 @@ import static com.djrapitops.plan.storage.database.sql.building.Sql.*;
* <p> * <p>
* Returns Map: Server UUID - List of ExtensionData. * Returns Map: Server UUID - List of ExtensionData.
* <p> * <p>
* How it is done: * Following utilities are used to query the data more easily.
* - Two queries are run, one that fetches all extensions and one that fetches all data of the player. * - {@link ExtensionData.Builder}
* - Data query is sorted into a multi-map: PluginID - Tab Name - Tab Data * - {@link QueriedTabData}
* - (Tab Name can be empty.) * - {@link QueriedTables}
* - Multi-map is sorted into ExtensionData objects by PluginID, one per ID * These utilities allow combining incomplete information.
* - This map is sorted into final Map: Server UUID - List of ExtensionData at the highest level.
* <p>
* There are multiple data extraction methods to make extracting the value query easier.
* *
* @author Rsl1122 * @author Rsl1122
*/ */

View File

@ -42,7 +42,7 @@ import static com.djrapitops.plan.storage.database.sql.building.Sql.*;
/** /**
* Query player's Groups by Plugin ID inside ExtensionData objects. * Query player's Groups by Plugin ID inside ExtensionData objects.
* <p> * <p>
* - Group names are represented as a String value, concatenated to a single one. * - Group names are represented as a String value, concatenated to a single String, separated by ', '.
* - String values are placed into Tabs they belong to * - String values are placed into Tabs they belong to
* - Tabs are placed to plugin they belong to * - Tabs are placed to plugin they belong to
* - The map is returned * - The map is returned

View File

@ -41,16 +41,12 @@ import static com.djrapitops.plan.storage.database.sql.building.Sql.*;
/** /**
* Query player tables from tableprovider table. * Query player tables from tableprovider table.
* <p> * <p>
* Returns Map: PluginID - ExtensionData.Factory. * Returns Map: PluginID - {@link ExtensionData.Builder}.
* <p> * <p>
* How it is done: * How it is done:
* - TableProviders are queried and formed into Table.Factory objects sorted into a multi-map: PluginID - TableID - Table.Factory * 1. TableProviders are queried and formed into {@link Table.Factory} objects inside {@link QueriedTables}.
* - Table values are queried and merged into the above multimap * 2. Table values are queried and merged
* - Data query is sorted into a multi-map: PluginID - Tab Name - Tab Data * 3. QueriedTables is mapped into ExtensionData objects by PluginID, one per ID
* - (Tab Name can be empty.)
* - Multi-map is sorted into ExtensionData objects by PluginID, one per ID
* <p>
* There are multiple data extraction methods to make extracting the value query easier.
* *
* @author Rsl1122 * @author Rsl1122
*/ */

View File

@ -36,19 +36,15 @@ import java.util.*;
import static com.djrapitops.plan.storage.database.sql.building.Sql.*; import static com.djrapitops.plan.storage.database.sql.building.Sql.*;
/** /**
* Query ExtensionServerData of a server. * Query ExtensionData of a server.
* <p> * <p>
* Returns List of ExtensionServerData. * Returns List of ExtensionData.
* <p> * <p>
* How it is done: * Following utilities are used to query the data more easily.
* - Two queries are run, one that fetches all extensions and one that fetches all data of the player. * - {@link ExtensionData.Builder}
* - Data query is sorted into a multi-map: PluginID - Tab Name - Tab Data * - {@link QueriedTabData}
* - (Tab Name can be empty.) * - {@link QueriedTables}
* - Multi-map is sorted into ExtensionServerData objects by PluginID, one per ID * These utilities allow combining incomplete information.
* - This map is combined with similar maps that contain aggregated player values
* - This map is sorted into List of ExtensionPlayerData at the highest level.
* <p>
* There are multiple data extraction methods to make extracting the value query easier.
* *
* @author Rsl1122 * @author Rsl1122
*/ */

View File

@ -39,7 +39,7 @@ import static com.djrapitops.plan.storage.database.sql.building.Sql.*;
/** /**
* Query Extension data of x most recent players on a server. * Query Extension data of x most recent players on a server.
* <p> * <p>
* Returns Map: Player UUID - ExtensionTabData (container for provider based data) * Returns Map: Player UUID - {@link ExtensionTabData} (container for provider based data)
* *
* @author Rsl1122 * @author Rsl1122
*/ */

View File

@ -38,16 +38,12 @@ import static com.djrapitops.plan.storage.database.sql.building.Sql.*;
/** /**
* Query server tables from tableprovider table. * Query server tables from tableprovider table.
* <p> * <p>
* Returns Map: PluginID - ExtensionServerData.Factory. * Returns Map: PluginID - {@link ExtensionData.Builder}.
* <p> * <p>
* How it is done: * How it is done:
* - TableProviders are queried and formed into Table.Factory objects sorted into a multi-map: PluginID - TableID - Table.Factory * 1. TableProviders are queried and formed into {@link Table.Factory} objects inside {@link QueriedTables}.
* - Table values are queried and merged into the above multimap * 2. Table values are queried and merged
* - Data query is sorted into a multi-map: PluginID - Tab Name - Tab Data * 3. QueriedTables is mapped into ExtensionData objects by PluginID, one per ID
* - (Tab Name can be empty.)
* - Multi-map is sorted into ExtensionServerData objects by PluginID, one per ID
* <p>
* There are multiple data extraction methods to make extracting the value query easier.
* *
* @author Rsl1122 * @author Rsl1122
*/ */

View File

@ -21,7 +21,7 @@ import com.djrapitops.plan.extension.icon.Color;
import com.djrapitops.plan.extension.icon.Icon; import com.djrapitops.plan.extension.icon.Icon;
/** /**
* Utility for accessing implementation variables inside Table.Factory object. * Utility for accessing implementation variables inside {@link Table.Factory} object.
* *
* @author Rsl1122 * @author Rsl1122
*/ */