Package dev.jacrispys.JavaBot.api.analytics.objects

Class GuildStats

java.lang.Object

dev.jacrispys.JavaBot.api.analytics.objects.GuildStats

All Implemented Interfaces:

AudioAnalytics, AudioGuildAnalytics, GeneralGuildAnalytics, Stats

Direct Known Subclasses:

GuildAnalytics

public abstract class GuildStats
extends Object
implements Stats, GeneralGuildAnalytics, AudioGuildAnalytics

Abstraction for GuildAnalytics to inherit
uses implementations of Stats, GeneralGuildAnalytics, and AudioGuildAnalytics

Field Summary

Fields

Modifier and Type	Field	Description
final AgentApi	api
final long	guildId
final net.dv8tion.jda.api.JDA	jda
final MySqlStats	sqlStats

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	GuildStats(long guildId, AgentApi api, net.dv8tion.jda.api.JDA jda)

Method Summary

Modifier and Type	Method	Description
<T extends net.dv8tion.jda.api.entities.UserSnowflake> AudioUser	getAudioUser(T user)
List<GuildBookmark>	getBookmarks()
List<GuildUser>	getBotUsers()
GuildPlaylistImpl	getGuildPlaylists()
GuildUser	getGuildUser(net.dv8tion.jda.api.entities.User user)
long	getHijackCount()
OffsetDateTime	getJoinDate()
GuildStats	getOverallStats()
net.dv8tion.jda.api.entities.Guild	getParentGuild()
long	getPauses()
long	getPlaylistPlays(GuildPlaylistImpl playlist)
long	getPlays()
List<GuildUser>	getRegularUsers(int frequency)
List<AudioUser>	getTopListeners()
List<TrackStats>	getTopSongs()
long	getTotalPlaytime()
long	getTotalUses()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

guildId

public final long guildId

api

public final AgentApi api

jda

public final net.dv8tion.jda.api.JDA jda

sqlStats

public final MySqlStats sqlStats

Constructor Details

GuildStats

protected GuildStats(long guildId,
 AgentApi api,
 net.dv8tion.jda.api.JDA jda)

Method Details

getPlays

public long getPlays()
              throws SQLException

Specified by:

getPlays in interface AudioAnalytics

Returns:

the total number of songs played in a guild.

Throws:

SQLException

getPauses

public long getPauses()
               throws SQLException

Specified by:

getPauses in interface AudioAnalytics

Returns:

the amount of times the bot has been paused in a guild.

Throws:

SQLException

getTotalPlaytime

public long getTotalPlaytime()
                      throws SQLException

Specified by:

getTotalPlaytime in interface AudioAnalytics

Returns:

the amount of time the bot has played songs in a guild.

Throws:

SQLException

getTopListeners

public List<AudioUser> getTopListeners()

Specified by:

getTopListeners in interface AudioAnalytics

Returns:

a list of the most active music listeners

getTopSongs

public List<TrackStats> getTopSongs()

Specified by:

getTopSongs in interface AudioAnalytics

Returns:

a list of tracks that have been played the most in a guild

getAudioUser

public <T extends net.dv8tion.jda.api.entities.UserSnowflake>
AudioUser getAudioUser(T user)

Specified by:

getAudioUser in interface AudioAnalytics

Type Parameters:

T - generic to allow members and users

Parameters:

user - is the JDA instance of the user

Returns:

custom object for AudioUser

getHijackCount

public long getHijackCount()
                    throws SQLException

Specified by:

getHijackCount in interface AudioAnalytics

Returns:

the amount of times this guild has been hijacked

Throws:

SQLException

getGuildPlaylists

public GuildPlaylistImpl getGuildPlaylists()

Specified by:

getGuildPlaylists in interface AudioGuildAnalytics

Returns:

custom GuildPlaylistImpl object

getPlaylistPlays

public long getPlaylistPlays(GuildPlaylistImpl playlist)

Specified by:

getPlaylistPlays in interface AudioGuildAnalytics

Parameters:

playlist - to retrieve plays from

Returns:

a value from the DB of how many plays a guild playlist has

getBookmarks

public List<GuildBookmark> getBookmarks()

Specified by:

getBookmarks in interface AudioGuildAnalytics

Returns:

a list of GuildBookmark

getJoinDate

public OffsetDateTime getJoinDate()

Specified by:

getJoinDate in interface GeneralGuildAnalytics

Returns:

the JDA date/time the bot joined a given guild.

getBotUsers

public List<GuildUser> getBotUsers()

Specified by:

getBotUsers in interface GeneralGuildAnalytics

Returns:

a list of GuildUser that are bot accounts

getRegularUsers

public List<GuildUser> getRegularUsers(int frequency)

Specified by:

getRegularUsers in interface GeneralGuildAnalytics

Parameters:

frequency - is a custom scalar for how often users access the bot (scale of 1-100)

Returns:

a list of users above the frequency requested.

getOverallStats

public GuildStats getOverallStats()

Specified by:

getOverallStats in interface GeneralGuildAnalytics

Returns:

instance of GuildStats

getTotalUses

public long getTotalUses()
                  throws SQLException

Specified by:

getTotalUses in interface Stats

Returns:

total times any command has been used

Throws:

SQLException - if a database error occurs

getGuildUser

public GuildUser getGuildUser(net.dv8tion.jda.api.entities.User user)

Specified by:

getGuildUser in interface GeneralGuildAnalytics

Parameters:

user - to find the GuildUser for.

Returns:

a GuildUser instance of the JDA User

getParentGuild

public net.dv8tion.jda.api.entities.Guild getParentGuild()

Specified by:

getParentGuild in interface GeneralGuildAnalytics

Returns:

an instance of the guild the constructor uses