|
ContactCenters V. 0.9.9. |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectumontreal.iro.lecuyer.contactcenters.app.PerformanceMeasureFormat
public abstract class PerformanceMeasureFormat
Provides basic methods for formatting matrices of performance measures.
Field Summary | |
---|---|
protected String[] |
agentGroupProperties
|
protected String[] |
contactTypeProperties
|
protected List<HistogramChart> |
histogramList
|
Constructor Summary | |
---|---|
PerformanceMeasureFormat()
|
|
PerformanceMeasureFormat(ReportParams reportParams)
|
Method Summary | |
---|---|
static void |
addExperimentInfo(Map<String,Object> evalInfo,
String ccParamsFn,
String simParamsFn)
Returns the header for simulation results. |
String |
capitalizeFirstLetter(String s)
Returns the string s with the first letter in uppercase. |
String |
columnNameWithProperties(ContactCenterInfo eval,
PerformanceMeasureType pm,
int col)
|
int |
countRowsSummary(ContactCenterEval eval,
PerformanceMeasureType... pms)
Returns the number of rows in the summary report. |
protected void |
createHistogram(double[] obs,
double sigma,
PerformanceMeasureParams pmp,
String name)
Create a new histogram and add it to the list of histograms. |
static void |
formatResults(ContactCenterEval eval,
File outputFile)
Formats the results of the last evaluation performed by eval into the file with name outputFile. |
static void |
formatResults(ContactCenterEval eval,
OutputStream stream,
CCResultsFormat fmt)
Formats the results of the evaluation system eval. |
static void |
formatResults(ContactCenterEval eval,
String outputFileName)
Equivalent to formatResults(ContactCenterEval,File) ,
with a string given the file name instead of
a file object. |
PrintedStatParams[] |
getDefaultPrintedStatParams(ContactCenterEval eval,
ReportParams reportParams)
Returns a default array of parameters for printed statistics, for the evaluation system eval. |
List<HistogramChart> |
getHistogramList()
Returns the list of histograms created by the call to formatObservations in derived classes. |
String |
getName(ContactCenterInfo eval,
PerformanceMeasureType pm,
int row,
int col)
Returns the name associated with the performance measure of type pm, at row row, and column col. |
String |
getNameWithProperties(ContactCenterInfo eval,
PerformanceMeasureType pm,
int row,
int col)
|
int |
getNumPropColumns(PerformanceMeasureType pm)
|
int |
getNumPropRows(PerformanceMeasureType pm,
boolean singleRow)
|
PerformanceMeasureType[] |
getPerformanceMeasures(PrintedStatParams[] pstats)
Constructs an array of performance measure types from the given array of printed statistics. |
PerformanceMeasureType[] |
getPerformanceMeasures(PrintedStatParams[] pstats,
boolean onlyAverages,
RowType... rowTypes)
Constructs an array of performance measure types from the given array of printed statistics, and a row type. |
PerformanceMeasureType[] |
getPerformanceMeasures(PrintedStatParams[] pstats,
RowType... rowTypes)
Constructs an array of performance measure types from the given array of printed statistics, and a row type. |
String[] |
getPropColumns(ContactCenterInfo eval,
PerformanceMeasureType pm,
int column)
|
String[] |
getPropNameColumns(PerformanceMeasureType pm)
|
String[] |
getPropNameRows(PerformanceMeasureType pm,
boolean singleRow)
|
String[] |
getPropRows(ContactCenterInfo eval,
PerformanceMeasureType pm,
int row)
|
String[] |
getPropRows(ContactCenterInfo eval,
PerformanceMeasureType pm,
int row,
int column)
|
static String[] |
getShownProperties(Collection<PropertyNameParam> properties)
Converts a list of property names to an array of strings. |
protected double |
getStandardDeviation(ContactCenterSimWithObservations sim,
PerformanceMeasureType pm,
int row,
int column)
Return the standard deviation of this performance measure. |
String[] |
getStatColumnNames()
Name of the columns for tables containing statistics concerning performance measures. |
String[] |
getValColumnNames()
Name of the columns for tables containing values of performance measures. |
boolean |
isIncludedInDefaultReport(PerformanceMeasureType pm)
Determines if the performance measure type pm is included in reports when printed statistics are not specified by the user. |
boolean |
isIncludedInReport(ContactCenterEval eval,
PerformanceMeasureType pm)
Determines if the performance measure type pm is included in reports. |
boolean |
isIncludedInSummary(ContactCenterEval eval,
PerformanceMeasureType pm)
Determines if the performance measure type pm is included in the summary of reports. |
String |
rowNameWithProperties(ContactCenterInfo eval,
PerformanceMeasureType pm,
int row)
|
void |
writeHistograms()
Show all histograms for the chosen measures on standard output. |
void |
writeHistogramsLaTeX()
Writes all histograms for the chosen measures in a LaTex file. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected String[] contactTypeProperties
protected String[] agentGroupProperties
protected List<HistogramChart> histogramList
Constructor Detail |
---|
public PerformanceMeasureFormat()
public PerformanceMeasureFormat(ReportParams reportParams)
Method Detail |
---|
protected double getStandardDeviation(ContactCenterSimWithObservations sim, PerformanceMeasureType pm, int row, int column)
sim
- contact centerpm
- performance measurerow
- column
-
protected void createHistogram(double[] obs, double sigma, PerformanceMeasureParams pmp, String name)
obs
- the observationssigma
- empirical standard deviation of the observationspmp
- performance measure parametersname
- performance measure namepublic List<HistogramChart> getHistogramList()
public void writeHistograms()
public void writeHistogramsLaTeX()
public static String[] getShownProperties(Collection<PropertyNameParam> properties)
properties
- the list of property names.
public int getNumPropRows(PerformanceMeasureType pm, boolean singleRow)
public int getNumPropColumns(PerformanceMeasureType pm)
public String[] getPropNameRows(PerformanceMeasureType pm, boolean singleRow)
public String[] getPropNameColumns(PerformanceMeasureType pm)
public String[] getPropRows(ContactCenterInfo eval, PerformanceMeasureType pm, int row, int column)
public String[] getPropRows(ContactCenterInfo eval, PerformanceMeasureType pm, int row)
public String[] getPropColumns(ContactCenterInfo eval, PerformanceMeasureType pm, int column)
public int countRowsSummary(ContactCenterEval eval, PerformanceMeasureType... pms)
isIncludedInSummary(ContactCenterEval,PerformanceMeasureType)
returns true.
pms
- the array of performance measure types.
public boolean isIncludedInReport(ContactCenterEval eval, PerformanceMeasureType pm)
PerformanceMeasureType.SUMWAITINGTIMES
, or if
pm.getEstimationType()
returns
EstimationType.EXPECTATIONOFFUNCTION
.
pm
- the tested type of performance measure.
public boolean isIncludedInDefaultReport(PerformanceMeasureType pm)
PerformanceMeasureType.SUMWAITINGTIMES
, or if
pm.getEstimationType()
returns
EstimationType.EXPECTATIONOFFUNCTION
.
pm
- the tested type of performance measure.
public boolean isIncludedInSummary(ContactCenterEval eval, PerformanceMeasureType pm)
By default, this method returns true if
isIncludedInReport (eval, pm)
returns true, and if
pm does not correspond to
PerformanceMeasureType.SERVEDRATES
.
pm
- the tested type of performance measure.
public String rowNameWithProperties(ContactCenterInfo eval, PerformanceMeasureType pm, int row)
public String columnNameWithProperties(ContactCenterInfo eval, PerformanceMeasureType pm, int col)
public String getName(ContactCenterInfo eval, PerformanceMeasureType pm, int row, int col)
PerformanceMeasureType.rowName(umontreal.iro.lecuyer.contactcenters.app.ContactCenterInfo, int)
, and
PerformanceMeasureType.columnName(umontreal.iro.lecuyer.contactcenters.app.ContactCenterInfo, int)
.
eval
- the evaluation system.pm
- the performance measure type.row
- the row index.col
- the column index.
public String getNameWithProperties(ContactCenterInfo eval, PerformanceMeasureType pm, int row, int col)
public String capitalizeFirstLetter(String s)
s
- the string to capitalized.
public String[] getValColumnNames()
public String[] getStatColumnNames()
public PrintedStatParams[] getDefaultPrintedStatParams(ContactCenterEval eval, ReportParams reportParams)
ContactCenterEval.getPerformanceMeasures()
to obtain an array of
performance measures. For each element of this array, it creates a
PrintedStatParams
instance, and adds it into the returned list.
Parameters for printed statistics are set to default, i.e., detailed
statistics for all periods are printed.
eval
- the evaluation system.
public PerformanceMeasureType[] getPerformanceMeasures(PrintedStatParams[] pstats)
pstats
- the array of printed statistics.
public PerformanceMeasureType[] getPerformanceMeasures(PrintedStatParams[] pstats, RowType... rowTypes)
getPerformanceMeasures(PrintedStatParams[])
except it returns measure types with
a row type corresponding to rowType.
pstats
- the array of printed statistics.rowTypes
- the row types.
public PerformanceMeasureType[] getPerformanceMeasures(PrintedStatParams[] pstats, boolean onlyAverages, RowType... rowTypes)
getPerformanceMeasures(PrintedStatParams[])
except it returns measure types with
a row type corresponding to rowType, and
for which p.getOnlyAverages corresponds
to onlyAverages.
pstats
- the array of printed statistics.onlyAverages
- determines the required status of the onlyAverages flag.rowTypes
- the row types.
public static void addExperimentInfo(Map<String,Object> evalInfo, String ccParamsFn, String simParamsFn)
ccParamsFn
- the name of the parameter file for the model.simParamsFn
- the name of the parameter file for the experiment.public static void formatResults(ContactCenterEval eval, String outputFileName) throws IOException, JAXBException
formatResults(ContactCenterEval,File)
,
with a string given the file name instead of
a file object.
IOException
JAXBException
public static void formatResults(ContactCenterEval eval, File outputFile) throws IOException, JAXBException
eval
- the evaluation system.outputFile
- the output file
IOException
- if an I/O error occurs.
ParserConfigurationException
- if the output format is XML, and an error occurred while
constructing the intermediate DOM document.
TransformerException
- if the output format is XML, and an error occurs during the
transformation of the DOM document into text.
JAXBException
public static void formatResults(ContactCenterEval eval, OutputStream stream, CCResultsFormat fmt) throws IOException, JAXBException
formatStatistics
. Otherwise, it saves the results in stream.
Depending on the value of fmt, i.e., TEXT,
BINARY, XML, or EXCEL, the format of the output
file is plain text, binary, XML, or MS Excel, respectively.
eval
- the evaluation system being processed.stream
- the output stream.fmt
- the format of the output.
IOException
- if an I/O error occurs.
ParserConfigurationException
- if the output format is XML, and an error occurred while
constructing the intermediate DOM document.
TransformerException
- if the output format is XML, and an error occurs during the
transformation of the DOM document into text.
JAXBException
|
ContactCenters V. 0.9.9. |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |