org.alfresco.bm.manager.report

Interface DataReportService

All Known Implementing Classes:

DataReportServiceImpl

public interface DataReportService

extra data report service Allows one or more extra data sheets for Excel results export.

Since:

2.0.10

Author:

Frank Becker

Method Summary

Modifier and Type	Method and Description
void	appendData(String driverId, String test, String run, String sheetName, String[] fieldNames, String[] values) Appends extra data for a test.run to a named sheet.
com.mongodb.DBCursor	getData(String driverId, String test, String run, String sheetName) Returns a DB cursor for a test.run extra data sheet
List<String>	getDescription(String driverId, String test, String run, String sheetName) Gets the column headers / description for a test.run data sheet
List<String>	getNextValueRow(com.mongodb.DBCursor cursor) Returns the next row with values or null if no more values.
String[]	getSheetNames(String driverId, String test, String run) Gets the extra data sheet names for a specific test.run
boolean	isValueField(String fieldName) checks if the field name is a user defined value field or a value field
void	remove(String driverId, String test, String testRun) Removes all data from the tables affecting to driver (if provided), test and test run (if provided).
void	setDescription(String driverId, String test, String run, String sheetName, String[] fieldNames, String[] description) Updates the column names for the extra data for a test.run named sheet.

Method Detail

appendData

void appendData(String driverId,
                String test,
                String run,
                String sheetName,
                String[] fieldNames,
                String[] values)

Appends extra data for a test.run to a named sheet.

Parameters:

driverId - (String, required) test driver ID

test - (String, required) name of the test

run - (String, required) name of the test run

sheetName - (String, required) name of the extra data sheet

fieldNames - (String [], required) field names of the values to write

values - (String [], required) data to write to the extra data sheet Note: fieldNames and values must have the same array size.

remove

void remove(String driverId,
            String test,
            String testRun)

Removes all data from the tables affecting to driver (if provided), test and test run (if provided).

Parameters:

driverId - (String, optional) Driver ID

test - (String, required) test name

testRun - (String, optional) test run name

setDescription

void setDescription(String driverId,
                    String test,
                    String run,
                    String sheetName,
                    String[] fieldNames,
                    String[] description)

Updates the column names for the extra data for a test.run named sheet.

Parameters:

driverId - (String, required) test driver ID

test - (String, required) name of the test

run - (String, required) name of the test run

sheetName - (String, required) name of the extra data sheet

fieldNames - (String [], required) field names of the values to write

description - (String [], required) data to write to the extra data sheet Note: fieldNames and values must have the same array size.

getDescription

List<String> getDescription(String driverId,
                            String test,
                            String run,
                            String sheetName)

Gets the column headers / description for a test.run data sheet

Parameters:

driverId - (String, optional) test driver ID

test - (String, required) name of the test

run - (String, required) name of the test run

sheetName - (String, required) name of the extra data sheet

Returns:

(String []) - may be null if no description was set

getSheetNames

String[] getSheetNames(String driverId,
                       String test,
                       String run)

Gets the extra data sheet names for a specific test.run

Parameters:

driverId - (String, optional) test driver ID

test - (String, required) name of the test

run - (String, required) name of the test run

Returns:

(String []) - may be null if no extra data was stored for the test.run

getData

com.mongodb.DBCursor getData(String driverId,
                             String test,
                             String run,
                             String sheetName)

Returns a DB cursor for a test.run extra data sheet

Parameters:

driverId - (String, optional) test driver ID

test - (String, required) name of the test

run - (String, required) name of the test run

sheetName - (String, required) name of the extra data sheet

Returns:

(DBCursor) - filter rows for value fields with isValueField

isValueField

boolean isValueField(String fieldName)

checks if the field name is a user defined value field or a value field

Parameters:

fieldName - (String, required) field name to validate

Returns:

true if not one of the predefined fixed field names, false else

getNextValueRow

List<String> getNextValueRow(com.mongodb.DBCursor cursor)

Returns the next row with values or null if no more values.

Parameters:

cursor - (DBCursor) cursor

Returns:

(String []) or null