com.actuate.activeportal.forms
Class QueryActionForm

java.lang.Object
  extended by org.apache.struts.action.ActionForm
      extended by com.actuate.activeportal.forms.BaseActionForm
          extended by com.actuate.activeportal.forms.JobActionForm
              extended by com.actuate.activeportal.forms.QueryActionForm
All Implemented Interfaces:
java.io.Serializable

public class QueryActionForm
extends JobActionForm

This form is used when creating, editing, running or submitting an actuate query. The form is defined as a request scope form. The query action class process the form and stored the information to a session bean "createQueryBean".

See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.actuate.activeportal.forms.JobActionForm
recurringDayList, structureNames
 
Constructor Summary
QueryActionForm()
           
 
Method Summary
 void fixUTF8()
          Converts the form properties which is in UTF-8 encoding to internal Java String.
 java.lang.String[] getAddToGroups()
          Returns the groups for grouping actuate query
 java.lang.String getAvailableColumn()
          Returns the availableColumn.
 java.lang.String getAvailableColumns()
          Returns the availableColumns.
 java.lang.String getDataSourceId()
          Returns the dataSourceId.
 java.lang.String getDataSourceName()
          Returns the dataSourceName.
 java.lang.String getDescription()
          Returns the description.
 java.lang.String getFilterNewColumn()
          Returns the filterNewColumn.
 java.lang.String getFilterNewOperator()
          Returns the filterNewOperator.
 java.lang.String getFilterNewValue()
          Returns the filterNewValue.
 com.actuate.schemas.FilterCriteria[] getFilters()
          Returns the filters.
 com.actuate.schemas.FilterCriteria getFilters(int index)
          Returns the filter at specified index
 java.lang.String getFormat()
          Returns the format.
 java.util.List getGroupNodes()
          Returns grouping nodes
 java.lang.String getGroupSortOrder(int index)
          Returns group sorting order "ASC" or "DES"
 java.lang.Boolean getHidePrompt()
          Returns the hidePrompt.
 int getLastSelectedIndex()
          Returns last selected index
 java.lang.String getLastSelectedNode()
          Returns the last selected node for grouping actuate query
 java.lang.String[] getName()
          Returns the name.
 java.lang.String[] getNotificationTypes()
           
 java.lang.String getPageHeader()
          Returns the pageHeader.
 java.lang.Integer getPromptedFilterCount()
          Returns the promptedFilterCount.
 java.lang.String getQueryLocation()
          Returns the queryLocation.
 java.lang.String getQueryName()
          Returns the queryName.
 java.lang.String getQueryOverwrite()
          Returns the queryOverwrite.
 java.lang.String getSelectedColumn()
          Returns the selectedColumn.
 java.util.Vector getSelectedColumnList()
          This method returns the list of columns that were selected in the content tab.
 java.lang.String getSelectedColumns()
          Returns the selectedColumns.
 java.lang.String getSelectedNode()
          Returns the selected node for grouping actuate query
 java.lang.String getSortNewColumn()
          Returns the sortNewColumn.
 java.lang.String getSortNewSortOrder()
          Returns the sortNewSortOrder.
 java.lang.String[] getSortOrder()
          Returns the sortOrder.
 SummaryBean getSummaryColumn(int index)
          Returns the summary columns at specified index
 java.util.Vector getSummaryColumns()
          Returns the summary columns
 java.lang.String getTreeCommand()
          Returns actuate query tree command for grouping actuate query
 java.lang.String getTreePath()
          Returns path of the selected node for grouping actuate query
 boolean isAllowGroupingChangeAtRuntime()
          Returns if grouping settings can change
 boolean isAllowSummaryChangeAtRuntime()
          Returns if summary settings can change
 boolean isContentPrompt()
          Returns the contentPrompt.
 boolean isFilterNewPrompt()
          Returns the filterNewPrompt.
 boolean isFilterValueAllowed(int index)
          Return true if the operator is "IS NULL" or "IS NOT NULL" so that filter Value control can be disabled If "IS NULL" or "IS NOT NULL" is chosen then we should not allow the user to enter filter values
 boolean isFormatPrompt()
          Returns the formatPrompt.
 boolean isOutputDistinctRowsOnly()
          Returns if duplicate rows should be skipped
 boolean isShowRowCountsInTotal()
          Returns show row count total settings
 boolean isSortPrompt()
          Returns the sortPrompt.
 boolean isSuppressDetailRows()
          Returns if suppress detail rows is required
 void reset(org.apache.struts.action.ActionMapping mapping, javax.servlet.http.HttpServletRequest request)
           
 void setAddToGroups(java.lang.String[] groups)
          Sets the groups for grouping actuate query
 void setAllowGroupingChangeAtRuntime(boolean b)
          Sets if grouping settings can change
 void setAllowSummaryChangeAtRuntime(boolean b)
          Sets if summary settings can change
 void setAvailableColumn(java.lang.String availableColumn)
          Sets the availableColumn.
 void setAvailableColumns(java.lang.String availableColumns)
          Sets the availableColumns.
 void setContentPrompt(boolean contentPrompt)
          Sets the contentPrompt.
 void setDataSourceId(java.lang.String dataSourceId)
          Sets the dataSourceId.
 void setDataSourceName(java.lang.String dataSourceName)
          Sets the dataSourceName.
 void setDescription(java.lang.String description)
          Sets the description.
 void setFilterNewColumn(java.lang.String filterNewColumn)
          Sets the filterNewColumn.
 void setFilterNewOperator(java.lang.String filterNewOperator)
          Sets the filterNewOperator.
 void setFilterNewPrompt(boolean filterNewPrompt)
          Sets the filterNewPrompt.
 void setFilterNewValue(java.lang.String filterNewValue)
          Sets the filterNewValue.
 void setFilters(com.actuate.schemas.FilterCriteria[] filters)
          Sets the filters.
 void setFilters(int index, com.actuate.schemas.FilterCriteria value)
          Sets the filter at specifed index
 void setFormat(java.lang.String format)
          Sets the format.
 void setFormatPrompt(boolean formatPrompt)
          Sets the formatPrompt.
 void setGroupNodes(java.util.List collection)
          Sets grouping nodes
 void setGroupSortOrder(int index, java.lang.String sortOrder)
          Sets group sorting order "ASC" or "DES"
 void setHidePrompt(java.lang.Boolean hidePrompt)
          Sets the hidePrompt.
 void setLastSelectedIndex(int i)
          Sets last selected index
 void setLastSelectedNode(java.lang.String string)
          Sets the last selected node for grouping actuate query
 void setName(java.lang.String[] name)
          Sets the name.
 void setOutputDistinctRowsOnly(boolean b)
          Set if duplicate rows should be skipped
 void setPageHeader(java.lang.String pageHeader)
          Sets the pageHeader.
 void setQueryLocation(java.lang.String queryLocation)
          Sets the queryLocation.
 void setQueryName(java.lang.String queryName)
          Sets the queryName.
 void setQueryOverwrite(java.lang.String queryOverwrite)
          Sets the queryOverwrite.
 void setSelectedColumn(java.lang.String selectedColumn)
          Sets the selectedColumn.
 void setSelectedColumnList(java.util.Vector vector)
          This method is called by the action class for setting the list of selected columns.
 void setSelectedColumns(java.lang.String selectedColumns)
          Sets the selectedColumns.
 void setSelectedNode(java.lang.String string)
          Sets the selected node for grouping actuate query
 void setShowRowCountsInTotal(boolean b)
          Sets show row count total settings
 void setSortNewColumn(java.lang.String sortNewColumn)
          Sets the sortNewColumn.
 void setSortNewSortOrder(java.lang.String sortNewSortOrder)
          Sets the sortNewSortOrder.
 void setSortOrder(java.lang.String[] sortOrder)
          Sets the sortOrder.
 void setSortPrompt(boolean sortPrompt)
          Sets the sortPrompt.
 void setSummaryColumn(int index, SummaryBean summary)
          Sets the summary columns at specified index
 void setSummaryColumns(java.util.Vector vector)
          Sets the summary columns
 void setSuppressDetailRows(boolean b)
          Set if suppress detail rows is required *
 void setTreeCommand(java.lang.String string)
          Sets actuate query tree command for grouping actuate query
 void setTreePath(java.lang.String string)
          Sets path of the selected node for grouping actuate query
 
Methods inherited from class com.actuate.activeportal.forms.JobActionForm
dbg, getDocumentLocation, getDocumentName, getDocumentOutputLocation, getDocumentVersioning, getDocumentVersionName, getEndDate, getExecutableID, getJobId, getJobName, getKeepROIIfFailed, getKeepROIIfSucceeded, getLoadTab, getNotificationAttachment, getNotifyString, getOnceDate, getOnceTime, getOutputFormat, getOutputFormatSupported, getParameters, getParameters, getRecurringDay, getRecurringTime, getSaveTab, getScheduleType, getStartDate, getStructureNames, getViewInNewWindow, isAllowChangingPriority, isDocumentSave, isNotificationListSupported, isNotificationSupported, isNotify, isUseEndDateTime, isUseStartDateTime, setAllowChangingPriority, setDocumentLocation, setDocumentName, setDocumentOutputLocation, setDocumentSave, setDocumentVersioning, setDocumentVersionName, setEndDate, setExecutableID, setJobId, setJobName, setKeepROIIfFailed, setKeepROIIfSucceeded, setLoadTab, setNotificationAttachment, setNotificationListSupported, setNotificationSupported, setNotify, setNotifyString, setOnceDate, setOnceTime, setOutputFormat, setOutputFormatSupported, setParameters, setParameters, setRecurringDay, setRecurringTime, setSaveTab, setScheduleType, setStartDate, setStructureNames, setUseEndDateTime, setUseStartDateTime, setViewInNewWindow
 
Methods inherited from class com.actuate.activeportal.forms.BaseActionForm
isPostback, setPostback
 
Methods inherited from class org.apache.struts.action.ActionForm
getMultipartRequestHandler, getServletWrapper, reset, setMultipartRequestHandler, setServlet, validate, validate
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

QueryActionForm

public QueryActionForm()
Method Detail

fixUTF8

public void fixUTF8()
Converts the form properties which is in UTF-8 encoding to internal Java String.

Overrides:
fixUTF8 in class JobActionForm

reset

public void reset(org.apache.struts.action.ActionMapping mapping,
                  javax.servlet.http.HttpServletRequest request)
Overrides:
reset in class JobActionForm

getAvailableColumn

public java.lang.String getAvailableColumn()
Returns the availableColumn.

Returns:
String

getAvailableColumns

public java.lang.String getAvailableColumns()
Returns the availableColumns.

Returns:
String

isContentPrompt

public boolean isContentPrompt()
Returns the contentPrompt.

Returns:
boolean

getDescription

public java.lang.String getDescription()
Returns the description.

Returns:
String

getFormat

public java.lang.String getFormat()
Returns the format.

Returns:
String

isFormatPrompt

public boolean isFormatPrompt()
Returns the formatPrompt.

Returns:
boolean

getPageHeader

public java.lang.String getPageHeader()
Returns the pageHeader.

Returns:
String

getQueryLocation

public java.lang.String getQueryLocation()
Returns the queryLocation.

Returns:
String

getQueryName

public java.lang.String getQueryName()
Returns the queryName.

Returns:
String

getSelectedColumn

public java.lang.String getSelectedColumn()
Returns the selectedColumn.

Returns:
String

getSelectedColumns

public java.lang.String getSelectedColumns()
Returns the selectedColumns.

Returns:
String

isSortPrompt

public boolean isSortPrompt()
Returns the sortPrompt.

Returns:
boolean

setAvailableColumn

public void setAvailableColumn(java.lang.String availableColumn)
Sets the availableColumn.

Parameters:
availableColumn - The availableColumn to set

setAvailableColumns

public void setAvailableColumns(java.lang.String availableColumns)
Sets the availableColumns.

Parameters:
availableColumns - The availableColumns to set

setContentPrompt

public void setContentPrompt(boolean contentPrompt)
Sets the contentPrompt.

Parameters:
contentPrompt - The contentPrompt to set

setDescription

public void setDescription(java.lang.String description)
Sets the description.

Parameters:
description - The description to set

setFormat

public void setFormat(java.lang.String format)
Sets the format.

Parameters:
format - The format to set

setFormatPrompt

public void setFormatPrompt(boolean formatPrompt)
Sets the formatPrompt.

Parameters:
formatPrompt - The formatPrompt to set

setPageHeader

public void setPageHeader(java.lang.String pageHeader)
Sets the pageHeader.

Parameters:
pageHeader - The pageHeader to set

setQueryLocation

public void setQueryLocation(java.lang.String queryLocation)
Sets the queryLocation.

Parameters:
queryLocation - The queryLocation to set

setQueryName

public void setQueryName(java.lang.String queryName)
Sets the queryName.

Parameters:
queryName - The queryName to set

setSelectedColumn

public void setSelectedColumn(java.lang.String selectedColumn)
Sets the selectedColumn.

Parameters:
selectedColumn - The selectedColumn to set

setSelectedColumns

public void setSelectedColumns(java.lang.String selectedColumns)
Sets the selectedColumns.

Parameters:
selectedColumns - The selectedColumns to set

setSortPrompt

public void setSortPrompt(boolean sortPrompt)
Sets the sortPrompt.

Parameters:
sortPrompt - The sortPrompt to set

getDataSourceName

public java.lang.String getDataSourceName()
Returns the dataSourceName.

Returns:
String

setDataSourceName

public void setDataSourceName(java.lang.String dataSourceName)
Sets the dataSourceName.

Parameters:
dataSourceName - The dataSourceName to set

getSortNewColumn

public java.lang.String getSortNewColumn()
Returns the sortNewColumn.

Returns:
String

setSortNewColumn

public void setSortNewColumn(java.lang.String sortNewColumn)
Sets the sortNewColumn.

Parameters:
sortNewColumn - The sortNewColumn to set

getSortNewSortOrder

public java.lang.String getSortNewSortOrder()
Returns the sortNewSortOrder.

Returns:
String

setSortNewSortOrder

public void setSortNewSortOrder(java.lang.String sortNewSortOrder)
Sets the sortNewSortOrder.

Parameters:
sortNewSortOrder - The sortNewSortOrder to set

getName

public java.lang.String[] getName()
Returns the name.

Returns:
String[]

getSortOrder

public java.lang.String[] getSortOrder()
Returns the sortOrder.

Returns:
String[]

setName

public void setName(java.lang.String[] name)
Sets the name.

Parameters:
name - The name to set

setSortOrder

public void setSortOrder(java.lang.String[] sortOrder)
Sets the sortOrder.

Parameters:
sortOrder - The sortOrder to set

getFilterNewColumn

public java.lang.String getFilterNewColumn()
Returns the filterNewColumn.

Returns:
String

getFilterNewOperator

public java.lang.String getFilterNewOperator()
Returns the filterNewOperator.

Returns:
String

getFilterNewValue

public java.lang.String getFilterNewValue()
Returns the filterNewValue.

Returns:
String

setFilterNewColumn

public void setFilterNewColumn(java.lang.String filterNewColumn)
Sets the filterNewColumn.

Parameters:
filterNewColumn - The filterNewColumn to set

setFilterNewOperator

public void setFilterNewOperator(java.lang.String filterNewOperator)
Sets the filterNewOperator.

Parameters:
filterNewOperator - The filterNewOperator to set

setFilterNewValue

public void setFilterNewValue(java.lang.String filterNewValue)
Sets the filterNewValue.

Parameters:
filterNewValue - The filterNewValue to set

isFilterNewPrompt

public boolean isFilterNewPrompt()
Returns the filterNewPrompt.

Returns:
boolean

isFilterValueAllowed

public boolean isFilterValueAllowed(int index)
Return true if the operator is "IS NULL" or "IS NOT NULL" so that filter Value control can be disabled If "IS NULL" or "IS NOT NULL" is chosen then we should not allow the user to enter filter values

Parameters:
index - The Index of the filter operation selected by the user

setFilterNewPrompt

public void setFilterNewPrompt(boolean filterNewPrompt)
Sets the filterNewPrompt.

Parameters:
filterNewPrompt - The filterNewPrompt to set

getFilters

public com.actuate.schemas.FilterCriteria[] getFilters()
Returns the filters.

Returns:
the filters.

getFilters

public com.actuate.schemas.FilterCriteria getFilters(int index)
Returns the filter at specified index


setFilters

public void setFilters(com.actuate.schemas.FilterCriteria[] filters)
Sets the filters.

Parameters:
filters - The filters to set

setFilters

public void setFilters(int index,
                       com.actuate.schemas.FilterCriteria value)
Sets the filter at specifed index


getHidePrompt

public java.lang.Boolean getHidePrompt()
Returns the hidePrompt.

Returns:
Boolean

setHidePrompt

public void setHidePrompt(java.lang.Boolean hidePrompt)
Sets the hidePrompt.

Parameters:
hidePrompt - The hidePrompt to set

getDataSourceId

public java.lang.String getDataSourceId()
Returns the dataSourceId.

Returns:
String

setDataSourceId

public void setDataSourceId(java.lang.String dataSourceId)
Sets the dataSourceId.

Parameters:
dataSourceId - The dataSourceId to set

getQueryOverwrite

public java.lang.String getQueryOverwrite()
Returns the queryOverwrite.

Returns:
String

setQueryOverwrite

public void setQueryOverwrite(java.lang.String queryOverwrite)
Sets the queryOverwrite.

Parameters:
queryOverwrite - The queryOverwrite to set

getPromptedFilterCount

public java.lang.Integer getPromptedFilterCount()
Returns the promptedFilterCount.

Returns:
int

getNotificationTypes

public java.lang.String[] getNotificationTypes()

getSelectedColumnList

public java.util.Vector getSelectedColumnList()
This method returns the list of columns that were selected in the content tab.

Returns:
A vector containing the list of selected columns.

setSelectedColumnList

public void setSelectedColumnList(java.util.Vector vector)
This method is called by the action class for setting the list of selected columns. This method is not meant to be called externally.

Parameters:
vector - A vector containing the list of selected columns.

setAddToGroups

public void setAddToGroups(java.lang.String[] groups)
Sets the groups for grouping actuate query


getAddToGroups

public java.lang.String[] getAddToGroups()
Returns the groups for grouping actuate query


getTreeCommand

public java.lang.String getTreeCommand()
Returns actuate query tree command for grouping actuate query


setTreeCommand

public void setTreeCommand(java.lang.String string)
Sets actuate query tree command for grouping actuate query


getTreePath

public java.lang.String getTreePath()
Returns path of the selected node for grouping actuate query


setTreePath

public void setTreePath(java.lang.String string)
Sets path of the selected node for grouping actuate query


getSelectedNode

public java.lang.String getSelectedNode()
Returns the selected node for grouping actuate query


setSelectedNode

public void setSelectedNode(java.lang.String string)
Sets the selected node for grouping actuate query


getLastSelectedNode

public java.lang.String getLastSelectedNode()
Returns the last selected node for grouping actuate query


setLastSelectedNode

public void setLastSelectedNode(java.lang.String string)
Sets the last selected node for grouping actuate query


isAllowGroupingChangeAtRuntime

public boolean isAllowGroupingChangeAtRuntime()
Returns if grouping settings can change


setAllowGroupingChangeAtRuntime

public void setAllowGroupingChangeAtRuntime(boolean b)
Sets if grouping settings can change


isOutputDistinctRowsOnly

public boolean isOutputDistinctRowsOnly()
Returns if duplicate rows should be skipped

Returns:
boolean

setOutputDistinctRowsOnly

public void setOutputDistinctRowsOnly(boolean b)
Set if duplicate rows should be skipped


isSuppressDetailRows

public boolean isSuppressDetailRows()
Returns if suppress detail rows is required

Returns:
boolean

setSuppressDetailRows

public void setSuppressDetailRows(boolean b)
Set if suppress detail rows is required *


getSummaryColumns

public java.util.Vector getSummaryColumns()
Returns the summary columns


setSummaryColumns

public void setSummaryColumns(java.util.Vector vector)
Sets the summary columns


getSummaryColumn

public SummaryBean getSummaryColumn(int index)
Returns the summary columns at specified index


setSummaryColumn

public void setSummaryColumn(int index,
                             SummaryBean summary)
Sets the summary columns at specified index


isAllowSummaryChangeAtRuntime

public boolean isAllowSummaryChangeAtRuntime()
Returns if summary settings can change


setAllowSummaryChangeAtRuntime

public void setAllowSummaryChangeAtRuntime(boolean b)
Sets if summary settings can change


isShowRowCountsInTotal

public boolean isShowRowCountsInTotal()
Returns show row count total settings


setShowRowCountsInTotal

public void setShowRowCountsInTotal(boolean b)
Sets show row count total settings


getGroupNodes

public java.util.List getGroupNodes()
Returns grouping nodes


setGroupNodes

public void setGroupNodes(java.util.List collection)
Sets grouping nodes


getGroupSortOrder

public java.lang.String getGroupSortOrder(int index)
Returns group sorting order "ASC" or "DES"


setGroupSortOrder

public void setGroupSortOrder(int index,
                              java.lang.String sortOrder)
Sets group sorting order "ASC" or "DES"


getLastSelectedIndex

public int getLastSelectedIndex()
Returns last selected index


setLastSelectedIndex

public void setLastSelectedIndex(int i)
Sets last selected index