analytics/sdk/java/ExecReports/ExecReportsUI.java

/** 
Licensed Materials - Property of IBM

IBM Cognos Products: DOCS

(C) Copyright IBM Corp. 2005, 2008

US Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with
IBM Corp.
*/
/**
 * ExecReportsUI.java
 *
 * Copyright (C) 2008 Cognos ULC, an IBM Company. All rights reserved.
 * Cognos (R) is a trademark of Cognos ULC, (formerly Cognos Incorporated).
 *
 */

import java.awt.BorderLayout;
import java.awt.Dimension;
import java.awt.GridBagConstraints;
import java.awt.GridBagLayout;
import java.awt.GridLayout;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.awt.event.WindowAdapter;
import java.awt.event.WindowEvent;
import java.io.File;
import java.net.URL;

import javax.swing.BorderFactory;
import javax.swing.ImageIcon;
import javax.swing.JButton;
import javax.swing.JComboBox;
import javax.swing.JEditorPane;
import javax.swing.JFrame;
import javax.swing.JLabel;
import javax.swing.JMenu;
import javax.swing.JMenuBar;
import javax.swing.JMenuItem;
import javax.swing.JOptionPane;
import javax.swing.JPanel;
import javax.swing.JScrollPane;
import javax.swing.JTextField;
import javax.swing.JCheckBox;

import com.cognos.developer.schemas.bibus._3.AuthoredReport;
import com.cognos.developer.schemas.bibus._3.BaseClass;
import com.cognos.developer.schemas.bibus._3.BooleanProp;
import com.cognos.developer.schemas.bibus._3.OrderEnum;
import com.cognos.developer.schemas.bibus._3.PropEnum;
import com.cognos.developer.schemas.bibus._3.QueryOptions;
import com.cognos.developer.schemas.bibus._3.SearchPathMultipleObject;
import com.cognos.developer.schemas.bibus._3.Sort;

// This Java class extends the JFrame class so that you can
// display a window.
public class ExecReportsUI extends JFrame
{
	private CRNConnect connect;

	// The following variables represent the dialog components.
	private JEditorPane htmlAreaPane;
	private JTextField cmURL;
	private JTextField selectedSearchPath;
	private JButton runReportButton;
	private JButton firstPageButton;
	private JButton prevPageButton;
	private JButton nextPageButton;
	private JButton lastPageButton;

	private JCheckBox BurstCheckBox;

	private JComboBox repTypeOption;
	private JComboBox repSelectOption;

	private static Logon sessionLogon;

	private static final String REP_TYPE_HTML = "HTML";
	private static final String REP_TYPE_HTMLFRAG = "HTML Fragment";
	private static final String REP_TYPE_MHT = "HTML Web Archive";

	private static final String REP_TYPE_XML = "XML";
	private static final String REP_TYPE_PDF = "PDF";
	private static final String REP_TYPE_CSV = "CSV";
	private static final String REP_TYPE_XLWA = "Excel Web Archive";

	private static final int REP_TYPE_ENUM_HTML = 0;
	private static final int REP_TYPE_ENUM_XML = 1;
	private static final int REP_TYPE_ENUM_PDF = 2;
	private static final int REP_TYPE_ENUM_CSV = 3;
	private static final int REP_TYPE_ENUM_HTMLFRAG = 4;
	private static final int REP_TYPE_ENUM_MHT = 5;
	private static final int REP_TYPE_ENUM_XLWA = 6;

	private static int reportType = 0;
	private static boolean canBeBursted=false;

	private BaseClassWrapper selectedReport = null;
	private allButtonsHandler buttonListener = new allButtonsHandler();
	//private File tmpHTMLFile = null;

	// This is the constructor.
	public ExecReportsUI(String title, CRNConnect connection)
	{
		// Set the title of the frame, even before the variables are declared.
		super(title);
		connect = connection;
		addComponents();
	}

	// Add all components to the frame's panel.
	private void addComponents()
	{
		//
		//Create and add menu components
		//

		JMenuBar mBar = new JMenuBar();
		this.setJMenuBar(mBar);

		//declare menuItems
		JMenuItem exit;
		JMenuItem about;
		JMenuItem overview;

		//Add and populate the File menu.
		JMenu fileMenu = new JMenu("File");
		mBar.add(fileMenu);

		exit = new JMenuItem("Exit");
		fileMenu.add(exit);
		exit.addActionListener(new MenuHandler());

		//Add and populate the Help menu.
		JMenu helpMenu = new JMenu("Help");
		mBar.add(helpMenu);

		about = new JMenuItem("About");
		helpMenu.add(about);
		about.addActionListener(new MenuHandler());

		overview = new JMenuItem("Overview");
		helpMenu.add(overview);
		overview.addActionListener(new MenuHandler());

		//Create panels
		JPanel mainPanel = createMainPanel();
		JPanel outputNavPanel = createOutputPanel();
		JPanel panel = new JPanel(new BorderLayout());
		panel.add(mainPanel, BorderLayout.NORTH);
		panel.add(outputNavPanel);
		setContentPane(panel);
	}

	private JPanel createOutputPanel()
	{
		//Create the navigation buttons
		firstPageButton = new JButton("First Page");
		prevPageButton = new JButton("Previous Page");
		nextPageButton = new JButton("Next Page");
		lastPageButton = new JButton("Last Page");
		firstPageButton.setEnabled(false);
		prevPageButton.setEnabled(false);
		nextPageButton.setEnabled(false);
		lastPageButton.setEnabled(false);

		//create a panel for the buttons and add them to it
		JPanel navButtonPanel = new JPanel(new GridLayout(0, 1));
		navButtonPanel.add(firstPageButton);
		navButtonPanel.add(prevPageButton);
		navButtonPanel.add(nextPageButton);
		navButtonPanel.add(lastPageButton);

		firstPageButton.addActionListener(buttonListener);
		prevPageButton.addActionListener(buttonListener);
		nextPageButton.addActionListener(buttonListener);
		lastPageButton.addActionListener(buttonListener);

		//Create the html scrollPane
		htmlAreaPane = new JEditorPane();
		JScrollPane htmlScrollPane = new JScrollPane(htmlAreaPane);
		htmlScrollPane.setVerticalScrollBarPolicy(
			JScrollPane.VERTICAL_SCROLLBAR_ALWAYS);
		htmlScrollPane.setPreferredSize(new Dimension(500, 275));

		//Create the output panel and it's layout objects
		GridBagLayout layout = new GridBagLayout();
		JPanel outputNavPanel = new JPanel(layout);
		GridBagConstraints layoutConstraints = new GridBagConstraints();

		//Set the layout for the scroll pane and add it
		layoutConstraints.weightx = 1.0;
		layoutConstraints.weighty = 1.0;
		layoutConstraints.fill = GridBagConstraints.BOTH;
		layout.setConstraints(htmlScrollPane, layoutConstraints);
		outputNavPanel.add(htmlScrollPane);

		//set the layout for the nav button panel and add it
		layoutConstraints.weightx = 0;
		layoutConstraints.weighty = 0;
		layoutConstraints.fill = GridBagConstraints.HORIZONTAL;
		layout.setConstraints(navButtonPanel, layoutConstraints);
		outputNavPanel.add(navButtonPanel);

		//put a border around the output and nav buttons
		outputNavPanel.setBorder(
			BorderFactory.createCompoundBorder(
				BorderFactory.createCompoundBorder(
					BorderFactory.createTitledBorder("Output"),
					BorderFactory.createEmptyBorder(5, 5, 5, 5)),
				outputNavPanel.getBorder()));

		return outputNavPanel;
	}

	private JPanel createMainPanel()
	{
		// Create the URL text field and label
		cmURL = new JTextField(CRNConnect.CM_URL.length() - 10);
		cmURL.setText(CRNConnect.CM_URL);
		cmURL.setEditable(false);

		//Put together a panel for the URL
		JPanel cmURLPanel = new JPanel();
		cmURLPanel.add(new JLabel("Server URL:"));
		cmURLPanel.add(cmURL);

		// Create the searchPath text field and label
		selectedSearchPath = new JTextField(CRNConnect.CM_URL.length()+15);
		//same as above
		selectedSearchPath.setText("");
		selectedSearchPath.setEditable(false);
		selectedSearchPath.setAutoscrolls(true);

		//Put together a panel for the search path
		JPanel searchPathPanel = new JPanel();
		//searchPathPanel.add(new JLabel("SearchPath:"));
		searchPathPanel.add(selectedSearchPath);

		//get the button panel
		JPanel buttonPanel = createMainButtonPanel();

		// create the main panel and add the components
		JPanel mainPanel = new JPanel(new GridLayout(3, 0));

		// Add everything to the main panel
		mainPanel.add(cmURLPanel);
		mainPanel.add(buttonPanel);
		mainPanel.add(searchPathPanel);

		return mainPanel;
	}

	private JPanel createMainButtonPanel()
	{
		// Create the button Panel
		JPanel buttonPanel = new JPanel();

		//Create and add the report output type combo box
		String repType[] =
			{
				REP_TYPE_HTML,
				REP_TYPE_HTMLFRAG,
				REP_TYPE_MHT,
				REP_TYPE_XML,
				REP_TYPE_PDF,
				REP_TYPE_CSV,
				REP_TYPE_XLWA };

		repTypeOption = new JComboBox(repType);
		repTypeOption.setSelectedItem(null);
		repTypeOption.addActionListener(new ReportTypeSelectionHandler());
		buttonPanel.add(repTypeOption, BorderLayout.WEST);

		// Create and add the select report combo box
		BaseClassWrapper listOfReports[] = getListOfReports(connect);
		repSelectOption = new JComboBox(listOfReports);
		repSelectOption.setSelectedItem(null);
		repSelectOption.addActionListener(new ReportSelectionHandler());
		buttonPanel.add(repSelectOption, BorderLayout.CENTER);

		//Create the bursting check box with text
		BurstCheckBox=new JCheckBox("Burst the report");
		BurstCheckBox.addActionListener(new BurstCheckBoxHandler());
		buttonPanel.add(BurstCheckBox, BorderLayout.EAST);

		// Create and add the Button
		runReportButton = new JButton("Execute Report");
		runReportButton.addActionListener(buttonListener);
		buttonPanel.add(runReportButton, BorderLayout.EAST);

		return buttonPanel;
	}

	private class MenuHandler implements ActionListener
	{
		public void actionPerformed(ActionEvent e)
		{
			if (e.getActionCommand().startsWith("http://"))
			{
				connect.connectionChange(e.getActionCommand());
			}
			try
			{
				JMenuItem menuClicked = (JMenuItem)e.getSource();
				if (menuClicked.getText() == "Exit")
				{
					System.exit(0);
				}
				if (menuClicked.getText() == "About")
				{
					JOptionPane.showMessageDialog(
						((JMenuItem)e.getSource()).getParent(),
						"IBM Cognos Sample Application\n\n"
							+ "Version 1.0.0\n"
							+ "This application uses the IBM Cognos Software Development Kit",
						"About IBM Cognos Samples",
						JOptionPane.INFORMATION_MESSAGE,
						new ImageIcon("../Common/about.gif"));
				}
				if (menuClicked.getText().compareTo("Overview") == 0)
				{
					JFrame explainWindow =
						new JFrame("Overview for Execute Report Sample");
					File explainFile =
						new File("Java_ExecReportsUI_Explain.html");
					if (!explainFile.exists())
					{
						JOptionPane.showMessageDialog(
							null,
							"Explain file not found");
						return;
					}
					URL explainURL =
						new URL("file:///" + explainFile.getAbsolutePath());
					JEditorPane explainPane = new JEditorPane();
					explainPane.setPage(explainURL);
					explainPane.setEditable(false);

					JScrollPane explainScroll =
						new JScrollPane(
							explainPane,
							JScrollPane.VERTICAL_SCROLLBAR_AS_NEEDED,
							JScrollPane.HORIZONTAL_SCROLLBAR_AS_NEEDED);
					explainWindow.getContentPane().add(explainScroll);
					explainWindow.setSize(640, 480);
					explainWindow.setVisible(true);
				}

			}
			catch (Exception ex)
			{}
		}
	}

	// The following is the button event handler.
	// Note: A SWITCH statement cannot be used here because we are comparing
	//       objects.
	private class allButtonsHandler implements ActionListener
	{
		private RunReport runReport = new RunReport();

		public void actionPerformed(ActionEvent e)
		{
			if (!Logon.loggedIn(connect))
			{
				try
				{
					sessionLogon.logon(connect);
				}
				catch (Exception logonException)
				{}
			}

			JButton buttonPressed = ((JButton)e.getSource());
			String output = new String();

			try
			{

				if ((buttonPressed == runReportButton)&&(canBeBursted==false))
				{
					//Run the selected report.
					output =
						runReport.runReport(
							connect,
							selectedReport,
							reportType,
							false);
				}
				else if((buttonPressed==runReportButton)&&(canBeBursted==true))
				{
					if(canBeBursted==true && (reportType==1||reportType==3))
					{
						if(reportType==1)
						{
							htmlAreaPane.setText("The requested format 'XML' does not support bursting");
							return;
						}
						else if(reportType==3)
						{
							htmlAreaPane.setText("The requested format 'CSV' does not support bursting");
							return;
						}
					}
					else
					{
						output =
							runReport.runReport(
								connect,
								selectedReport,
								reportType,
								canBeBursted);
					}
				}
				else if (buttonPressed == firstPageButton)
				{
					output = runReport.firstPage(selectedReport, reportType);
				}
				else if (buttonPressed == prevPageButton)
				{
					output = runReport.previousPage(selectedReport, reportType);
				}
				else if (buttonPressed == nextPageButton)
				{
					output = runReport.nextPage(selectedReport, reportType);
				}
				else if (buttonPressed == lastPageButton)
				{
					output = runReport.lastPage(selectedReport, reportType);
				}

				if (output.compareToIgnoreCase("Bursted") != 0) {

					firstPageButton.setEnabled(runReport.hasFirstPage());
					prevPageButton.setEnabled(runReport.hasPreviousPage());
					nextPageButton.setEnabled(runReport.hasNextPage());
					lastPageButton.setEnabled(runReport.hasLastPage());
				}
			}
			catch (java.rmi.RemoteException remoteEx)
			{
				htmlAreaPane.setContentType("text/html");
				output =
					"<html><head><title>"
						+ remoteEx.getMessage()
						+ "</title></head><body><pre>"
						+ remoteEx.toString()
						+ "</pre></body></html>";
				htmlAreaPane.setText(output);
				return;
			}

			if (output.compareTo("") != 0 && output.compareTo("Bursted")!=0)
			{
				try
				{
					if (   reportType == REP_TYPE_ENUM_HTML
						|| reportType == REP_TYPE_ENUM_HTMLFRAG
						|| reportType == REP_TYPE_ENUM_XML )
					{
					URL localOutputURL =
						new URL("file:///" + output);
					htmlAreaPane.setPage(localOutputURL);
					}
					else
					{
						htmlAreaPane.setContentType("text/html");
						output =
							"<html><head><title>"
								+ "IBM Cognos Sample -- Report Output"
								+ "</title></head><body>"
								+ "Output written to file: "
								+ output
								+ "</body></html>";
						htmlAreaPane.setText(output);
					}
				}
				catch (Exception ex)
				{
					System.out.println("Caught Exception: " + ex);
				}
			}
			else if(output.compareTo("Bursted")==0 && canBeBursted==true)
			{
				htmlAreaPane.setContentType("text/html");
				output =
					"<html><head><title>"
						+ "Burst Report"
						+ "</title></head><body><pre>"
						+ "The report has been successfully burst. Please check the email box for details."
						+ "</pre></body></html>";
				htmlAreaPane.setText(output);
			}
		}
	}

	// This is the reportType combo box event handler.
	private class ReportTypeSelectionHandler implements ActionListener
	{
		public void actionPerformed(ActionEvent repTypeSelectedEvent)
		{
			String chosenType = (String)repTypeOption.getSelectedItem();
			if (chosenType == REP_TYPE_HTML)
			{
				reportType = REP_TYPE_ENUM_HTML;
			}
			else if (chosenType == REP_TYPE_XML)
			{
				reportType = REP_TYPE_ENUM_XML;
			}
			else if (chosenType == REP_TYPE_PDF)
			{
				reportType = REP_TYPE_ENUM_PDF;
			}
			else if (chosenType == REP_TYPE_CSV)
			{
				reportType = REP_TYPE_ENUM_CSV;
			}
			else if (chosenType == REP_TYPE_HTMLFRAG)
			{
				reportType = REP_TYPE_ENUM_HTMLFRAG;
			}
			else if (chosenType == REP_TYPE_MHT)
			{
				reportType = REP_TYPE_ENUM_MHT;
			}
			else if (chosenType == REP_TYPE_XLWA)
			{
				reportType = REP_TYPE_ENUM_XLWA;
			}
			else
			{
				//error, force HTML (default) ??
				reportType = REP_TYPE_ENUM_HTML;
			}
		}
	}

	private class ReportSelectionHandler implements ActionListener
	{
		public void actionPerformed(ActionEvent repSelectedEvent)
		{
			selectedReport =
				(BaseClassWrapper)repSelectOption.getSelectedItem();
			selectedSearchPath.setText(
				selectedReport.getBaseClassObject().getSearchPath().getValue());

			//Check whether the selected report can be burst
			AuthoredReport repProp=(AuthoredReport)selectedReport.getBaseClassObject();
			BooleanProp canBeBurstedProp=repProp.getCanBurst();
			boolean burstStatusChk=canBeBurstedProp.isValue();
			if(!burstStatusChk)
			{
				canBeBursted=false;
				BurstCheckBox.setSelected(false);
				BurstCheckBox.setEnabled(false);
				htmlAreaPane.setText("The report - '"+selectedReport.toString()+"' cannot be burst.");
			}
			else
			{
				BurstCheckBox.setEnabled(true);
				htmlAreaPane.setText("");
			}
		}
	}


	private class BurstCheckBoxHandler implements ActionListener
	{
		public void actionPerformed(ActionEvent bstCheckBoxSelectedEvent)
		{
			Object[]selectedCheckBox=BurstCheckBox.getSelectedObjects();
			if(selectedCheckBox!=null && selectedCheckBox.length==1)
			{
				canBeBursted=true;
			}
			else
			{
				canBeBursted=false;
			}
		}
	}


	//This is a method for retrieving a list of the available reports to run
	protected BaseClassWrapper[] getListOfReports(CRNConnect connection)
	{
		BaseClassWrapper reportAndQueryList[] = null;
		BaseClass reports[] = new BaseClass[0];
		BaseClass queries[] = new BaseClass[0];
		int reportAndQueryIndex = 0;
		int reportIndex = 0;
		int queryIndex = 0;

		if (connection == null)
		{
			System.out.println(
				"Invalid parameter passed to getListOfReports()\n");
			return null;
		}

		PropEnum props[] =
			new PropEnum[] { PropEnum.searchPath, PropEnum.defaultName, PropEnum.canBurst, PropEnum.routingServerGroup };
		Sort sortOptions[] = { new Sort()};
		sortOptions[0].setOrder(OrderEnum.ascending);
		sortOptions[0].setPropName(PropEnum.defaultName);

		if (!Logon.loggedIn(connect))
		{
			try
			{
				sessionLogon.logon(connect);
			}
			catch (Exception logonException)
			{}
		}
		try
		{
			SearchPathMultipleObject reportsPath = new SearchPathMultipleObject("/content//report");
			SearchPathMultipleObject queriesPath = new SearchPathMultipleObject("/content//query");
			reports =
				connection.getCMService().query(
					reportsPath,
					props,
					sortOptions,
					new QueryOptions());
			queries =
				connection.getCMService().query(
					queriesPath,
					props,
					sortOptions,
					new QueryOptions());
		}
		catch (java.rmi.RemoteException remoteEx)
		{
			System.out.println("Caught Remote Exception:\n");
			remoteEx.printStackTrace();
		}
		//TODO
		// a java.io.InterruptedIOException here could trigger a retry...

		reportAndQueryList =
			new BaseClassWrapper[reports.length + queries.length];

		if ((reports != null) && (reports.length > 0))
		{
			for (reportIndex = 0; reportIndex < reports.length; reportIndex++)
			{
				reportAndQueryList[reportAndQueryIndex++] =
					new BaseClassWrapper(reports[reportIndex]);
			}
		}
		if ((queries != null) && (queries.length > 0))
		{
			for (queryIndex = 0; queryIndex < queries.length; queryIndex++)
			{
				reportAndQueryList[reportAndQueryIndex++] =
					new BaseClassWrapper(queries[queryIndex]);
			}
		}
		return reportAndQueryList;
	}

	// Create the main method to execute the application.
	public static void main(String args[])
	{
		CRNConnect connection = new CRNConnect();
		connection.connectToCognosServer();
		sessionLogon = new Logon();
		String output = "";

		while (!Logon.loggedIn(connection))
		{
			output = sessionLogon.logon(connection);
			if (!Logon.loggedIn(connection))
			{
				int retry =
					JOptionPane.showConfirmDialog(
						null,
						"Login Failed. Please try again.",
						"Login Failed",
						JOptionPane.OK_CANCEL_OPTION);
				if (retry != JOptionPane.OK_OPTION)
				{
					System.exit(0);
				}
			}

		}

		ExecReportsUI frame =
			new ExecReportsUI("IBM Cognos Sample", connection);

		// Create a WindowAdapter so the application
		// is exited when the window is closed.
		frame.addWindowListener(new WindowAdapter()
		{
			public void windowClosing(WindowEvent e)
			{
				System.exit(0);
			}
		});

		frame.htmlAreaPane.setText(
			output + System.getProperty("line.separator"));

		// Set the size of the frame and display it.
		frame.setSize(640, 480);
		frame.setVisible(true);
		frame.setResizable(true);

	}

}