|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.springframework.extensions.webscripts.AbstractWebScript
org.springframework.extensions.webscripts.DeclarativeWebScript
org.alfresco.repo.web.scripts.DeclarativeSpreadsheetWebScript
public abstract class DeclarativeSpreadsheetWebScript
Parent of Declarative Webscripts that generate Excel files, usually based on some sort of dictionary model.
Nested Class Summary | |
---|---|
static class |
DeclarativeSpreadsheetWebScript.WriteExcel
|
Nested classes/interfaces inherited from class org.springframework.extensions.webscripts.AbstractWebScript |
---|
org.springframework.extensions.webscripts.AbstractWebScript.ScriptDetails |
Field Summary | |
---|---|
protected org.alfresco.service.cmr.dictionary.DictionaryService |
dictionaryService
|
protected java.lang.String |
filenameBase
|
static java.lang.String |
MODEL_CSV
|
static java.lang.String |
MODEL_EXCEL
|
Constructor Summary | |
---|---|
DeclarativeSpreadsheetWebScript()
|
Method Summary | |
---|---|
protected abstract boolean |
allowHtmlFallback()
If the format is requested as HTML, should an exception be raised, or should an HTML version be called? |
protected abstract java.util.List |
buildPropertiesForHeader(java.lang.Object resource,
java.lang.String format,
org.springframework.extensions.webscripts.WebScriptRequest req)
Returns the QNames of the model properties to be output in the header, and if they're required or not |
protected java.util.Map |
createTemplateParameters(org.springframework.extensions.webscripts.WebScriptRequest req,
org.springframework.extensions.webscripts.WebScriptResponse res,
java.util.Map customParams)
|
protected java.util.Map |
executeImpl(org.springframework.extensions.webscripts.WebScriptRequest req,
org.springframework.extensions.webscripts.Status status)
|
void |
generateSpreadsheet(java.lang.Object resource,
java.lang.String format,
org.springframework.extensions.webscripts.WebScriptRequest req,
org.springframework.extensions.webscripts.Status status,
java.util.Map model)
Generates the spreadsheet, based on the properties in the header and a callback for the body. |
protected abstract java.lang.Object |
identifyResource(java.lang.String format,
org.springframework.extensions.webscripts.WebScriptRequest req)
Identifies the resource for the webscript. |
protected abstract void |
populateBody(java.lang.Object resource,
org.apache.commons.csv.CSVPrinter csv,
java.util.List properties)
Populates the body of the CSV file, once the header has been output. |
protected abstract void |
populateBody(java.lang.Object resource,
org.apache.poi.ss.usermodel.Workbook workbook,
org.apache.poi.ss.usermodel.Sheet sheet,
java.util.List properties)
Populates the body of the Excel Workbook, once the header has been output. |
void |
setDictionaryService(org.alfresco.service.cmr.dictionary.DictionaryService dictionaryService)
|
Methods inherited from class org.springframework.extensions.webscripts.DeclarativeWebScript |
---|
execute, executeFinallyImpl, executeImpl, executeImpl, getTemplateModel, renderFormatTemplate |
Methods inherited from class org.springframework.extensions.webscripts.AbstractWebScript |
---|
createArgs, createArgsM, createHeaders, createHeadersM, createScriptParameters, createStatusException, executeScript, getContainer, getDescription, getExecuteScript, getResources, getStatusTemplate, init, renderString, renderString, renderTemplate, sendStatus, setURLModelFactory, toString |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String MODEL_CSV
public static final java.lang.String MODEL_EXCEL
protected org.alfresco.service.cmr.dictionary.DictionaryService dictionaryService
protected java.lang.String filenameBase
Constructor Detail |
---|
public DeclarativeSpreadsheetWebScript()
Method Detail |
---|
public void setDictionaryService(org.alfresco.service.cmr.dictionary.DictionaryService dictionaryService)
dictionaryService
- the DictionaryService to setprotected abstract java.lang.Object identifyResource(java.lang.String format, org.springframework.extensions.webscripts.WebScriptRequest req)
protected abstract boolean allowHtmlFallback()
protected abstract java.util.List buildPropertiesForHeader(java.lang.Object resource, java.lang.String format, org.springframework.extensions.webscripts.WebScriptRequest req)
protected abstract void populateBody(java.lang.Object resource, org.apache.poi.ss.usermodel.Workbook workbook, org.apache.poi.ss.usermodel.Sheet sheet, java.util.List properties) throws java.io.IOException
java.io.IOException
protected abstract void populateBody(java.lang.Object resource, org.apache.commons.csv.CSVPrinter csv, java.util.List properties) throws java.io.IOException
java.io.IOException
protected java.util.Map executeImpl(org.springframework.extensions.webscripts.WebScriptRequest req, org.springframework.extensions.webscripts.Status status)
executeImpl
in class org.springframework.extensions.webscripts.DeclarativeWebScript
org.alfresco.web.scripts.DeclarativeWebScript#executeImpl(org.alfresco.web.scripts.WebScriptRequest, org.alfresco.web.scripts.Status)
public void generateSpreadsheet(java.lang.Object resource, java.lang.String format, org.springframework.extensions.webscripts.WebScriptRequest req, org.springframework.extensions.webscripts.Status status, java.util.Map model) throws java.io.IOException
java.io.IOException
protected java.util.Map createTemplateParameters(org.springframework.extensions.webscripts.WebScriptRequest req, org.springframework.extensions.webscripts.WebScriptResponse res, java.util.Map customParams)
createTemplateParameters
in class org.springframework.extensions.webscripts.AbstractWebScript
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |