Style Intelligence v12.0

inetsoft.report
Class ParameterSheet

java.lang.Object
  extended by inetsoft.uql.asset.AbstractAssetEngine
      extended by inetsoft.report.internal.StyleCore
          extended by inetsoft.report.ReportSheet
              extended by inetsoft.report.TabularSheet
                  extended by inetsoft.report.ParameterSheet
All Implemented Interfaces:
inetsoft.report.internal.ParameterSheetRepository, StyleConstants, AssetRepository, XConstants, XFormulaRepository, XLocalQueryRepository, XQueryRepository, Serializable, Cloneable

public class ParameterSheet
extends TabularSheet

A ParameterSheet contains the definition for a report parameter page. It can be used for prompting report parameter values.

See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class inetsoft.report.internal.StyleCore
inetsoft.report.internal.StyleCore.ActionScriptable
 
Nested classes/interfaces inherited from class inetsoft.uql.asset.AbstractAssetEngine
AbstractAssetEngine.ReportSheetDependencyFinder, AbstractAssetEngine.SheetTransformListener, AbstractAssetEngine.StorageChangeListener
 
Field Summary
static String PARAMETER_SHEET
          Parameter sheet name.
static String STAGE_FLOW_LEVEL
          Stage flow & level name.
static String STAGE_LEVEL
          Stage level name.
 
Fields inherited from class inetsoft.report.ReportSheet
BODY, DEFAULT_FOOTER, DEFAULT_HEADER, DOWN, EVEN_PAGE_FOOTER, EVEN_PAGE_HEADER, FIRST_PAGE_FOOTER, FIRST_PAGE_HEADER, ODD_PAGE_FOOTER, ODD_PAGE_HEADER, PAINTER_BREAKABLE, PAINTER_NON_BREAK, TABLE_EQUAL_WIDTH, TABLE_FIT_CONTENT, TABLE_FIT_CONTENT_1PP, TABLE_FIT_CONTENT_PAGE, TABLE_FIT_PAGE, UP, WRAP_BOTH, WRAP_LEFT, WRAP_NONE, WRAP_RIGHT, WRAP_TOP_BOTTOM
 
Fields inherited from class inetsoft.report.internal.StyleCore
advanceLine, alignment, anchor, autosize, background, bg, bgimage, bglayout, bgsize, burstInfo, chartinfo, cmargin, COMPLETED, contexts, current, currFooter, currFrame, currHeader, DESIGN_MODE, elemFooter, elemHeader, evenFooter, evenHeader, firstFooter, firstHeader, font, footerElements, footerFromEdge, foreground, formatmap, frames, g_pmargin, header, headerElements, headerFromEdge, headingCnt, headingMap, hfFmt, hindent, horFlow, idmap, indent, initCalled, initCmd, initScript, justify, lastHead, lineH, LIVE_MODE, loadCmd, loadScript, locale, margin, MORE_ELEM, MORE_FLOW, nextOrient, npframes, nplayout, numHeadingMap, oddFooter, oddHeader, orphan, overrideFooter, overrideFooterContinue, overrideHeader, overrideHeaderContinue, padding, pageBox, pagebreakCmd, pagebreakScript, painterLayout, painterMargin, parameters, parentElem, pglayout, pgStart, pgTotal, pmargin, presentermap, printBox, printCmd, printHead, printMode, printScript, prop, psheet, queries, reportmode, rewinded, RUN_MODE, runningScript, runningTotals, scriptenv, secHeadingMap, secNumHeadingMap, sepadv, spacing, tableadv, tableorphan, tableW, tabStops, textadv, wrapping
 
Fields inherited from class inetsoft.uql.asset.AbstractAssetEngine
admin, catalog, editing, istore, LOCAL, parent, scopes
 
Fields inherited from interface inetsoft.uql.XQueryRepository
GLOBAL_SCOPE, LOCAL_QUERY, LOCAL_SCOPE, NORMAL_QUERY
 
Fields inherited from interface inetsoft.report.StyleConstants
ARROW_LINE_1, ARROW_LINE_2, ARROW_LINE_3, BACKGROUND_CENTER, BACKGROUND_TILED, BOX_RECTANGLE, BOX_ROUNDED_RECTANGLE, CENTER, CHART_3D_BAR, CHART_3D_BAR_3D, CHART_3D_PIE, CHART_3D_STACK_BAR, CHART_AREA, CHART_BAR, CHART_BUBBLE, CHART_CANDLE, CHART_CURVE, CHART_FILL_RADAR, CHART_GANTT, CHART_INV_BAR, CHART_INV_CURVE, CHART_INV_LINE, CHART_INV_POINT, CHART_INV_STACK_BAR, CHART_LINE, CHART_MAX_USER, CHART_PARETO, CHART_PIE, CHART_PIE_EXPLODED_ALL, CHART_PIE_EXPLODED_FIRST, CHART_PIE_EXPLODED_NONE, CHART_POINT, CHART_RADAR, CHART_RIBBON, CHART_SCATTER, CHART_SPEEDOMETER, CHART_STACK_AREA, CHART_STACK_BAR, CHART_STICK, CHART_STOCK, CHART_SURFACE, CHART_USER, CHART_VOLUME, CHART_WATERFALL, CHART_XY_LINE, CIRCLE, CROSS, CURRENCY, DASH_LINE, DASH_MASK, DEFAULT_PAGE_SIZE, DIAMOND, DOT_LINE, DOUBLE_3D_LOWERED, DOUBLE_3D_RAISED, DOUBLE_LINE, DOUBLE_MASK, FILL, FILLED_CIRCLE, FILLED_DIAMOND, FILLED_SQUARE, FILLED_TRIANGLE, FRACTION_WIDTH_MASK, H_ALIGN_MASK, H_CENTER, H_CURRENCY, H_LEFT, H_LINE, H_RIGHT, LANDSCAPE, LARGE_DASH, LEFT, LINECAP_BUTT, LINECAP_ROUND, LINECAP_SQUARE, LINEJOIN_BEVEL, LINEJOIN_MITER, LINEJOIN_ROUND, LOWERED_3D, LOWERED_MASK, LT_ANGLE, MEDIUM_DASH, MEDIUM_LINE, NIL, NO_BORDER, NONE, PAPER_10X11, PAPER_10X14, PAPER_11X17, PAPER_15X11, PAPER_9X11, PAPER_A_PLUS, PAPER_A2, PAPER_A3, PAPER_A3_EXTRA, PAPER_A3_EXTRA_TRANSVERSE, PAPER_A3_TRANSVERSE, PAPER_A4, PAPER_A4_EXTRA, PAPER_A4_PLUS, PAPER_A4_TRANSVERSE, PAPER_A4SMALL, PAPER_A5, PAPER_A5_EXTRA, PAPER_A5_TRANSVERSE, PAPER_B_PLUS, PAPER_B4, PAPER_B5, PAPER_B5_EXTRA, PAPER_B5_TRANSVERSE, PAPER_CSHEET, PAPER_DSHEET, PAPER_ENV_10, PAPER_ENV_11, PAPER_ENV_12, PAPER_ENV_14, PAPER_ENV_9, PAPER_ENV_B4, PAPER_ENV_B5, PAPER_ENV_B6, PAPER_ENV_C3, PAPER_ENV_C4, PAPER_ENV_C5, PAPER_ENV_C6, PAPER_ENV_C65, PAPER_ENV_DL, PAPER_ENV_INVITE, PAPER_ENV_ITALY, PAPER_ENV_MONARCH, PAPER_ENV_PERSONAL, PAPER_ESHEET, PAPER_EXECUTIVE, PAPER_FANFOLD_LGL_GERMAN, PAPER_FANFOLD_STD_GERMAN, PAPER_FANFOLD_US, PAPER_FOLIO, PAPER_ISO_B4, PAPER_JAPANESE_POSTCARD, PAPER_LEDGER, PAPER_LEGAL, PAPER_LEGAL_EXTRA, PAPER_LETTER, PAPER_LETTER_EXTRA, PAPER_LETTER_EXTRA_TRANSVERSE, PAPER_LETTER_PLUS, PAPER_LETTER_TRANSVERSE, PAPER_LETTERSMALL, PAPER_NOTE, PAPER_QUARTO, PAPER_STATEMENT, PAPER_TABLOID, PAPER_TABLOID_EXTRA, PATTERN_0, PATTERN_1, PATTERN_10, PATTERN_11, PATTERN_12, PATTERN_13, PATTERN_14, PATTERN_15, PATTERN_16, PATTERN_17, PATTERN_18, PATTERN_19, PATTERN_2, PATTERN_3, PATTERN_4, PATTERN_5, PATTERN_6, PATTERN_7, PATTERN_8, PATTERN_9, PATTERN_NONE, PORTRAIT, RAISED_3D, RAISED_MASK, REMAINDER, RIGHT, RIGHT_ANGLE, SOLID_MASK, SQUARE, STAR, THICK_LINE, THIN_LINE, THIN_THIN_LINE, TRAY_AUTO, TRAY_CASSETTE, TRAY_ENVELOPE, TRAY_ENVMANUAL, TRAY_FORMSOURCE, TRAY_LARGECAPACITY, TRAY_LARGEFMT, TRAY_LOWER, TRAY_MANUAL, TRAY_MIDDLE, TRAY_ONLYONE, TRAY_SMALLFMT, TRAY_TRACTOR, TRAY_UPPER, TRIANGLE, ULTRA_THIN_LINE, V_ALIGN_MASK, V_ANGLE, V_BASELINE, V_BOTTOM, V_CENTER, V_LINE, V_TOP, WIDTH_MASK, X
 
Fields inherited from interface inetsoft.uql.XConstants
AM_PM_DATE_GROUP, AM_PM_OF_DAY_DATE_GROUP, AVERAGE_FORMULA, CALC_FORMULA, COLUMN, CONCAT_FORMULA, CONDITION_EMPTY_STRING, CONDITION_NULL_STRING, CONDITION_NULL_VALUE, CONDITION_REAL_NULL, CORRELATION_FORMULA, COUNT_FORMULA, COVARIANCE_FORMULA, CURRENCY_FORMAT, CURRENT_REP_CHANGED, CURRENT_REP_WILL_CHANGE, DATE_FORMAT, DAY_DATE_GROUP, DAY_OF_MONTH_DATE_GROUP, DAY_OF_WEEK_DATE_GROUP, DAY_OF_YEAR_DATE_GROUP, DECIMAL_FORMAT, DISTINCTCOUNT_FORMULA, FIRST_FORMULA, FULL_JOIN, GREATER_EQUAL_JOIN, GREATER_JOIN, GROUP_OTHERS, HOUR_DATE_GROUP, HOUR_OF_DAY_DATE_GROUP, INNER_JOIN, JOIN, LAST_FORMULA, LEAVE_OTHERS, LEFT_JOIN, LESS_EQUAL_JOIN, LESS_JOIN, MAX_FORMULA, MEDIAN_FORMULA, MESSAGE_FORMAT, MILLISECOND_DATE_GROUP, MIN_FORMULA, MINUTE_DATE_GROUP, MODE_FORMULA, MONTH_DATE_GROUP, MONTH_OF_YEAR_DATE_GROUP, NONE_DATE_GROUP, NONE_FORMULA, NOT_EQUAL_JOIN, NTHLARGEST_FORMULA, NTHMOSTFREQUENT_FORMULA, NTHSMALLEST_FORMULA, PARAM_PREFIX, PART_DATE_GROUP, PERCENT_FORMAT, PERCENTAGE_BY_COL, PERCENTAGE_BY_ROW, PERCENTAGE_NONE, PERCENTAGE_OF_COL_GRANDTOTAL, PERCENTAGE_OF_COL_GROUP, PERCENTAGE_OF_GRANDTOTAL, PERCENTAGE_OF_GROUP, PERCENTAGE_OF_ROW_GRANDTOTAL, PERCENTAGE_OF_ROW_GROUP, POPULATIONSTANDARDDEVIATION_FORMULA, POPULATIONVARIANCE_FORMULA, PRODUCT_FORMULA, PTHPERCENTILE_FORMULA, QUARTER_DATE_GROUP, QUARTER_OF_YEAR_DATE_GROUP, RIGHT_JOIN, SECOND_DATE_GROUP, SET_FORMULA, SORT_ASC, SORT_DESC, SORT_NONE, SORT_ORIGINAL, SORT_SPECIFIC, SORT_VALUE_ASC, SORT_VALUE_DESC, STANDARDDEVIATION_FORMULA, SUB_QUERY_PARAM, SUM_FORMULA, SUMSQ_FORMULA, SUMWT_FORMULA, VARIANCE_FORMULA, WEEK_DATE_GROUP, WEEK_OF_MONTH_DATE_GROUP, WEEK_OF_YEAR_DATE_GROUP, WEIGHTEDAVERAGE_FORMULA, YEAR_DATE_GROUP
 
Fields inherited from interface inetsoft.report.internal.ParameterSheetRepository
EMBED_PARAMETER_SHEET, EMBED_SECTION
 
Fields inherited from interface inetsoft.uql.asset.AssetRepository
ASSET_ERRORS, COMPONENT_SCOPE, GLOBAL_SCOPE, IGNORE_PERM, LOCAL_QUERY, QUERY_SCOPE, REPORT_SCOPE, REPORT_WORKSHEET, REPOSITORY_SCOPE, TEMPORARY_SCOPE, USER_SCOPE
 
Constructor Summary
ParameterSheet()
           
 
Method Summary
 void addStagedParameterFlow(int index, inetsoft.report.parameter.StagedParameterFlow sflow)
          Add a staged parameter flow on the specified index.
 void addStagedParameterFlow(inetsoft.report.parameter.StagedParameterFlow sflow)
          Add a staged parameter flow.
 Object clone()
          Make a copy of this report.
 int getCurrentStagedFlow(String elem)
          Get staged parameter flow this element was in.
 Enumeration getQueries()
          Get all the queries.
 XQuery getQuery(String qname)
          Get an embedded query definition.
 Enumeration getQueryNames()
          Get the names of embedded queries.
 int getStagedFlowCount()
          Get staged parameter flows count.
 inetsoft.report.parameter.StagedParameterFlow[] getStagedParameterFlows()
          Get staged parameter flows.
 int getStageLevel(int currentFlow)
          Get currrent stage level.
 int getStageLevel(String element)
          Get the stage level of a field element.
 inetsoft.util.IndexedStorage getStorage(AssetEntry entry)
          Get the indexed storage of an asset entry.
 boolean hasMoreStages(int currentFlow)
          Check if has more stages.
 boolean isEmbedded()
          Check if it is an embeded parameter sheet.
 boolean isEnabledOnStage(ReportElement elem)
          Check if a field element is enabled on current stage.
 boolean isPendingExecution(ReportElement elem)
          Check if the query for element should be executed.
 boolean isValid()
          Check if this parameter is valid.
 Enumeration nextStage(int currentFlow)
          Switch to the next stage.
 void removeAllStagedFlows()
          Remove all the StagedParameterFlows.
 void removeQuery(String qname)
          Remove the named embedded query.
 void removeStagedFlow(int index)
          Remove the StagedParameterFlow on the specified index.
 void resetStageLevel()
          Reset current stage level for reuse.
 void setEmbedded(boolean embedded)
          Set embeded property for the parameter sheet.
 void setExecutionSet(Set elems)
          Set the set of elements to include in the next execution of the report.
 void setMainSheet(ReportSheet parent)
          Set parent sheet.
 void setQuery(String qname, XQuery query)
          Add or remove an embedded query to the report.
 void setStageLevel(int currentFlow, int slevel)
          Set current stage level.
 void updateQuery(XQuery dx, String oname)
          Add or replace a query in the repository.
 
Methods inherited from class inetsoft.report.TabularSheet
addAreaBreak, addBean, addBreak, addBullet, addBullet, addButton, addButton, addChart, addChart, addCheckBox, addCheckBox, addChoiceElement, addChoiceElement, addComponent, addComponent, addComposite, addConditionalPageBreak, addConditionalPageBreak, addDateCombo, addDateCombo, addElement, addForm, addImage, addImage, addImage, addImageButton, addImageButton, addListElement, addListElement, addNewline, addObject, addPageBreak, addPainter, addPainter, addRadioButton, addRadioButton, addRightTab, addSection, addSection, addSeparator, addShape, addSpace, addTab, addTable, addText, addText, addTextArea, addTextArea, addTextBox, addTextBox, addTextBox, addTextBox, addTextField, addTextField, addTOC, clone, copyTabularSheet, copyTabularSheet, getAllElements, getCellBackground, getCellBackgroundLayout, getCellBackgroundSize, getCellBorderColor, getCellBorders, getCellSpan, getColCount, getColWidth, getColWidthPoints, getElement, getElementCell, getElementCount, getElementIndex, getMinRowHeight, getNextOrientation, getRowCount, getRowHeight, getRowMargin, getRowOrientation, getShape, getShapeCount, insertCols, insertElement, insertRows, isCellRepeat, isFitPage, mergeCells, moveElement, printNext, printNextPage, removeAllElements, removeCols, removeContents, removeElement, removeElement, removeRows, removeShape, replaceElement, replaceElement, resetContents, setCellBackground, setCellBackgroundLayout, setCellBackgroundSize, setCellBackgroundSize, setCellBorderColor, setCellBorders, setCellRepeat, setCellSpan, setCellSpan, setColWidth, setFitPage, setMinRowHeight, setRowMargin, setRowOrientation, splitCols, splitRows, toString
 
Methods inherited from class inetsoft.report.ReportSheet
addExecuteListener, addFooterBreak, addFooterElement, addFooterImage, addFooterImage, addFooterImage, addFooterNewline, addFooterObject, addFooterPainter, addFooterPainter, addFooterRightTab, addFooterSection, addFooterSection, addFooterSeparator, addFooterSpace, addFooterTab, addFooterTable, addFooterText, addFooterText, addFooterTextBox, addFooterTextBox, addFormat, addFormat, addFormula, addHeaderBreak, addHeaderElement, addHeaderImage, addHeaderImage, addHeaderImage, addHeaderNewline, addHeaderObject, addHeaderPainter, addHeaderPainter, addHeaderRightTab, addHeaderSection, addHeaderSection, addHeaderSeparator, addHeaderSpace, addHeaderTab, addHeaderTable, addHeaderText, addHeaderText, addHeaderTextBox, addHeaderTextBox, addPageBreakListener, addParameter, addParameter, addPresenter, addPresenter, addRefreshListener, addRunningTotal, clear, clearFormat, clearPresenter, containsFormula, copyFormulas, copyReportSheet, copyReportSheet, exportQueries, fireExecuteEvent, firePageBreakEvent, getAllFooterElementCount, getAllHeaderElementCount, getBackground, getBackgroundLayout, getBackgroundSize, getContextName, getCSSLocation, getCurrentAlignment, getCurrentBackground, getCurrentCellPadding, getCurrentFont, getCurrentForeground, getCurrentIndent, getCurrentLineId, getCurrentLineSpacing, getCurrentMargin, getCurrentPainterLayout, getCurrentPainterMargin, getCurrentSeparatorAdvance, getCurrentTableAdvance, getCurrentTableLayout, getCurrentTableWidth, getCurrentTabStops, getCurrentTextAdvance, getCurrentWrapping, getDataSet, getDirectory, getElement, getElements, getExecuteListeners, getExportInfo, getFooterBounds, getFooterElement, getFooterElementCount, getFooterElementIndex, getFooterFromEdge, getForm, getFormat, getFormula, getFormulas, getFormulas, getHeaderBounds, getHeaderElement, getHeaderElementCount, getHeaderElementIndex, getHeaderFromEdge, getImportInfo, getLocale, getMargin, getMaxPages, getMaxPages, getMetaTemplate, getOnInit, getOnLoad, getOnPageBreak, getOnPrint, getOrientation, getPageNumberingStart, getPageSize, getParameter, getParameterCount, getParameters, getParameterSheetFlow, getParameterSheets, getParentReport, getPresenter, getPrinterMargin, getProperty, getQueryType, getRunningTotal, getRunningTotalCount, getSharedFilter, getTable, getTableStyle, getText, getVersion, importQueries, insertFooterElement, insertHeaderElement, isCurrentJustify, isCurrentOrphanControl, isCurrentTableOrphanControl, isExportSinglePage, isFromMetaTemplate, isHorizontalWrap, isLandscape, isParameterPrompting, isSinglePageForTopReport, isVisible, keepWithNext, mergeInto, moveAnchor, moveHeaderFooterElement, print, print, printHeaderFooter, printNextArea, printNextLine, printNonFlowAreas, refreshFormats, removeAllParameters, removeContext, removeElementHeaderFooter, removeExecuteListener, removeExecuteListeners, removeFooterElement, removeFormat, removeFormula, removeHeaderElement, removeHeaderFooterElement, removePageBreakListener, removeParameter, removePresenter, removeRunningTotal, replaceFooterElement, replaceFormulaInfo, replaceHeaderElement, replaceHeaderFooterElement, reset, resetPageNumbering, saveContext, selectContext, setBackground, setBackgroundLayout, setBackgroundSize, setBackgroundSize, setContextName, setCSSLocation, setCurrentAlignment, setCurrentBackground, setCurrentCellPadding, setCurrentFont, setCurrentFooter, setCurrentFooter, setCurrentForeground, setCurrentHeader, setCurrentHeader, setCurrentIndent, setCurrentJustify, setCurrentLineId, setCurrentLineSpacing, setCurrentOrphanControl, setCurrentPainterLayout, setCurrentPainterMargin, setCurrentSeparatorAdvance, setCurrentTableAdvance, setCurrentTableLayout, setCurrentTableOrphanControl, setCurrentTableWidth, setCurrentTabStops, setCurrentTextAdvance, setCurrentWrapping, setDirectory, setElement, setFooterFromEdge, setFormulaInfos, setHeaderFromEdge, setHorizontalWrap, setLocale, setMargin, setMaxPages, setMetaTemplate, setOnInit, setOnLoad, setOnPageBreak, setOnPrint, setOrientation, setPageNumberingStart, setPageSize, setParameterPrompting, setParameterSheet, setParameterSheetFlow, setParameterSheets, setParentReport, setPrinterMargin, setProperty, setSharedFilter, setTableStyle, setVersion, setVisible, syncSourceInfo, syncSourceInfo
 
Methods inherited from class inetsoft.report.internal.StyleCore
addChangeListener, addr, addScriptObject, advance, alignLine, append, append, calcGrid, checkDataSourceFolderPermission, checkDataSourcePermission, checkQueryFolderPermission, checkQueryPermission, cloneElements, cloneElements, complete, completeElement, copyQueries, copyStyleCore, createFinder, createFormatMap, createPresenterMap, deleteScriptEnv, fireEvent, format, format, getActionScriptable, getAllFooterElements, getAllHeaderElements, getBackgroundImageLocation, getBuildNumber, getBurstInfo, getCompositeElement, getDefaultFooter, getDefaultHeader, getDependencyFile, getDependencyFileName, getElementFooters, getElementHeaders, getElementWidth, getElemInfoBoundsMap, getElemInfoMap, getFinder, getFormat, getFormats, getFrames, getHeadingNumberArray, getHFTextFormatter, getLocalQueryRepository, getNextHeadingNumberArray, getNextID, getNumHeadingMap, getOnLoadResult, getOutputType, getPageTotalStart, getPagingLock, getParameterSheet, getParentScope, getPresenter, getProperties, getQueryManager, getReportManager, getReportMode, getScriptEnv, getScriptObject, getSecNumHeadingMap, getSheet, getTextSize, getTopReport, getVariableTable, hasOnPrint, isDesignTime, isLimited, isPrintMode, isReusePages, isRunTime, isSubreport, parseAssetRepository, printFixedContainer, printFixedContainer, processHF, processHF, putElemWarnings, removeChangeListener, renameQuery, renameQuery, resetCache, resetHeadingNumberArray, resetOnLoad, resetScriptEnv, restoreHeadingNumberArray, runOnInit, runOnLoad, runOnPrint, setBackgroundImageLocation, setBurstInfo, setDesignTime, setElemInfoBoundsMap, setFooterContinue, setHeaderContinue, setHeadingNumberArray, setHFTextFormatter, setHindent, setOverrideFooter, setOverrideHeader, setPageTotalStart, setParentScope, setPrintMode, setReportMode, setReportMode, setReusePages, setScriptEnv, setSubreport, setValue, setVariableTable, skip, toString, updateParameterSheet, writeAssetRepository
 
Methods inherited from class inetsoft.uql.asset.AbstractAssetEngine
addAssetChangeListener, addFolder, allowsFolderScopeChange, allowsSheetScopeChange, changeFolder, changeFolder0, changeSheet, changeSheet0, checkAssetPermission, checkDependencyValidity, checkFolderRemoveable, checkPermission, clearCache, clearVSBookmark, closeStorages, containsEntry, createPhysicalEntry, dispose, finalize, fireEvent, getAssetPrefix, getDependencyFileKey, getDesignView, getEntries, getEntries, getEntryIdentifier, getParent, getParentFolder, getQueryEntries, getQuotaManager, getReportSheetDependencies, getReportStorage, getSession, getSheetDependencies, getStorage, getStorages, getVSBookmark, getWorksheetEntries, initFinder, isEntryAvailable, removeAssetChangeListener, removeFolder, removeFolder0, removeSheet, removeSheet0, removeUser, renameUser, setParent, setSheet, setSheet, setVSBookmark, supportsScope
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

STAGE_LEVEL

public static final String STAGE_LEVEL
Stage level name.

See Also:
Constant Field Values

STAGE_FLOW_LEVEL

public static final String STAGE_FLOW_LEVEL
Stage flow & level name.

See Also:
Constant Field Values

PARAMETER_SHEET

public static final String PARAMETER_SHEET
Parameter sheet name.

See Also:
Constant Field Values
Constructor Detail

ParameterSheet

public ParameterSheet()
Method Detail

getStagedParameterFlows

public inetsoft.report.parameter.StagedParameterFlow[] getStagedParameterFlows()
Get staged parameter flows.

Returns:
staged parameter flows if any, empty array otherwise.

addStagedParameterFlow

public void addStagedParameterFlow(inetsoft.report.parameter.StagedParameterFlow sflow)
Add a staged parameter flow.

Parameters:
sflow - the specified staged parameter flow.

addStagedParameterFlow

public void addStagedParameterFlow(int index,
                                   inetsoft.report.parameter.StagedParameterFlow sflow)
Add a staged parameter flow on the specified index.

Parameters:
index - the specified index.
sflow - the specified staged parameter flow.

getStagedFlowCount

public int getStagedFlowCount()
Get staged parameter flows count.

Returns:
staged parameter flows count if any.

removeAllStagedFlows

public void removeAllStagedFlows()
Remove all the StagedParameterFlows.


removeStagedFlow

public void removeStagedFlow(int index)
Remove the StagedParameterFlow on the specified index.

Parameters:
index - the specified index.

resetStageLevel

public void resetStageLevel()
Reset current stage level for reuse.


setStageLevel

public void setStageLevel(int currentFlow,
                          int slevel)
Set current stage level.


getStageLevel

public int getStageLevel(int currentFlow)
Get currrent stage level.

Returns:
current stage level.

getCurrentStagedFlow

public int getCurrentStagedFlow(String elem)
Get staged parameter flow this element was in.

Parameters:
elem - the specified element name.
Returns:
the staged flow number this element was in, -1 if not in any.

hasMoreStages

public boolean hasMoreStages(int currentFlow)
Check if has more stages.

Parameters:
currentFlow - the specified staged flow number.
Returns:
true if has more stages, false otherwise.

nextStage

public Enumeration nextStage(int currentFlow)
Switch to the next stage.

Parameters:
currentFlow - the specified staged flow number.
Returns:
the elements in the next stage.

getStageLevel

public int getStageLevel(String element)
Get the stage level of a field element.

Parameters:
element - form.name format of the specified field element.
Returns:
stage level of the field element, -1 not found.

setExecutionSet

public void setExecutionSet(Set elems)
Set the set of elements to include in the next execution of the report. Elements not included in the set are ignored.


isPendingExecution

public boolean isPendingExecution(ReportElement elem)
Check if the query for element should be executed. Execution will be skipped if the element is not enabled, or if an execution set is assigned and the element is not in the execution set.


isEnabledOnStage

public boolean isEnabledOnStage(ReportElement elem)
Check if a field element is enabled on current stage.

Parameters:
elem - the specified element.
Returns:
true if is enabled, false otherwise.

isEmbedded

public boolean isEmbedded()
Check if it is an embeded parameter sheet.


setEmbedded

public void setEmbedded(boolean embedded)
Set embeded property for the parameter sheet.


isValid

public boolean isValid()
Check if this parameter is valid.

Returns:
true if is, false otherwise.

setMainSheet

public void setMainSheet(ReportSheet parent)
Set parent sheet.


getQueryNames

public Enumeration getQueryNames()
Get the names of embedded queries.

Overrides:
getQueryNames in class ReportSheet

getQuery

public XQuery getQuery(String qname)
Get an embedded query definition.

Specified by:
getQuery in interface XQueryRepository
Overrides:
getQuery in class ReportSheet
Parameters:
qname - the specified query name.
Returns:
query matches the specified query name.

getQueries

public Enumeration getQueries()
Get all the queries.

Specified by:
getQueries in interface XQueryRepository
Overrides:
getQueries in class ReportSheet
Returns:
all the queries.

setQuery

public void setQuery(String qname,
                     XQuery query)
Add or remove an embedded query to the report. If the query object is null, the named query is removed from the report.

Overrides:
setQuery in class ReportSheet

updateQuery

public void updateQuery(XQuery dx,
                        String oname)
                 throws Exception
Add or replace a query in the repository.

Specified by:
updateQuery in interface XQueryRepository
Overrides:
updateQuery in class ReportSheet
Parameters:
dx - new query.
oname - old name of the query, if the name has been changed. Otherwise it should be null.
Throws:
Exception

removeQuery

public void removeQuery(String qname)
Remove the named embedded query.

Specified by:
removeQuery in interface XQueryRepository
Overrides:
removeQuery in class ReportSheet

getStorage

public inetsoft.util.IndexedStorage getStorage(AssetEntry entry)
                                        throws Exception
Get the indexed storage of an asset entry.

Specified by:
getStorage in interface AssetRepository
Overrides:
getStorage in class AbstractAssetEngine
Parameters:
entry - the specified asset entry.
Returns:
the indexed storage of the asset entry.
Throws:
Exception

clone

public Object clone()
Description copied from class: ReportSheet
Make a copy of this report.

Overrides:
clone in class TabularSheet

Copyright © 1996-2014 InetSoft Technology Corp. All Rights Reserved.