org.alfresco.bm.manager.report

Class DataReportServiceImpl

java.lang.Object

org.alfresco.bm.manager.report.DataReportServiceImpl

All Implemented Interfaces:

LifecycleListener, DataReportService

public class DataReportServiceImpl
extends Object
implements LifecycleListener, DataReportService

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

Since:

2.0.10

Author:

Frank Becker

Field Summary

Fields

Modifier and Type	Field and Description
static String	COLLECTION_EXTRA_DATA Stores the collection name
static String	COLLECTION_EXTRA_DATA_DESCRIPTION
static String	FIELD_DRIVER_ID
static String	FIELD_ID static field names
static String	FIELD_SHEET_NAME
static String	FIELD_TEST
static String	FIELD_TEST_RUN
static String	FIELD_TIME

Constructor Summary

Constructors

Constructor and Description
DataReportServiceImpl(com.mongodb.DB db) Constructor

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 testRun, String sheetName) Returns a DB cursor for a test.run extra data sheet
List<String>	getDescription(String driverId, String test, String testRun, 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 testRun) 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.
void	start()
void	stop()

Methods inherited from class java.lang.Object

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

Field Detail

COLLECTION_EXTRA_DATA

public static final String COLLECTION_EXTRA_DATA

Stores the collection name

See Also:

Constant Field Values

COLLECTION_EXTRA_DATA_DESCRIPTION

public static final String COLLECTION_EXTRA_DATA_DESCRIPTION

See Also:

Constant Field Values

FIELD_ID

public static final String FIELD_ID

static field names

See Also:

Constant Field Values

FIELD_TIME

public static final String FIELD_TIME

See Also:

Constant Field Values

FIELD_DRIVER_ID

public static final String FIELD_DRIVER_ID

See Also:

Constant Field Values

FIELD_TEST

public static final String FIELD_TEST

See Also:

Constant Field Values

FIELD_TEST_RUN

public static final String FIELD_TEST_RUN

See Also:

Constant Field Values

FIELD_SHEET_NAME

public static final String FIELD_SHEET_NAME

See Also:

Constant Field Values

Constructor Detail

DataReportServiceImpl

public DataReportServiceImpl(com.mongodb.DB db)

Constructor

Parameters:

db - (DB, required) the database to use

Method Detail

appendData

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

Description copied from interface: DataReportService

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

Specified by:

appendData in interface DataReportService

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.

setDescription

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

Description copied from interface: DataReportService

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

Specified by:

setDescription in interface DataReportService

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

public List<String> getDescription(String driverId,
                                   String test,
                                   String testRun,
                                   String sheetName)

Description copied from interface: DataReportService

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

Specified by:

getDescription in interface DataReportService

Parameters:

driverId - (String, optional) test driver ID

test - (String, required) name of the test

testRun - (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

isValueField

public boolean isValueField(String fieldName)

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

Specified by:

isValueField in interface DataReportService

Parameters:

fieldName - (String, required) field name to validate

Returns:

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

getSheetNames

public String[] getSheetNames(String driverId,
                              String test,
                              String testRun)

Description copied from interface: DataReportService

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

Specified by:

getSheetNames in interface DataReportService

Parameters:

driverId - (String, optional) test driver ID

test - (String, required) name of the test

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

Returns:

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

getData

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

Description copied from interface: DataReportService

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

Specified by:

getData in interface DataReportService

Parameters:

driverId - (String, optional) test driver ID

test - (String, required) name of the test

testRun - (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

start

public void start()

Specified by:

start in interface LifecycleListener

stop

public void stop()

Specified by:

stop in interface LifecycleListener

getNextValueRow

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

Description copied from interface: DataReportService

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

Specified by:

getNextValueRow in interface DataReportService

Parameters:

cursor - (DBCursor) cursor

Returns:

(String []) or null

remove

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

Description copied from interface: DataReportService

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

Specified by:

remove in interface DataReportService

Parameters:

driverId - (String, optional) Driver ID

test - (String, required) test name

testRun - (String, optional) test run name