Package org.gorpipe.querydialogs.factory

Class PerspectiveDialog

java.lang.Object

org.gorpipe.querydialogs.BasicBean

org.gorpipe.querydialogs.AbstractListBean

org.gorpipe.querydialogs.Dialog

org.gorpipe.querydialogs.factory.PerspectiveDialog

All Implemented Interfaces:

Serializable, ListModel

public class PerspectiveDialog
extends Dialog

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROPERTY_HTML_TEMPLATE
final String	writePath

Fields inherited from class org.gorpipe.querydialogs.Dialog

argumentMap, attributes, dialogDescription, errorMsgTemplate, executable, gitSHA, longRunningQueryTemplate, packageVersion, PROPERTY_BASE_CHARTCOLUMNS, PROPERTY_BASE_CHARTDF, PROPERTY_BASE_CHARTEXEC, PROPERTY_BASE_CHARTSCRIPT, PROPERTY_BASE_QUERY, PROPERTY_CHART, PROPERTY_EXECUTABLE, PROPERTY_QUERY, PROPERTY_TYPE, version

Constructor Summary

Constructors

Constructor	Description
PerspectiveDialog(Map<String,? extends Object> attributes, org.gorpipe.gor.model.FileReader fileResolver, org.gorpipe.gor.model.QueryEvaluator queryEval, DialogDescription dialogDescription, PerspectiveDialogDisplayParams displayParams, DialogType type, String query, String chartScript, String chartExec, String chartColumns, ChartDataType chartDF, List<Argument> arguments, String htmlTemplate, List<? extends Object> initialColumns, List<Perspective> perspectives, List<ColumnGroup> columnGroups, List<org.gorpipe.gor.model.ReportCommand> reportCommands, String errorMsgTemplate, String writePath, String longRunningQueryTemplate, String version, String packageVersion, String gitSHA)
PerspectiveDialog(PerspectiveDialog dlg)

Method Summary

Modifier and Type	Method	Description
void	addNewReportToViewer()
boolean	checkIfLongRunningQuery()	Determine whether the query should be run as a long query which implies that the results of the query will not be streamed to the SM user but instead the results are saved to a directory of the user´s choice.
Map<String,Argument>	getArgumentMap()	Get argument map.
List<ColumnGroup>	getColumnGroups()
String	getDialogCategory()	Get the dialog category the dialog belongs to.
Path	getDialogsFilePath()
Color	getFadeInImageColor()	Get the dialog fade in image color.
String	getHtmlTemplate()	Deprecated. Should define an html template for perspectives instead
Color	getImageColor()	Get the dialog image color.
Set<Object>	getInitialColumns()	Deprecated. Should define initial columns for perspectives instead
List<Perspective>	getPerspectives()
List<Perspective>	getPerspectivesCopies()	Get copies of perspectives.
List<org.gorpipe.gor.model.ReportCommand>	getReportCommands()	Get the report command list.
void	saveArgumentValues(Path selFilePath)
void	setArgumentValues(Path path)	Read argument values from file and set.
void	setArgumentValues(Map<String,ArgumentContent> argName2Content)	Set values for arguments.
void	setDialogsFilePath(Path dialogsFilePath)
void	setHtmlTemplate(String htmlTemplate)	Deprecated. Should define an html template for perspectives instead
void	setReportViewer(ReportViewer container)
boolean	storingAllowed()
boolean	verify()	Verify dialog by getting the error message.

Methods inherited from class org.gorpipe.querydialogs.Dialog

advancedArgumentsVisible, calcInterpolatedQuery, copyArguments, determineLongRunningQuery, getArgument, getAttribute, getBaseChartColumns, getBaseChartDF, getBaseChartExec, getBaseChartScript, getBaseQuery, getChart, getDescription, getElementAt, getErrorMessage, getFileResolver, getGitSha, getHelpLink, getInterpolatedChart, getInterpolatedQuery, getListDescription, getName, getPackageVersion, getQuery, getQueryEval, getShortName, getSize, getType, getVersion, hasArgument, interpolateChart, interpolateQuery, isExecutable, loadQuery, setAdvancedArgumentsVisible, setArgument, setBaseChartColumns, setBaseChartDF, setBaseChartExec, setBaseChartScript, setBaseQuery, setDeferUpdates, setType, toString

Methods inherited from class org.gorpipe.querydialogs.AbstractListBean

addListDataListener, fireContentsChanged, removeListDataListener

Methods inherited from class org.gorpipe.querydialogs.BasicBean

addPropertyChangeListener, addPropertyChangeListener, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getPropertyChangeListeners, getPropertyChangeListeners, removePropertyChangeListener, removePropertyChangeListener

Methods inherited from class java.lang.Object

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

Field Details

PROPERTY_HTML_TEMPLATE

public static final String PROPERTY_HTML_TEMPLATE

See Also:

• Constant Field Values

writePath

public final String writePath

Constructor Details

PerspectiveDialog

public PerspectiveDialog(Map<String,? extends Object> attributes,
 org.gorpipe.gor.model.FileReader fileResolver,
 org.gorpipe.gor.model.QueryEvaluator queryEval,
 DialogDescription dialogDescription,
 PerspectiveDialogDisplayParams displayParams,
 DialogType type,
 String query,
 String chartScript,
 String chartExec,
 String chartColumns,
 ChartDataType chartDF,
 List<Argument> arguments,
 String htmlTemplate,
 List<? extends Object> initialColumns,
 List<Perspective> perspectives,
 List<ColumnGroup> columnGroups,
 List<org.gorpipe.gor.model.ReportCommand> reportCommands,
 String errorMsgTemplate,
 String writePath,
 String longRunningQueryTemplate,
 String version,
 String packageVersion,
 String gitSHA)
                  throws freemarker.template.TemplateException

Throws:

freemarker.template.TemplateException

PerspectiveDialog

public PerspectiveDialog(PerspectiveDialog dlg)
                  throws freemarker.template.TemplateException

Throws:

freemarker.template.TemplateException

Method Details

getHtmlTemplate

@Deprecated
public String getHtmlTemplate()

Deprecated.

Should define an html template for perspectives instead

setHtmlTemplate

@Deprecated
public void setHtmlTemplate(String htmlTemplate)

Deprecated.

Should define an html template for perspectives instead

getInitialColumns

@Deprecated
public Set<Object> getInitialColumns()

Deprecated.

Should define initial columns for perspectives instead

getPerspectives

public List<Perspective> getPerspectives()

getColumnGroups

public List<ColumnGroup> getColumnGroups()

getPerspectivesCopies

public List<Perspective> getPerspectivesCopies()

Get copies of perspectives.

Returns:

list of perspectives

verify

public boolean verify()

Verify dialog by getting the error message. If the error message is empty the dialog is valid and the method returns true. If the error message is not empty the dialog is invalid, and the error message is displayed in an error dialog and the method returns false.

Returns:

true if dialog is valid, otherwise false

checkIfLongRunningQuery

public boolean checkIfLongRunningQuery()

Determine whether the query should be run as a long query which implies that the results of the query will not be streamed to the SM user but instead the results are saved to a directory of the user´s choice.

Returns:

true if the query is a long running query, otherwise false

setReportViewer

public void setReportViewer(ReportViewer container)

addNewReportToViewer

public void addNewReportToViewer()

getReportCommands

public List<org.gorpipe.gor.model.ReportCommand> getReportCommands()

Get the report command list.

Returns:

the report command list

getDialogCategory

public String getDialogCategory()

Get the dialog category the dialog belongs to.

Returns:

the dialog category

getImageColor

public Color getImageColor()

Get the dialog image color.

Returns:

the dialog image color

getFadeInImageColor

public Color getFadeInImageColor()

Get the dialog fade in image color.

Returns:

the dialog fade in image color

getArgumentMap

public Map<String,Argument> getArgumentMap()

Get argument map.

Returns:

the argument map

setArgumentValues

public void setArgumentValues(Map<String,ArgumentContent> argName2Content)

Set values for arguments.

Parameters:

argName2Content - argument name to value map

setArgumentValues

public void setArgumentValues(Path path)
                       throws IOException

Read argument values from file and set.

Parameters:

path - thepath of the file to read argument values from

Throws:

IOException

saveArgumentValues

public void saveArgumentValues(Path selFilePath)

storingAllowed

public boolean storingAllowed()

getDialogsFilePath

public Path getDialogsFilePath()

setDialogsFilePath

public void setDialogsFilePath(Path dialogsFilePath)