com.tsgrp.opencontent.core.excel

Class ExcelUtil

java.lang.Object

com.tsgrp.opencontent.core.excel.ExcelUtil

public class ExcelUtil
extends java.lang.Object

Utility class for building a .xls via the Workbook class

Field Summary

Fields

Modifier and Type	Field and Description
static double	MIN_ROW_HEIGHT_IN_TWIPS The minimum row height in twips (a twip is 1/20th of a point and we want 13.8 points).
static java.lang.String	PROP_ATTR_NO_TYPE
static java.lang.String	PROP_ATTR_NOT_IN_FORM
static java.lang.String	PROP_ATTR_VAL_NOT_IN_PICKLIST
static java.lang.String	PROP_ATTR_WITH_ERROR
static java.lang.String	PROP_HAS_ERROR
static java.lang.String	PROP_REQUIRED_ATTR_ABSENT
static java.lang.String	PROP_REQUIRED_ATTR_SINGLE_ABSENT

Method Summary

Modifier and Type	Method and Description
static org.apache.poi.ss.usermodel.Workbook	buildWorkBook(java.lang.String title, java.lang.String subtitle, java.util.List<WorkbookSection> sections, int[] columnWidths) Builds an Excel workbook that is separated into different sections, each of which can display different fields.
static void	createAdminDeleteCSV(java.io.OutputStream stream, java.util.List<java.lang.String> successList, java.util.List<java.lang.String> failList) Creates a CSV file that tracks all deletions, whether successful or unsuccessful They are in two columns in the csv
static void	generateCSV(java.io.OutputStream stream, java.lang.String[] header, OCQuery query)
static java.lang.String	getCellValueAsSimpleString(org.apache.poi.hssf.usermodel.HSSFCell cell) Regardless of the underlying type of the cell, get its simple text representation.
static java.util.List<java.util.Map<java.lang.String,java.lang.Object>>	getSheetAsPropMaps(org.apache.poi.ss.usermodel.Sheet sheet, OCTypeDefinition typeDef, Action action, java.lang.String ticket) Converts each row into a Map using the first row as the Map's keys and each row's cells as the values.
static java.lang.String	hasDependency(java.util.HashMap<java.lang.String,java.lang.String> dependsOnMap, java.lang.String ocName, java.util.ArrayList<java.lang.String> headerList)
static void	setUpAdminDeleteCSV(java.io.OutputStream stream) Creates the headers for the csv file that will be generated

Methods inherited from class java.lang.Object

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

Field Detail

PROP_HAS_ERROR

public static final java.lang.String PROP_HAS_ERROR

See Also:

Constant Field Values

PROP_ATTR_WITH_ERROR

public static final java.lang.String PROP_ATTR_WITH_ERROR

See Also:

Constant Field Values

PROP_ATTR_VAL_NOT_IN_PICKLIST

public static final java.lang.String PROP_ATTR_VAL_NOT_IN_PICKLIST

See Also:

Constant Field Values

PROP_ATTR_NO_TYPE

public static final java.lang.String PROP_ATTR_NO_TYPE

See Also:

Constant Field Values

PROP_ATTR_NOT_IN_FORM

public static final java.lang.String PROP_ATTR_NOT_IN_FORM

See Also:

Constant Field Values

PROP_REQUIRED_ATTR_ABSENT

public static final java.lang.String PROP_REQUIRED_ATTR_ABSENT

See Also:

Constant Field Values

PROP_REQUIRED_ATTR_SINGLE_ABSENT

public static final java.lang.String PROP_REQUIRED_ATTR_SINGLE_ABSENT

See Also:

Constant Field Values

MIN_ROW_HEIGHT_IN_TWIPS

public static final double MIN_ROW_HEIGHT_IN_TWIPS

The minimum row height in twips (a twip is 1/20th of a point and we want 13.8 points).

See Also:

Constant Field Values

Method Detail

buildWorkBook

public static org.apache.poi.ss.usermodel.Workbook buildWorkBook(java.lang.String title,
                                                                 java.lang.String subtitle,
                                                                 java.util.List<WorkbookSection> sections,
                                                                 int[] columnWidths)

Builds an Excel workbook that is separated into different sections, each of which can display different fields.

Parameters:

title - The title to be displayed in bold at the top of the spreadsheet.

subtitle - The displayed header under the main title. This parameter is optional.

sections - A WorkbookSection object containing the data needed to build up each section.

columnWidths - The widths each column should be set to. This parameter is optional.

Returns:

A single-sheet Excel workbook with the data for each section.

hasDependency

public static java.lang.String hasDependency(java.util.HashMap<java.lang.String,java.lang.String> dependsOnMap,
                                             java.lang.String ocName,
                                             java.util.ArrayList<java.lang.String> headerList)

getSheetAsPropMaps

public static java.util.List<java.util.Map<java.lang.String,java.lang.Object>> getSheetAsPropMaps(org.apache.poi.ss.usermodel.Sheet sheet,
                                                                                                  OCTypeDefinition typeDef,
                                                                                                  Action action,
                                                                                                  java.lang.String ticket)

Converts each row into a Map using the first row as the Map's keys and each row's cells as the values. Uses the Type Definition to figure out what the attributes' types are in order to get/set the value to the right type

Parameters:

sheet -

typeDef -

Returns:

A list of property maps

createAdminDeleteCSV

public static void createAdminDeleteCSV(java.io.OutputStream stream,
                                        java.util.List<java.lang.String> successList,
                                        java.util.List<java.lang.String> failList)

Creates a CSV file that tracks all deletions, whether successful or unsuccessful They are in two columns in the csv

Parameters:

stream - the output stream that we write to

successList - the list of successfully deleted nodes

failList - the list of nodes that were failed to be deleted

setUpAdminDeleteCSV

public static void setUpAdminDeleteCSV(java.io.OutputStream stream)

Creates the headers for the csv file that will be generated

Parameters:

stream - the output stream that we write to

generateCSV

public static void generateCSV(java.io.OutputStream stream,
                               java.lang.String[] header,
                               OCQuery query)

getCellValueAsSimpleString

public static java.lang.String getCellValueAsSimpleString(org.apache.poi.hssf.usermodel.HSSFCell cell)

Regardless of the underlying type of the cell, get its simple text representation. Dates will come back as the floating-point number. Null cell returns null; blank cell returns "".

Parameters:

cell -

Returns:

Cell's value as a simple string