AnalysisData (Plan 3.1.1 API)

java.lang.Object
- main.java.com.djrapitops.plan.data.AnalysisData

```
public class AnalysisData
extends Object
```
This class is used to store result data from Analysis at runtime. Most of the variables need to be set with various set methods, as they are not initialized in a constructor.

Since:

2.0.0

Author:

Rsl1122

See Also:

Analysis, PlaceholderUtils

Constructor Summary

Constructors
Constructor and Description

AnalysisData()
Class constructor.

Constructors
Constructor and Description
`AnalysisData()` Class constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`int`	`getActive()` Retrieve the amount of active players.
`Map<String,String>`	`getAdditionalDataReplaceMap()` Get the additional data replaceMap used with Analysis replacerules.
`double`	`getAverageAge()` Get the average age of the players whose age has been gathered
`long`	`getAveragePlayTime()` Get How long players have played on average.
`int`	`getBanned()` Used to get the amount of banned players.
`String`	`getCommandUseListHtml()` Used to get the html for the commands table.
`int[]`	`getGenderData()` Get the integer array containing 3 numbers. 0 Male, 1 Female, 2 Unknown.
`String`	`getGeomapCodes()` Used to get the toString representation of a String[] containing all country codes on the Plotly.js Chloropleth map.
`String`	`getGeomapCountries()` Used to get the toString representation of a String[] containing all countries on the Plotly.js Chloropleth map.
`String`	`getGeomapZ()` Used to get the toString representation of a int[] containing all player amounts on the Plotly.js Chloropleth map.
`double`	`getGm0Perc()` Get percentage of Gamemode usage time as a whole.
`double`	`getGm1Perc()` Get percentage of Gamemode usage time as a whole.
`double`	`getGm2Perc()` Get percentage of Gamemode usage time as a whole.
`double`	`getGm3Perc()` Get percentage of Gamemode usage time as a whole.
`int`	`getInactive()` Set the amount of inactive players.
`int`	`getJoinleaver()` Used to get the amount of players who have joined only once.
`int`	`getNewPlayersDay()` Get the amount of registered players in last 24 hours.
`int`	`getNewPlayersMonth()` Get the amount of registered players in last 30 days.
`int`	`getNewPlayersWeek()` Get the amount of registered players in last 7 days.
`int`	`getOps()` Get How many operators are on the server.
`String[]`	`getPlayersDataArray()` Used to store all arrays created in Analysis#createPlayerActivityGraphs(). 0, 2, 4 contain data. 1, 3, 5 contain labels. 0, 1 day; 2, 3 week; 4, 5 month
`String`	`getRecentPlayers()` Get the html for Recent player buttons.
`long`	`getRefreshDate()` Retrieve the refresh Epoch millisecond this object's data was calculated.
`long`	`getSessionAverage()` Get the average length of every session on the server.
`String`	`getSortablePlayersTable()` Used to get the html for players table.
`int`	`getTotal()` Get the total amount of players used to calculate activity.
`long`	`getTotalCommands()` Get the total number of unique commands.
`long`	`getTotalDeaths()` Get how many times the playes have died.
`long`	`getTotalLoginTimes()` Get How many times players have joined in total.
`long`	`getTotalMobKills()` Get the amount of mob kills the players have.
`long`	`getTotalPlayerKills()` Get the amount of times players have killed each other.
`int`	`getTotalPlayers()` Get percentage of Gamemode usage time as a whole.
`long`	`getTotalPlayTime()` Get how long time has been played, long in ms.
`void`	`setActive(int active)` Set the amount of active players.
`void`	`setAdditionalDataReplaceMap(Map<String,String> additionalDataReplaceMap)` Set the additional data replaceMap used with Analysis replacerules.
`void`	`setAverageAge(double averageAge)` Set the average age of the players whose age has been gathered.
`void`	`setAveragePlayTime(long averagePlayTime)` Set the average playtime of all players.
`void`	`setBanned(int banned)` Used to set the amount of banned players.
`void`	`setCommandUseTableHtml(String commandsTableHtml)` Used to get the html for the commands table.
`void`	`setGenderData(int[] genderData)` Set the integer array containing 3 numbers. 0 Male, 1 Female, 2 Unknown.
`void`	`setGeomapCodes(String geomapCodes)` Used to set the toString representation of a String[] containing all country codes on the Plotly.js Chloropleth map.
`void`	`setGeomapCountries(String geomapCountries)` Used to set the toString representation of a String[] containing all countries on the Plotly.js Chloropleth map.
`void`	`setGeomapZ(String geomapZ)` Used to set the toString representation of a int[] containing all player amounts on the Plotly.js Chloropleth map.
`void`	`setGm0Perc(double gm0Perc)` Set percentage of Gamemode usage time as a whole.
`void`	`setGm1Perc(double gm1Perc)` Set percentage of Gamemode usage time as a whole.
`void`	`setGm2Perc(double gm2Perc)` Set percentage of Gamemode usage time as a whole.
`void`	`setGm3Perc(double gm3Perc)` Set percentage of Gamemode usage time as a whole.
`void`	`setInactive(int inactive)` Set the amount of inactive players.
`void`	`setJoinleaver(int joinleaver)` Used to set the amount of players who have joined only once.
`void`	`setNewPlayersDay(int newPlayersDay)` Set the amount of registered players in last 24 hours.
`void`	`setNewPlayersMonth(int newPlayersMonth)` Set the amount of registered players in last 30 days.
`void`	`setNewPlayersWeek(int newPlayersWeek)` Set the amount of registered players in last 7 days.
`void`	`setOps(int ops)` Set the amount of operators.
`void`	`setPlayersDataArray(String[] playersDataArray)` Used to store all arrays created in Analysis#createPlayerActivityGraphs(). 0, 2, 4 contain data. 1, 3, 5 contain labels. 0, 1 day; 2, 3 week; 4, 5 month
`void`	`setRecentPlayers(String recentPlayers)` Set the html for Recent player buttons.
`void`	`setRefreshDate(long refreshDate)` Set the refresh Epoch millisecond this object's data was calculated.
`void`	`setSessionAverage(long sessionAverage)` Set the average length of every session on the server.
`void`	`setSortablePlayersTable(String sortablePlayersTable)` Used to set the html for players table.
`void`	`setTotal(int total)` Set the total amount of players used to calculate activity.
`void`	`setTotalCommands(long totalCommands)` Set the total number of unique commands.
`void`	`setTotaldeaths(long totaldeaths)` Set how many times the playes have died.
`void`	`setTotalkills(long totalkills)` Set the amount of times players have killed each other.
`void`	`setTotalLoginTimes(long totalLoginTimes)` Set How many times playes have logged in.
`void`	`setTotalmobkills(long totalmobkills)` Set the amount of mob kills the players have.
`void`	`setTotalPlayers(int totalPlayers)` Get the Total number of players according to bukkit's data.
`void`	`setTotalPlayTime(long totalPlayTime)` Set how long time has been played, long in ms.

Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AnalysisData
```
public AnalysisData()
```
    Class constructor. All data has to be set with setters to avoid NPEs.
- Method Detail
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - setAdditionalDataReplaceMap
```
public void setAdditionalDataReplaceMap(Map<String,String> additionalDataReplaceMap)
```
    Set the additional data replaceMap used with Analysis replacerules.
    
    Parameters:
    
    additionalDataReplaceMap - Map with placeholder keys %key%, value
    
    See Also:
    
    PlaceholderUtils
  - getAdditionalDataReplaceMap
```
public Map<String,String> getAdditionalDataReplaceMap()
```
    Get the additional data replaceMap used with Analysis replacerules.
    
    Returns:
    
    a Map with placeholder keys %key%, value
  - getGeomapCountries
```
public String getGeomapCountries()
```
    Used to get the toString representation of a String[] containing all countries on the Plotly.js Chloropleth map.
    
    Returns:
    
    ["Finland","Sweden","Etc.."]
  - setGeomapCountries
```
public void setGeomapCountries(String geomapCountries)
```
    Used to set the toString representation of a String[] containing all countries on the Plotly.js Chloropleth map. Incorrect value will break the Chloropleth map on analysis.html page.
    
    Parameters:
    
    geomapCountries - ["Finland","Sweden","Etc.."]
  - getGeomapZ
```
public String getGeomapZ()
```
    Used to get the toString representation of a int[] containing all player amounts on the Plotly.js Chloropleth map. Must contain same amount of numbers as countries in GeomapCountries.
    
    Returns:
    
    [0,0,0,3,0,Etc..]
  - setGeomapZ
```
public void setGeomapZ(String geomapZ)
```
    Used to set the toString representation of a int[] containing all player amounts on the Plotly.js Chloropleth map. Must contain same amount of numbers as countries in GeomapCountries. Incorrect amount will break the Chloropleth map on analysis.html page.
    
    Parameters:
    
    geomapZ - [0,0,0,3,0,Etc..]
  - getGeomapCodes
```
public String getGeomapCodes()
```
    Used to get the toString representation of a String[] containing all country codes on the Plotly.js Chloropleth map. Must contain same amount of numbers as countries in GeomapCountries.
    
    Returns:
    
    ["PNG","KHM","KAZ","PRY","SYR","SLB","MLI","Etc.."]
  - setGeomapCodes
```
public void setGeomapCodes(String geomapCodes)
```
    Used to set the toString representation of a String[] containing all country codes on the Plotly.js Chloropleth map. Must contain same amount of numbers as countries in GeomapCountries.
    
    Parameters:
    
    geomapCodes - ["PNG","KHM","KAZ","PRY","SYR","SLB","MLI","Etc.."]
  - getSortablePlayersTable
```
public String getSortablePlayersTable()
```
    Used to get the html for players table.
    
    Returns:
    
    Html string.
    
    See Also:
    
    SortablePlayersTableCreator
  - setSortablePlayersTable
```
public void setSortablePlayersTable(String sortablePlayersTable)
```
    Used to set the html for players table.
    
    Parameters:
    
    sortablePlayersTable - Html string.
    
    See Also:
    
    SortablePlayersTableCreator
  - getJoinleaver
```
public int getJoinleaver()
```
    Used to get the amount of players who have joined only once.
    
    Returns:
    
    Number from 0 to Integer.MAX
  - setJoinleaver
```
public void setJoinleaver(int joinleaver)
```
    Used to set the amount of players who have joined only once. No check for correct value.
    
    Parameters:
    
    joinleaver - Number from 0 to Integer.MAX
  - getCommandUseListHtml
```
public String getCommandUseListHtml()
```
    Used to get the html for the commands table.
    
    Returns:
    
    Html string.
    
    See Also:
    
    SortableCommandUseTableCreator
  - setCommandUseTableHtml
```
public void setCommandUseTableHtml(String commandsTableHtml)
```
    Used to get the html for the commands table.
    
    Parameters:
    
    commandsTableHtml - Html string.
    
    See Also:
    
    SortableCommandUseTableCreator
  - getBanned
```
public int getBanned()
```
    Used to get the amount of banned players.
    
    Returns:
    
    0 to Integer.MAX
  - setBanned
```
public void setBanned(int banned)
```
    Used to set the amount of banned players. No check for correct value.
    
    Parameters:
    
    banned - 0 to Integer.MAX
  - getActive
```
public int getActive()
```
    Retrieve the amount of active players. Activity is determined by AnalysisUtils.isActive()
    
    Returns:
    
    Amount of active players
    
    See Also:
    
    AnalysisUtils
  - setActive
```
public void setActive(int active)
```
    Set the amount of active players. Activity is determined by AnalysisUtils.isActive()
    
    Parameters:
    
    active - Amount of active players
    
    See Also:
    
    AnalysisUtils
  - getInactive
```
public int getInactive()
```
    Set the amount of inactive players. Activity is determined by AnalysisUtils.isActive()
    
    Returns:
    
    Amount of inactive players
    
    See Also:
    
    AnalysisUtils
  - setInactive
```
public void setInactive(int inactive)
```
    Set the amount of inactive players. Activity is determined by AnalysisUtils.isActive()
    
    Parameters:
    
    inactive - Amount of inactive players
    
    See Also:
    
    AnalysisUtils
  - getTotal
```
public int getTotal()
```
    Get the total amount of players used to calculate activity.
    
    Returns:
    
    0 to Integer.MAX
  - setTotal
```
public void setTotal(int total)
```
    Set the total amount of players used to calculate activity. No check for correct value.
    
    Parameters:
    
    total - 0 to Integer.MAX
  - getGm0Perc
```
public double getGm0Perc()
```
    Get percentage of Gamemode usage time as a whole.
    
    Returns:
    
    0.0 to 1.0
  - setGm0Perc
```
public void setGm0Perc(double gm0Perc)
```
    Set percentage of Gamemode usage time as a whole. No check for correct value.
    
    Parameters:
    
    gm0Perc - 0.0 to 1.0
  - getGm1Perc
```
public double getGm1Perc()
```
    Get percentage of Gamemode usage time as a whole.
    
    Returns:
    
    0.0 to 1.0
  - setGm1Perc
```
public void setGm1Perc(double gm1Perc)
```
    Set percentage of Gamemode usage time as a whole. No check for correct value.
    
    Parameters:
    
    gm1Perc - 0.0 to 1.0
  - getGm2Perc
```
public double getGm2Perc()
```
    Get percentage of Gamemode usage time as a whole.
    
    Returns:
    
    0.0 to 1.0
  - setGm2Perc
```
public void setGm2Perc(double gm2Perc)
```
    Set percentage of Gamemode usage time as a whole. No check for correct value.
    
    Parameters:
    
    gm2Perc - 0.0 to 1.0
  - getGm3Perc
```
public double getGm3Perc()
```
    Get percentage of Gamemode usage time as a whole.
    
    Returns:
    
    0.0 to 1.0
  - setGm3Perc
```
public void setGm3Perc(double gm3Perc)
```
    Set percentage of Gamemode usage time as a whole. No check for correct value.
    
    Parameters:
    
    gm3Perc - 0.0 to 1.0
  - getTotalPlayers
```
public int getTotalPlayers()
```
    Get percentage of Gamemode usage time as a whole.
    
    Returns:
    
    0.0 to 1.0
  - setTotalPlayers
```
public void setTotalPlayers(int totalPlayers)
```
    Get the Total number of players according to bukkit's data.
    
    Parameters:
    
    totalPlayers - 0 to Integer.MAX
  - getTotalPlayTime
```
public long getTotalPlayTime()
```
    Get how long time has been played, long in ms.
    
    Returns:
    
    0 to Long.MAX
  - setTotalPlayTime
```
public void setTotalPlayTime(long totalPlayTime)
```
    Set how long time has been played, long in ms. No check for correct value.
    
    Parameters:
    
    totalPlayTime - 0 to Long.MAX
  - getRefreshDate
```
public long getRefreshDate()
```
    Retrieve the refresh Epoch millisecond this object's data was calculated.
    
    Returns:
    
    the refresh Epoch millisecond.
  - getAveragePlayTime
```
public long getAveragePlayTime()
```
    Get How long players have played on average.
    
    Returns:
    
    long in ms.
  - getAverageAge
```
public double getAverageAge()
```
    Get the average age of the players whose age has been gathered. -1 if none have been gathered.
    
    Returns:
    
    -1 or from 1.0 to 99.0
  - getTotalLoginTimes
```
public long getTotalLoginTimes()
```
    Get How many times players have joined in total.
    
    Returns:
    
    0 to Long.MAX
  - getOps
```
public int getOps()
```
    Get How many operators are on the server.
    
    Returns:
    
    0 to Integer.MAX
  - setRefreshDate
```
public void setRefreshDate(long refreshDate)
```
    Set the refresh Epoch millisecond this object's data was calculated.
    
    Parameters:
    
    refreshDate - Epoch millisecond.
  - setAveragePlayTime
```
public void setAveragePlayTime(long averagePlayTime)
```
    Set the average playtime of all players.
    
    Parameters:
    
    averagePlayTime - long in ms.
  - setAverageAge
```
public void setAverageAge(double averageAge)
```
    Set the average age of the players whose age has been gathered. No check for correct value.
    
    Parameters:
    
    averageAge - 1.0 to 99.0 or -1 if none have been gathered.
  - setTotalLoginTimes
```
public void setTotalLoginTimes(long totalLoginTimes)
```
    Set How many times playes have logged in.
    
    Parameters:
    
    totalLoginTimes - 0 to Long.MAX
  - setOps
```
public void setOps(int ops)
```
    Set the amount of operators.
    
    Parameters:
    
    ops - 0 to Integer.MAX
  - getRecentPlayers
```
public String getRecentPlayers()
```
    Get the html for Recent player buttons.
    
    Returns:
    
    html string.
    
    See Also:
    
    RecentPlayersButtonsCreator
  - setRecentPlayers
```
public void setRecentPlayers(String recentPlayers)
```
    Set the html for Recent player buttons.
    
    Parameters:
    
    recentPlayers - html string.
    
    See Also:
    
    RecentPlayersButtonsCreator
  - getNewPlayersMonth
```
public int getNewPlayersMonth()
```
    Get the amount of registered players in last 30 days.
    
    Returns:
    
    0 to Integer.MAX
  - setNewPlayersMonth
```
public void setNewPlayersMonth(int newPlayersMonth)
```
    Set the amount of registered players in last 30 days. No check for correct value.
    
    Parameters:
    
    newPlayersMonth - 0 to Integer.MAX
  - getNewPlayersWeek
```
public int getNewPlayersWeek()
```
    Get the amount of registered players in last 7 days.
    
    Returns:
    
    0 to Integer.MAX
  - setNewPlayersWeek
```
public void setNewPlayersWeek(int newPlayersWeek)
```
    Set the amount of registered players in last 7 days. No check for correct value.
    
    Parameters:
    
    newPlayersWeek - 0 to Integer.MAX
  - getNewPlayersDay
```
public int getNewPlayersDay()
```
    Get the amount of registered players in last 24 hours.
    
    Returns:
    
    0 to Integer.MAX
  - setNewPlayersDay
```
public void setNewPlayersDay(int newPlayersDay)
```
    Set the amount of registered players in last 24 hours. No check for correct value.
    
    Parameters:
    
    newPlayersDay - 0 to Integer.MAX
  - getTotalPlayerKills
```
public long getTotalPlayerKills()
```
    Get the amount of times players have killed each other.
    
    Returns:
    
    0 to Long.MAX
  - getTotalMobKills
```
public long getTotalMobKills()
```
    Get the amount of mob kills the players have.
    
    Returns:
    
    0 to Long.MAX
  - getTotalDeaths
```
public long getTotalDeaths()
```
    Get how many times the playes have died.
    
    Returns:
    
    0 to Long.MAX
  - setTotalkills
```
public void setTotalkills(long totalkills)
```
    Set the amount of times players have killed each other. No check for correct value.
    
    Parameters:
    
    totalkills - 0 to Long.MAX
  - setTotalmobkills
```
public void setTotalmobkills(long totalmobkills)
```
    Set the amount of mob kills the players have. No check for correct value.
    
    Parameters:
    
    totalmobkills - 0 to Long.MAX
  - setTotaldeaths
```
public void setTotaldeaths(long totaldeaths)
```
    Set how many times the playes have died. No check for correct value.
    
    Parameters:
    
    totaldeaths - 0 to Long.MAX
  - getPlayersDataArray
```
public String[] getPlayersDataArray()
```
    Used to store all arrays created in Analysis#createPlayerActivityGraphs(). 0, 2, 4 contain data. 1, 3, 5 contain labels. 0, 1 day; 2, 3 week; 4, 5 month
    
    Returns:
    
    String array containing multiple toString representations of number and label arrays.
    
    See Also:
    
    PlayerActivityGraphCreator, Analysis
  - setPlayersDataArray
```
public void setPlayersDataArray(String[] playersDataArray)
```
    Used to store all arrays created in Analysis#createPlayerActivityGraphs(). 0, 2, 4 contain data. 1, 3, 5 contain labels. 0, 1 day; 2, 3 week; 4, 5 month
    
    Parameters:
    
    playersDataArray - String array containing multiple toString representations of number and label arrays.
    
    See Also:
    
    PlayerActivityGraphCreator, Analysis
  - setTotalCommands
```
public void setTotalCommands(long totalCommands)
```
    Set the total number of unique commands. No check for correct value.
    
    Parameters:
    
    totalCommands - 0 to Long.MAX
  - getTotalCommands
```
public long getTotalCommands()
```
    Get the total number of unique commands.
    
    Returns:
    
    0 to Long.MAX
  - getSessionAverage
```
public long getSessionAverage()
```
    Get the average length of every session on the server.
    
    Returns:
    
    long in ms.
  - setSessionAverage
```
public void setSessionAverage(long sessionAverage)
```
    Set the average length of every session on the server.
    
    Parameters:
    
    sessionAverage - 0 to Long.MAX
  - getGenderData
```
public int[] getGenderData()
```
    Get the integer array containing 3 numbers. 0 Male, 1 Female, 2 Unknown.
    
    Returns:
    
    for example [0, 4, 5] when 0 male, 4 female and 5 unknown.
  - setGenderData
```
public void setGenderData(int[] genderData)
```
    Set the integer array containing 3 numbers. 0 Male, 1 Female, 2 Unknown.
    
    Parameters:
    
    genderData - for example [0, 4, 5]

Class AnalysisData

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AnalysisData

Method Detail

equals

setAdditionalDataReplaceMap

getAdditionalDataReplaceMap

getGeomapCountries

setGeomapCountries

getGeomapZ

setGeomapZ

getGeomapCodes

setGeomapCodes

getSortablePlayersTable

setSortablePlayersTable

getJoinleaver

setJoinleaver

getCommandUseListHtml

setCommandUseTableHtml

getBanned

setBanned

getActive

setActive

getInactive

setInactive

getTotal

setTotal

getGm0Perc

setGm0Perc

getGm1Perc

setGm1Perc

getGm2Perc

setGm2Perc

getGm3Perc

setGm3Perc

getTotalPlayers

setTotalPlayers

getTotalPlayTime

setTotalPlayTime

getRefreshDate

getAveragePlayTime

getAverageAge

getTotalLoginTimes

getOps

setRefreshDate

setAveragePlayTime

setAverageAge

setTotalLoginTimes

setOps

getRecentPlayers

setRecentPlayers

getNewPlayersMonth

setNewPlayersMonth

getNewPlayersWeek

setNewPlayersWeek

getNewPlayersDay

setNewPlayersDay

getTotalPlayerKills

getTotalMobKills

getTotalDeaths

setTotalkills

setTotalmobkills

setTotaldeaths

getPlayersDataArray

setPlayersDataArray

setTotalCommands

getTotalCommands

getSessionAverage

setSessionAverage

getGenderData

setGenderData