cdx.scorebot.app.reporter
Class CompleteScoringStats

java.lang.Object
  extended by cdx.scorebot.app.reporter.CompleteScoringStats

public final class CompleteScoringStats
extends java.lang.Object

Generates complete scoring stats as HTML.

Author:
David Underhill

Field Summary
static java.lang.String COMPETITION_NAME
          will be replaced with the competition's name
 java.lang.String competitionName
          name of the competition this team is a part of
static java.lang.String CONFIG_CHOICE_TYPE
          will be replaced with the method used to choose on of the option's values
static java.lang.String CONFIG_DESC
          will be replaced with the description of the option
static java.lang.String CONFIG_END
          will be replaced with a row for each option (end flag)
static java.lang.String CONFIG_NAME
          will be replaced with the name of the option
static java.lang.String CONFIG_SM_END
          will be replaced with a row for each option (short form) (end flag)
static java.lang.String CONFIG_SM_START
          will be replaced with a row for each option (short form) (begin flag)
static java.lang.String CONFIG_START
          will be replaced with a row for each option (begin flag)
static java.lang.String CONFIG_TYPE
          will be replaced with the option type
static java.lang.String CONFIG_VALUE
          will be replaced with the option's current value
static java.lang.String CONFIG_VALUES
          will be replaced with the option's values
static java.lang.String END
          end of a set of rows
static java.lang.String MSE_COUNT
          will be replaced with the number of manual score events which exist
static java.lang.String MSE_EXPLAN
          will be replaced with the explanation of the manual score event
static java.lang.String MSE_FN
          will be replaced with the filename of the manual score event (its index which is used as its filename)
static java.lang.String MSE_REPORTED
          will be replaced with a boolean stating whther or not this manual score event was reported/known
static java.lang.String MSE_SCORE
          will be replaced with the total score for the manual score event
static java.lang.String MSE_TIME
          will be replaced with the time the manual score event was generated
static java.lang.String MSE_TITLE
          will be replaced with the title of the manual score event
static java.lang.String MSE_TOTAL_SCORE
          will be replaced with the number of total points accumulated/lost from all manual score events which exist
static java.lang.String NTP_DESC
          will be replaced with the
static java.lang.String NTP_INIT_SCORE
          will be replaced with the initial score for the NTP
static java.lang.String NTP_MAX_SCORE
          will be replaced with the max score for the NTP
static java.lang.String NTP_MIN_SCORE
          will be replaced with the min score for the NTP
 java.lang.String outputPath
          the root output directory to save the report to
static java.lang.String REPORT_AVG_SCORE
          will be replaced with the average score based on each competitor's score
static java.lang.String REPORT_COMMENTS
          will be replaced with the comments
static java.lang.String REPORT_COMPLETE_INFO
          will be replaced with whether or not complete info is being used
static java.lang.String REPORT_GEN_TIME
          will be replaced with the name of the owner/team
static java.lang.String REPORT_PERIOD
          will be replaced with the range of times during which test events were run
static java.lang.String REPORT_TOP_SCORE
          will be replaced with the top score out of all competitors
static java.lang.String REPORT_TOTAL_SCORE
          will be replaced with the
static java.lang.String RESULT_AUDIT_VALUE
          will be replaced with the audited value of the return / result
static java.lang.String RESULT_COMMENT
          will be replaced with the comment of the return / result
static java.lang.String RESULT_DESC
          will be replaced with the description of the return / result
static java.lang.String RESULT_END
          will be replaced with a row for each return / result (end flag)
static java.lang.String RESULT_NAME
          will be replaced with the name of the return / result
static java.lang.String RESULT_START
          will be replaced with a row for each return / result (begin flag)
static java.lang.String RESULT_TYPE
          will be replaced with the value of the return / result type
static java.lang.String RESULT_VALUE
          will be replaced with the value of the return / result
static java.lang.String RULE_CODE
          will be replaced with the code which this rule scores on
static java.lang.String RULE_COUNT
          will be replaced with the number of rules which exist
static java.lang.String RULE_DESC
          will be replaced with the description of the rule
static java.lang.String RULE_END
          will be replaced with a row for each rule (end flag)
static java.lang.String RULE_FN
          will be replaced with the fn of the rule (its index which is used as its filename)
static java.lang.String RULE_MAX_BONUS
          will be replaced with the max bonus the rule can make (cumulative)
static java.lang.String RULE_MAX_DEDUCTION
          will be replaced with the max deduction the rule can make (cumulative)
static java.lang.String RULE_MAX_PER_TIME_BONUS
          will be replaced with the score component of the max bonus over time
static java.lang.String RULE_MAX_PER_TIME_DEDUCTION
          will be replaced with the score component of the max deduction over time
static java.lang.String RULE_MAX_PER_TIME_MIN
          will be replaced with the time component (in min) of the max deduction over time
static java.lang.String RULE_NAME
          will be replaced with the name of the rule
static java.lang.String RULE_START
          will be replaced with a row for each rule (begin flag)
static java.lang.String RULE_UNIQUE_RESULTS
          will be replaced with the boolean value which indicates whether or not unique results are used
static java.lang.String SCHED_AUTO
          will be replaced with whether or not this test was auto-scheduled
static java.lang.String SCHED_AUTO_END
          denotes the end of the schedule portion for auto-scheduling choice and beginning of other auto-only info
static java.lang.String SCHED_AUTO_START
          denotes the beginning of the schedule portion for auto-scheduling choice
static java.lang.String SCHED_MAX_INTERVAL
          will be replaced with the maximum interval at which this test would be scheduled to run
static java.lang.String SCHED_MIN_INTERVAL
          will be replaced with the minimum interval at which this test would be scheduled to run
static java.lang.String SCHED_NOTAUTO_END
          denotes the end of the auto-only schedule portion
static java.lang.String SCHED_REPS
          will be replaced with the schedule's repetition count
static java.lang.String SCHED_TIME_BW_REPS
          will be replaced with the time between repetitions
static java.lang.String SCHED_TR
          will be replaced with a time range
static java.lang.String SCHED_TR_END
          will be replaced with a row for each time range (end flag)
static java.lang.String SCHED_TR_START
          will be replaced with a row for each time range (begin flag)
 TeamScoringInfo scoringInfo
          scoring information about the team whose statistics are being generated
static java.lang.String SE_AGGR_END
          will be replaced with a row for each aggravating event (end flag)
static java.lang.String SE_AGGR_START
          will be replaced with a row for each aggravating event (begin flag)
static java.lang.String SE_EXPLAN
          will be replaced with the explanation of the score event
static java.lang.String SE_FN
          will be replaced with the filename of the score event (its index which is used as its filename)
static java.lang.String SE_REPORTED
          will be replaced with a boolean stating whther or not this score event was reported/known
static java.lang.String SE_RULE_FN
          will be replaced with the filename of the rule (its index which is used as its filename)
static java.lang.String SE_RULE_NAME
          will be replaced with the name of the rule which generated the score event
static java.lang.String SE_SCORE
          will be replaced with the total score for the score event
static java.lang.String SE_THRESH_SCORE
          will be replaced with the being tested by this score event
static java.lang.String SE_THRESH_TYPE
          will be replaced with the type of threshold applied to the score event (if any)
static java.lang.String SE_TIME
          will be replaced with the time the score event was generated
static java.lang.String SE_TIME_COMP
          will be replaced with the time the score event was completed
static java.lang.String SE_TIME_REP
          will be replaced with the time the score event was reported
static java.lang.String SE_TITLE
          will be replaced with the title of the score event
static java.lang.String SERVICE_COUNT
          will be replaced with the number of services which exist
static java.lang.String SERVICE_DESC
          will be replaced with the service the suite is testing
static java.lang.String SERVICE_FN
          will be replaced with the filename of the service (its index which is used as its filename)
static java.lang.String SERVICE_NAME
          will be replaced with the name of the suite
static java.lang.String SERVICE_TS_ASSOC
          will be replaced with the name of the associated suites and links to them
static java.lang.String START
          beginning of a set of rows
static java.lang.String TBL_AGGR_END
          aggravating events table (end flag)
static java.lang.String TBL_AGGR_START
          aggravating events table (begin flag)
static java.lang.String TE_CONFIG_ALL
          will be replaced with the specific option values used in the test which generated this test event (one per line)
static java.lang.String TE_COUNT
          will be replaced with the number of test events which exist
static java.lang.String TE_DURATION
          will be replaced with the length of time the test event took to run
static java.lang.String TE_END
          will be replaced with a row for each test event (end flag)
static java.lang.String TE_EXPLAN
          will be replaced with the description from the test regarding what happened
static java.lang.String TE_FN
          will be replaced with the filename of the test event (its index which is used as its filename)
static java.lang.String TE_RESULT_NUM
          will be replaced with the number which indicates how this result was when processed (0 = most recent)
static java.lang.String TE_RESULTS_ALL
          will be replaced with the specific result values resulting from the test which generated this test event (one per line)
static java.lang.String TE_START
          will be replaced with a row for each test event (begin flag)
static java.lang.String TE_TEST
          will be replaced with the name of the test which created this test event
static java.lang.String TE_TIME_COMP
          will be replaced with the time the test event was completed
static java.lang.String TE_TIME_REP
          will be replaced with the time the test event was reported
static java.lang.String TEAM_COMMENTS
          will be replaced with the team's comments
static java.lang.String TEAM_END
          will be replaced with a row for each team (end flag)
static java.lang.String TEAM_NAME
          will be replaced with the name of the team
static java.lang.String TEAM_RANK
          will be replaced with the rank of the team versus other competitors ("--" if there are no other competitors)
static java.lang.String TEAM_SCORE
          will be replaced with the total score of the team
static java.lang.String TEAM_START
          will be replaced with a row for each team (begin flag)
 java.lang.String templateDir
          where to load the HTML template pages from
static java.lang.String TEST_COUNT
          will be replaced with the number of tests which exist
static java.lang.String TEST_DESC
          will be replaced with the description of the test
static java.lang.String TEST_FN
          will be replaced with the filename of the test (its index which is used as its filename)
static java.lang.String TEST_NAME
          will be replaced with the name of the test
static java.lang.String TEST_NUM_RUNS
          will be replaced with the number of times this test was run
static java.lang.String TEST_SCORE
          will be replaced with the total score for the test
static java.lang.String TEST_SERVICE
          will be replaced with the service this test can test
static java.lang.String TI_COUNT
          will be replaced with the number of test items which exist
static java.lang.String TI_DESC
          will be replaced with the description of the item
static java.lang.String TI_FN
          will be replaced with the filename of the item (its index which is used as its filename)
static java.lang.String TI_NAME
          will be replaced with the name of the item
static java.lang.String TI_NUM_RUNS
          will be replaced with the number of times this item was run
static java.lang.String TI_SCORE
          will be replaced with the total score for the item
static java.lang.String TI_TEST
          will be replaced with the test being tested by this item
static java.lang.String TS_COUNT
          will be replaced with the number of suites which exist
static java.lang.String TS_DESC
          will be replaced with the description of the suite
static java.lang.String TS_END
          will be replaced with a row for each test suite (end flag)
static java.lang.String TS_FN
          will be replaced with the filename of the suite (its index which is used as its filename)
static java.lang.String TS_IP
          will be replaced with the IP of the service the suite is testing
static java.lang.String TS_MAX_SCORE
          will be replaced with the max allowed score for the suite
static java.lang.String TS_MIN_SCORE
          will be replaced with the min allowed score for the suite
static java.lang.String TS_NAME
          will be replaced with the name of the suite
static java.lang.String TS_PORT
          will be replaced with the port of the service the suite is testing
static java.lang.String TS_SCORE
          will be replaced with the total score for the suite
static java.lang.String TS_SCORE_CHANGE
          will be replaced with the total score change for the suite
static java.lang.String TS_SERVICE
          will be replaced with the service the suite is testing
static java.lang.String TS_START
          will be replaced with a row for each test suite (begin flag)
static java.lang.String TS_TI_END
          will be replaced with a row for each test item (end flag)
static java.lang.String TS_TI_START
          will be replaced with a row for each test item (begin flag)
static java.lang.String TSE_ACTUAL_SCORE
          will be replaced with the actual total score for the test score event (takes thresholds into account)
static java.lang.String TSE_COUNT
          will be replaced with the number of test score events which exist
static java.lang.String TSE_END
          will be replaced with a row for each test score event (end flag)
static java.lang.String TSE_EXPLAN
          will be replaced with the explanation of the test score event
static java.lang.String TSE_FN
          will be replaced with the filename of the test score event (its index which is used as its filename)
static java.lang.String TSE_REPORTED
          will be replaced with a boolean stating whther or not this test score event was reported/known
static java.lang.String TSE_RULE_FN
          will be replaced with the filename of the rule (its index which is used as its filename)
static java.lang.String TSE_RULE_NAME
          will be replaced with the name of the rule which generated the test score event
static java.lang.String TSE_SCORE
          will be replaced with the total score for the test score event
static java.lang.String TSE_START
          will be replaced with a row for each test score event (begin flag)
static java.lang.String TSE_THRESH_SCORE
          will be replaced with the test being tested by this test score event
static java.lang.String TSE_THRESH_TYPE
          will be replaced with the type of threshold applied to the test score event (if any)
static java.lang.String TSE_TIME
          will be replaced with the time the test score event was generated
static java.lang.String TSE_TIME_COMP
          will be replaced with the time the test score event was completed
static java.lang.String TSE_TIME_REP
          will be replaced with the time the test score event was reported
static java.lang.String TSE_TITLE
          will be replaced with the title of the test score event
static java.lang.String TT_END
          will be replaced with a row for each test tracking (end flag)
static java.lang.String TT_NUM
          will be replaced with the number which indicates how many of this test type are being used in scoring considerations
static java.lang.String TT_START
          will be replaced with a row for each test tracking (begin flag)
static java.lang.String TT_TEST
          will be replaced with the name of the test which is being tracked
static java.lang.String TT_TEST_ITEM
          will be replaced with the name of the test item which is being tracked
 
Constructor Summary
CompleteScoringStats(java.lang.String compName, TeamScoringInfo teamToScoreInfo, java.lang.String outputPath, java.lang.String templatePath)
          Defines where ScoreEvents are read from and where stats in HTML files are outputted too.
 
Method Summary
protected static java.lang.String checkedToString(java.lang.Object o)
          if the object is not null, its toString method is returned; otherwise n/a is returned
protected static java.lang.String fnum(long n)
          formats numbers to have use commas
protected  void generate()
          generates the statistics
static void generateIndexPage(java.lang.String competitionName, java.lang.String outputPath, java.lang.String templateDir, java.lang.String reportGenTime, java.lang.String reportPeriod, java.lang.String reportComments, int minPts, int initPts, int maxPts, int reportTopScore, int reportAvgScore, java.util.Vector<java.lang.String> suiteNames, java.util.Vector<java.util.Vector<java.lang.Integer>> teamSuiteScores, java.lang.String desc, java.util.Vector<TeamScoringInfo> teamScores, boolean useAllInfo)
          the index.htm page
 java.lang.String subManualScoreEventInfo(java.lang.String page, ManualScoreEvent mse)
          substitute in Manual Score Event information
 java.lang.String subScoreEventInfo(java.lang.String page, ScoreEvent se)
          substitute in Test Score Event information
 java.lang.String subScoringRuleInfo(java.lang.String page, ScoringRule rule)
          substitute in Scoring Rule information
 java.lang.String subServiceInfo(java.lang.String page, Service s)
          substitute in Service information
 java.lang.String subTestEventInfo(java.lang.String page, TestEvent te, java.lang.Integer resultNum)
          substitute in Test Event information
 java.lang.String subTestInfo(java.lang.String page, Test t)
          substitute in Test information
 java.lang.String subTestItemInfo(java.lang.String page, TestItem ti)
          substitute in Test Item information
 java.lang.String subTestScoreEventInfo(java.lang.String page, TestScoreEvent tse)
          substitute in Test Score Event information
 java.lang.String subTestSuiteInfo(java.lang.String page, TestSuite ts)
          substitute in Test information
protected static java.lang.String tobr(java.lang.String s)
          replaces any newline characters (\r\n, \n, \r) with
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

START

public static final java.lang.String START
beginning of a set of rows

See Also:
Constant Field Values

END

public static final java.lang.String END
end of a set of rows

See Also:
Constant Field Values

REPORT_GEN_TIME

public static final java.lang.String REPORT_GEN_TIME
will be replaced with the name of the owner/team

See Also:
Constant Field Values

REPORT_PERIOD

public static final java.lang.String REPORT_PERIOD
will be replaced with the range of times during which test events were run

See Also:
Constant Field Values

REPORT_COMMENTS

public static final java.lang.String REPORT_COMMENTS
will be replaced with the comments

See Also:
Constant Field Values

REPORT_TOTAL_SCORE

public static final java.lang.String REPORT_TOTAL_SCORE
will be replaced with the

See Also:
Constant Field Values

COMPETITION_NAME

public static final java.lang.String COMPETITION_NAME
will be replaced with the competition's name

See Also:
Constant Field Values

REPORT_COMPLETE_INFO

public static final java.lang.String REPORT_COMPLETE_INFO
will be replaced with whether or not complete info is being used

See Also:
Constant Field Values

REPORT_TOP_SCORE

public static final java.lang.String REPORT_TOP_SCORE
will be replaced with the top score out of all competitors

See Also:
Constant Field Values

REPORT_AVG_SCORE

public static final java.lang.String REPORT_AVG_SCORE
will be replaced with the average score based on each competitor's score

See Also:
Constant Field Values

TEAM_NAME

public static final java.lang.String TEAM_NAME
will be replaced with the name of the team

See Also:
Constant Field Values

TEAM_RANK

public static final java.lang.String TEAM_RANK
will be replaced with the rank of the team versus other competitors ("--" if there are no other competitors)

See Also:
Constant Field Values

TEAM_SCORE

public static final java.lang.String TEAM_SCORE
will be replaced with the total score of the team

See Also:
Constant Field Values

TEAM_COMMENTS

public static final java.lang.String TEAM_COMMENTS
will be replaced with the team's comments

See Also:
Constant Field Values

TEAM_START

public static final java.lang.String TEAM_START
will be replaced with a row for each team (begin flag)

See Also:
Constant Field Values

TEAM_END

public static final java.lang.String TEAM_END
will be replaced with a row for each team (end flag)

See Also:
Constant Field Values

NTP_DESC

public static final java.lang.String NTP_DESC
will be replaced with the

See Also:
Constant Field Values

NTP_INIT_SCORE

public static final java.lang.String NTP_INIT_SCORE
will be replaced with the initial score for the NTP

See Also:
Constant Field Values

NTP_MAX_SCORE

public static final java.lang.String NTP_MAX_SCORE
will be replaced with the max score for the NTP

See Also:
Constant Field Values

NTP_MIN_SCORE

public static final java.lang.String NTP_MIN_SCORE
will be replaced with the min score for the NTP

See Also:
Constant Field Values

TS_COUNT

public static final java.lang.String TS_COUNT
will be replaced with the number of suites which exist

See Also:
Constant Field Values

TS_SCORE

public static final java.lang.String TS_SCORE
will be replaced with the total score for the suite

See Also:
Constant Field Values

TS_SCORE_CHANGE

public static final java.lang.String TS_SCORE_CHANGE
will be replaced with the total score change for the suite

See Also:
Constant Field Values

TS_NAME

public static final java.lang.String TS_NAME
will be replaced with the name of the suite

See Also:
Constant Field Values

TS_FN

public static final java.lang.String TS_FN
will be replaced with the filename of the suite (its index which is used as its filename)

See Also:
Constant Field Values

TS_DESC

public static final java.lang.String TS_DESC
will be replaced with the description of the suite

See Also:
Constant Field Values

TS_SERVICE

public static final java.lang.String TS_SERVICE
will be replaced with the service the suite is testing

See Also:
Constant Field Values

TS_IP

public static final java.lang.String TS_IP
will be replaced with the IP of the service the suite is testing

See Also:
Constant Field Values

TS_PORT

public static final java.lang.String TS_PORT
will be replaced with the port of the service the suite is testing

See Also:
Constant Field Values

TS_MIN_SCORE

public static final java.lang.String TS_MIN_SCORE
will be replaced with the min allowed score for the suite

See Also:
Constant Field Values

TS_MAX_SCORE

public static final java.lang.String TS_MAX_SCORE
will be replaced with the max allowed score for the suite

See Also:
Constant Field Values

TS_START

public static final java.lang.String TS_START
will be replaced with a row for each test suite (begin flag)

See Also:
Constant Field Values

TS_END

public static final java.lang.String TS_END
will be replaced with a row for each test suite (end flag)

See Also:
Constant Field Values

TS_TI_START

public static final java.lang.String TS_TI_START
will be replaced with a row for each test item (begin flag)

See Also:
Constant Field Values

TS_TI_END

public static final java.lang.String TS_TI_END
will be replaced with a row for each test item (end flag)

See Also:
Constant Field Values

SERVICE_COUNT

public static final java.lang.String SERVICE_COUNT
will be replaced with the number of services which exist

See Also:
Constant Field Values

SERVICE_NAME

public static final java.lang.String SERVICE_NAME
will be replaced with the name of the suite

See Also:
Constant Field Values

SERVICE_TS_ASSOC

public static final java.lang.String SERVICE_TS_ASSOC
will be replaced with the name of the associated suites and links to them

See Also:
Constant Field Values

SERVICE_FN

public static final java.lang.String SERVICE_FN
will be replaced with the filename of the service (its index which is used as its filename)

See Also:
Constant Field Values

SERVICE_DESC

public static final java.lang.String SERVICE_DESC
will be replaced with the service the suite is testing

See Also:
Constant Field Values

TEST_COUNT

public static final java.lang.String TEST_COUNT
will be replaced with the number of tests which exist

See Also:
Constant Field Values

TEST_NAME

public static final java.lang.String TEST_NAME
will be replaced with the name of the test

See Also:
Constant Field Values

TEST_FN

public static final java.lang.String TEST_FN
will be replaced with the filename of the test (its index which is used as its filename)

See Also:
Constant Field Values

TEST_SERVICE

public static final java.lang.String TEST_SERVICE
will be replaced with the service this test can test

See Also:
Constant Field Values

TEST_NUM_RUNS

public static final java.lang.String TEST_NUM_RUNS
will be replaced with the number of times this test was run

See Also:
Constant Field Values

TEST_SCORE

public static final java.lang.String TEST_SCORE
will be replaced with the total score for the test

See Also:
Constant Field Values

TEST_DESC

public static final java.lang.String TEST_DESC
will be replaced with the description of the test

See Also:
Constant Field Values

TI_COUNT

public static final java.lang.String TI_COUNT
will be replaced with the number of test items which exist

See Also:
Constant Field Values

TI_NUM_RUNS

public static final java.lang.String TI_NUM_RUNS
will be replaced with the number of times this item was run

See Also:
Constant Field Values

TI_SCORE

public static final java.lang.String TI_SCORE
will be replaced with the total score for the item

See Also:
Constant Field Values

TI_NAME

public static final java.lang.String TI_NAME
will be replaced with the name of the item

See Also:
Constant Field Values

TI_FN

public static final java.lang.String TI_FN
will be replaced with the filename of the item (its index which is used as its filename)

See Also:
Constant Field Values

TI_TEST

public static final java.lang.String TI_TEST
will be replaced with the test being tested by this item

See Also:
Constant Field Values

TI_DESC

public static final java.lang.String TI_DESC
will be replaced with the description of the item

See Also:
Constant Field Values

CONFIG_NAME

public static final java.lang.String CONFIG_NAME
will be replaced with the name of the option

See Also:
Constant Field Values

CONFIG_DESC

public static final java.lang.String CONFIG_DESC
will be replaced with the description of the option

See Also:
Constant Field Values

CONFIG_TYPE

public static final java.lang.String CONFIG_TYPE
will be replaced with the option type

See Also:
Constant Field Values

CONFIG_CHOICE_TYPE

public static final java.lang.String CONFIG_CHOICE_TYPE
will be replaced with the method used to choose on of the option's values

See Also:
Constant Field Values

CONFIG_VALUES

public static final java.lang.String CONFIG_VALUES
will be replaced with the option's values

See Also:
Constant Field Values

CONFIG_VALUE

public static final java.lang.String CONFIG_VALUE
will be replaced with the option's current value

See Also:
Constant Field Values

CONFIG_START

public static final java.lang.String CONFIG_START
will be replaced with a row for each option (begin flag)

See Also:
Constant Field Values

CONFIG_END

public static final java.lang.String CONFIG_END
will be replaced with a row for each option (end flag)

See Also:
Constant Field Values

CONFIG_SM_START

public static final java.lang.String CONFIG_SM_START
will be replaced with a row for each option (short form) (begin flag)

See Also:
Constant Field Values

CONFIG_SM_END

public static final java.lang.String CONFIG_SM_END
will be replaced with a row for each option (short form) (end flag)

See Also:
Constant Field Values

RESULT_NAME

public static final java.lang.String RESULT_NAME
will be replaced with the name of the return / result

See Also:
Constant Field Values

RESULT_DESC

public static final java.lang.String RESULT_DESC
will be replaced with the description of the return / result

See Also:
Constant Field Values

RESULT_VALUE

public static final java.lang.String RESULT_VALUE
will be replaced with the value of the return / result

See Also:
Constant Field Values

RESULT_TYPE

public static final java.lang.String RESULT_TYPE
will be replaced with the value of the return / result type

See Also:
Constant Field Values

RESULT_AUDIT_VALUE

public static final java.lang.String RESULT_AUDIT_VALUE
will be replaced with the audited value of the return / result

See Also:
Constant Field Values

RESULT_COMMENT

public static final java.lang.String RESULT_COMMENT
will be replaced with the comment of the return / result

See Also:
Constant Field Values

RESULT_START

public static final java.lang.String RESULT_START
will be replaced with a row for each return / result (begin flag)

See Also:
Constant Field Values

RESULT_END

public static final java.lang.String RESULT_END
will be replaced with a row for each return / result (end flag)

See Also:
Constant Field Values

RULE_COUNT

public static final java.lang.String RULE_COUNT
will be replaced with the number of rules which exist

See Also:
Constant Field Values

RULE_NAME

public static final java.lang.String RULE_NAME
will be replaced with the name of the rule

See Also:
Constant Field Values

RULE_FN

public static final java.lang.String RULE_FN
will be replaced with the fn of the rule (its index which is used as its filename)

See Also:
Constant Field Values

RULE_DESC

public static final java.lang.String RULE_DESC
will be replaced with the description of the rule

See Also:
Constant Field Values

RULE_CODE

public static final java.lang.String RULE_CODE
will be replaced with the code which this rule scores on

See Also:
Constant Field Values

RULE_UNIQUE_RESULTS

public static final java.lang.String RULE_UNIQUE_RESULTS
will be replaced with the boolean value which indicates whether or not unique results are used

See Also:
Constant Field Values

RULE_MAX_BONUS

public static final java.lang.String RULE_MAX_BONUS
will be replaced with the max bonus the rule can make (cumulative)

See Also:
Constant Field Values

RULE_MAX_DEDUCTION

public static final java.lang.String RULE_MAX_DEDUCTION
will be replaced with the max deduction the rule can make (cumulative)

See Also:
Constant Field Values

RULE_MAX_PER_TIME_MIN

public static final java.lang.String RULE_MAX_PER_TIME_MIN
will be replaced with the time component (in min) of the max deduction over time

See Also:
Constant Field Values

RULE_MAX_PER_TIME_BONUS

public static final java.lang.String RULE_MAX_PER_TIME_BONUS
will be replaced with the score component of the max bonus over time

See Also:
Constant Field Values

RULE_MAX_PER_TIME_DEDUCTION

public static final java.lang.String RULE_MAX_PER_TIME_DEDUCTION
will be replaced with the score component of the max deduction over time

See Also:
Constant Field Values

RULE_START

public static final java.lang.String RULE_START
will be replaced with a row for each rule (begin flag)

See Also:
Constant Field Values

RULE_END

public static final java.lang.String RULE_END
will be replaced with a row for each rule (end flag)

See Also:
Constant Field Values

SCHED_AUTO

public static final java.lang.String SCHED_AUTO
will be replaced with whether or not this test was auto-scheduled

See Also:
Constant Field Values

SCHED_MIN_INTERVAL

public static final java.lang.String SCHED_MIN_INTERVAL
will be replaced with the minimum interval at which this test would be scheduled to run

See Also:
Constant Field Values

SCHED_MAX_INTERVAL

public static final java.lang.String SCHED_MAX_INTERVAL
will be replaced with the maximum interval at which this test would be scheduled to run

See Also:
Constant Field Values

SCHED_REPS

public static final java.lang.String SCHED_REPS
will be replaced with the schedule's repetition count

See Also:
Constant Field Values

SCHED_TIME_BW_REPS

public static final java.lang.String SCHED_TIME_BW_REPS
will be replaced with the time between repetitions

See Also:
Constant Field Values

SCHED_TR

public static final java.lang.String SCHED_TR
will be replaced with a time range

See Also:
Constant Field Values

SCHED_AUTO_START

public static final java.lang.String SCHED_AUTO_START
denotes the beginning of the schedule portion for auto-scheduling choice

See Also:
Constant Field Values

SCHED_AUTO_END

public static final java.lang.String SCHED_AUTO_END
denotes the end of the schedule portion for auto-scheduling choice and beginning of other auto-only info

See Also:
Constant Field Values

SCHED_NOTAUTO_END

public static final java.lang.String SCHED_NOTAUTO_END
denotes the end of the auto-only schedule portion

See Also:
Constant Field Values

SCHED_TR_START

public static final java.lang.String SCHED_TR_START
will be replaced with a row for each time range (begin flag)

See Also:
Constant Field Values

SCHED_TR_END

public static final java.lang.String SCHED_TR_END
will be replaced with a row for each time range (end flag)

See Also:
Constant Field Values

SE_FN

public static final java.lang.String SE_FN
will be replaced with the filename of the score event (its index which is used as its filename)

See Also:
Constant Field Values

SE_TITLE

public static final java.lang.String SE_TITLE
will be replaced with the title of the score event

See Also:
Constant Field Values

SE_RULE_NAME

public static final java.lang.String SE_RULE_NAME
will be replaced with the name of the rule which generated the score event

See Also:
Constant Field Values

SE_RULE_FN

public static final java.lang.String SE_RULE_FN
will be replaced with the filename of the rule (its index which is used as its filename)

See Also:
Constant Field Values

SE_SCORE

public static final java.lang.String SE_SCORE
will be replaced with the total score for the score event

See Also:
Constant Field Values

SE_REPORTED

public static final java.lang.String SE_REPORTED
will be replaced with a boolean stating whther or not this score event was reported/known

See Also:
Constant Field Values

SE_TIME

public static final java.lang.String SE_TIME
will be replaced with the time the score event was generated

See Also:
Constant Field Values

SE_TIME_COMP

public static final java.lang.String SE_TIME_COMP
will be replaced with the time the score event was completed

See Also:
Constant Field Values

SE_TIME_REP

public static final java.lang.String SE_TIME_REP
will be replaced with the time the score event was reported

See Also:
Constant Field Values

SE_THRESH_TYPE

public static final java.lang.String SE_THRESH_TYPE
will be replaced with the type of threshold applied to the score event (if any)

See Also:
Constant Field Values

SE_THRESH_SCORE

public static final java.lang.String SE_THRESH_SCORE
will be replaced with the being tested by this score event

See Also:
Constant Field Values

SE_EXPLAN

public static final java.lang.String SE_EXPLAN
will be replaced with the explanation of the score event

See Also:
Constant Field Values

TBL_AGGR_START

public static final java.lang.String TBL_AGGR_START
aggravating events table (begin flag)

See Also:
Constant Field Values

TBL_AGGR_END

public static final java.lang.String TBL_AGGR_END
aggravating events table (end flag)

See Also:
Constant Field Values

SE_AGGR_START

public static final java.lang.String SE_AGGR_START
will be replaced with a row for each aggravating event (begin flag)

See Also:
Constant Field Values

SE_AGGR_END

public static final java.lang.String SE_AGGR_END
will be replaced with a row for each aggravating event (end flag)

See Also:
Constant Field Values

TSE_COUNT

public static final java.lang.String TSE_COUNT
will be replaced with the number of test score events which exist

See Also:
Constant Field Values

TSE_FN

public static final java.lang.String TSE_FN
will be replaced with the filename of the test score event (its index which is used as its filename)

See Also:
Constant Field Values

TSE_TITLE

public static final java.lang.String TSE_TITLE
will be replaced with the title of the test score event

See Also:
Constant Field Values

TSE_RULE_NAME

public static final java.lang.String TSE_RULE_NAME
will be replaced with the name of the rule which generated the test score event

See Also:
Constant Field Values

TSE_RULE_FN

public static final java.lang.String TSE_RULE_FN
will be replaced with the filename of the rule (its index which is used as its filename)

See Also:
Constant Field Values

TSE_ACTUAL_SCORE

public static final java.lang.String TSE_ACTUAL_SCORE
will be replaced with the actual total score for the test score event (takes thresholds into account)

See Also:
Constant Field Values

TSE_SCORE

public static final java.lang.String TSE_SCORE
will be replaced with the total score for the test score event

See Also:
Constant Field Values

TSE_REPORTED

public static final java.lang.String TSE_REPORTED
will be replaced with a boolean stating whther or not this test score event was reported/known

See Also:
Constant Field Values

TSE_TIME

public static final java.lang.String TSE_TIME
will be replaced with the time the test score event was generated

See Also:
Constant Field Values

TSE_TIME_COMP

public static final java.lang.String TSE_TIME_COMP
will be replaced with the time the test score event was completed

See Also:
Constant Field Values

TSE_TIME_REP

public static final java.lang.String TSE_TIME_REP
will be replaced with the time the test score event was reported

See Also:
Constant Field Values

TSE_THRESH_TYPE

public static final java.lang.String TSE_THRESH_TYPE
will be replaced with the type of threshold applied to the test score event (if any)

See Also:
Constant Field Values

TSE_THRESH_SCORE

public static final java.lang.String TSE_THRESH_SCORE
will be replaced with the test being tested by this test score event

See Also:
Constant Field Values

TSE_EXPLAN

public static final java.lang.String TSE_EXPLAN
will be replaced with the explanation of the test score event

See Also:
Constant Field Values

TSE_START

public static final java.lang.String TSE_START
will be replaced with a row for each test score event (begin flag)

See Also:
Constant Field Values

TSE_END

public static final java.lang.String TSE_END
will be replaced with a row for each test score event (end flag)

See Also:
Constant Field Values

MSE_COUNT

public static final java.lang.String MSE_COUNT
will be replaced with the number of manual score events which exist

See Also:
Constant Field Values

MSE_TOTAL_SCORE

public static final java.lang.String MSE_TOTAL_SCORE
will be replaced with the number of total points accumulated/lost from all manual score events which exist

See Also:
Constant Field Values

MSE_FN

public static final java.lang.String MSE_FN
will be replaced with the filename of the manual score event (its index which is used as its filename)

See Also:
Constant Field Values

MSE_TIME

public static final java.lang.String MSE_TIME
will be replaced with the time the manual score event was generated

See Also:
Constant Field Values

MSE_TITLE

public static final java.lang.String MSE_TITLE
will be replaced with the title of the manual score event

See Also:
Constant Field Values

MSE_SCORE

public static final java.lang.String MSE_SCORE
will be replaced with the total score for the manual score event

See Also:
Constant Field Values

MSE_REPORTED

public static final java.lang.String MSE_REPORTED
will be replaced with a boolean stating whther or not this manual score event was reported/known

See Also:
Constant Field Values

MSE_EXPLAN

public static final java.lang.String MSE_EXPLAN
will be replaced with the explanation of the manual score event

See Also:
Constant Field Values

TE_COUNT

public static final java.lang.String TE_COUNT
will be replaced with the number of test events which exist

See Also:
Constant Field Values

TE_FN

public static final java.lang.String TE_FN
will be replaced with the filename of the test event (its index which is used as its filename)

See Also:
Constant Field Values

TE_TEST

public static final java.lang.String TE_TEST
will be replaced with the name of the test which created this test event

See Also:
Constant Field Values

TE_EXPLAN

public static final java.lang.String TE_EXPLAN
will be replaced with the description from the test regarding what happened

See Also:
Constant Field Values

TE_RESULT_NUM

public static final java.lang.String TE_RESULT_NUM
will be replaced with the number which indicates how this result was when processed (0 = most recent)

See Also:
Constant Field Values

TE_TIME_COMP

public static final java.lang.String TE_TIME_COMP
will be replaced with the time the test event was completed

See Also:
Constant Field Values

TE_TIME_REP

public static final java.lang.String TE_TIME_REP
will be replaced with the time the test event was reported

See Also:
Constant Field Values

TE_DURATION

public static final java.lang.String TE_DURATION
will be replaced with the length of time the test event took to run

See Also:
Constant Field Values

TE_CONFIG_ALL

public static final java.lang.String TE_CONFIG_ALL
will be replaced with the specific option values used in the test which generated this test event (one per line)

See Also:
Constant Field Values

TE_RESULTS_ALL

public static final java.lang.String TE_RESULTS_ALL
will be replaced with the specific result values resulting from the test which generated this test event (one per line)

See Also:
Constant Field Values

TE_START

public static final java.lang.String TE_START
will be replaced with a row for each test event (begin flag)

See Also:
Constant Field Values

TE_END

public static final java.lang.String TE_END
will be replaced with a row for each test event (end flag)

See Also:
Constant Field Values

TT_TEST_ITEM

public static final java.lang.String TT_TEST_ITEM
will be replaced with the name of the test item which is being tracked

See Also:
Constant Field Values

TT_TEST

public static final java.lang.String TT_TEST
will be replaced with the name of the test which is being tracked

See Also:
Constant Field Values

TT_NUM

public static final java.lang.String TT_NUM
will be replaced with the number which indicates how many of this test type are being used in scoring considerations

See Also:
Constant Field Values

TT_START

public static final java.lang.String TT_START
will be replaced with a row for each test tracking (begin flag)

See Also:
Constant Field Values

TT_END

public static final java.lang.String TT_END
will be replaced with a row for each test tracking (end flag)

See Also:
Constant Field Values

scoringInfo

public final TeamScoringInfo scoringInfo
scoring information about the team whose statistics are being generated


outputPath

public final java.lang.String outputPath
the root output directory to save the report to


templateDir

public final java.lang.String templateDir
where to load the HTML template pages from


competitionName

public final java.lang.String competitionName
name of the competition this team is a part of

Constructor Detail

CompleteScoringStats

public CompleteScoringStats(java.lang.String compName,
                            TeamScoringInfo teamToScoreInfo,
                            java.lang.String outputPath,
                            java.lang.String templatePath)
                     throws com.thoughtworks.xstream.core.BaseException,
                            java.io.FileNotFoundException,
                            java.io.IOException,
                            LogicException,
                            ParseException
Defines where ScoreEvents are read from and where stats in HTML files are outputted too. The specified templates are used.

Parameters:
compName - the name of the competition
teamToScoreInfo - the team to generate the team report for
outputPath - path to write HTML output to
templatePath - path to read the template files from
Throws:
BaseException - if the object cannot be deserialized
java.io.FileNotFoundException - if the file exists but is a directory rather than a regular file, does not exist but cannot be created, or cannot be opened for any other reason
java.io.IOException - if an output file can be properly created
LogicException - if the scoring language in a file is invalid
ParseException - if the scoring language in a file is invalid
Method Detail

generate

protected void generate()
                 throws java.io.IOException
generates the statistics

Throws:
java.io.IOException

tobr

protected static java.lang.String tobr(java.lang.String s)
replaces any newline characters (\r\n, \n, \r) with


fnum

protected static java.lang.String fnum(long n)
formats numbers to have use commas


checkedToString

protected static java.lang.String checkedToString(java.lang.Object o)
if the object is not null, its toString method is returned; otherwise n/a is returned


generateIndexPage

public static void generateIndexPage(java.lang.String competitionName,
                                     java.lang.String outputPath,
                                     java.lang.String templateDir,
                                     java.lang.String reportGenTime,
                                     java.lang.String reportPeriod,
                                     java.lang.String reportComments,
                                     int minPts,
                                     int initPts,
                                     int maxPts,
                                     int reportTopScore,
                                     int reportAvgScore,
                                     java.util.Vector<java.lang.String> suiteNames,
                                     java.util.Vector<java.util.Vector<java.lang.Integer>> teamSuiteScores,
                                     java.lang.String desc,
                                     java.util.Vector<TeamScoringInfo> teamScores,
                                     boolean useAllInfo)
                              throws java.io.IOException
the index.htm page

Throws:
java.io.IOException

subManualScoreEventInfo

public java.lang.String subManualScoreEventInfo(java.lang.String page,
                                                ManualScoreEvent mse)
substitute in Manual Score Event information


subScoreEventInfo

public java.lang.String subScoreEventInfo(java.lang.String page,
                                          ScoreEvent se)
substitute in Test Score Event information


subScoringRuleInfo

public java.lang.String subScoringRuleInfo(java.lang.String page,
                                           ScoringRule rule)
substitute in Scoring Rule information


subServiceInfo

public java.lang.String subServiceInfo(java.lang.String page,
                                       Service s)
substitute in Service information


subTestInfo

public java.lang.String subTestInfo(java.lang.String page,
                                    Test t)
substitute in Test information


subTestEventInfo

public java.lang.String subTestEventInfo(java.lang.String page,
                                         TestEvent te,
                                         java.lang.Integer resultNum)
substitute in Test Event information


subTestItemInfo

public java.lang.String subTestItemInfo(java.lang.String page,
                                        TestItem ti)
substitute in Test Item information


subTestScoreEventInfo

public java.lang.String subTestScoreEventInfo(java.lang.String page,
                                              TestScoreEvent tse)
substitute in Test Score Event information


subTestSuiteInfo

public java.lang.String subTestSuiteInfo(java.lang.String page,
                                         TestSuite ts)
substitute in Test information