analytics/sdk/java/PrintReport/PrintUI.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.
*/
/**
 * PrintUI.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.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.JTextArea;
import javax.swing.JTextField;

import com.cognos.developer.schemas.bibus._3.BaseClass;
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 PrintUI extends JFrame
{
	private CRNConnect connect;
	private CSHandlers csHandler = new CSHandlers();

	// The following variables represent the dialog components.
	private JTextArea textAreaPane;
	private JTextField cmURL;
	private JButton sampleOptionButton;
	private JComboBox sampleOption;
	private JComboBox repSelectOption;

	private static Logon sessionLogon;

	private static final String GETAVAILABLEPRINTERS = "getAvailablePrinters";
	private static final String ADDPRINTER = "addPrinter";
	private static final String DELETEPRINTER = "deletePrinter";
	private static final String CHANGEPRINTERNAME = "changePrinterName";
	private static final String CHANGEPRINTERADDRESS = "changePrinterAddress";
	private static final String STARTPRINT = "startPrint";

	private static String selectedSampleOption = GETAVAILABLEPRINTERS;

	private static BaseClassWrapper bcReport = null;

	// This is the constructor.
	public PrintUI(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()
	{
		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());

		JPanel mainPanel = new JPanel(new GridLayout(2, 0));
		// create a cmURL panel
		JPanel cmURLPanel = new JPanel();

		// Add the URL text field and label
		cmURL = new JTextField(CRNConnect.CM_URL.length() + 10);
		cmURL.setText(CRNConnect.CM_URL);
		cmURL.setEditable(false);
		cmURLPanel.add(new JLabel("Server URL:"), BorderLayout.WEST);
		cmURLPanel.add(cmURL, BorderLayout.EAST);

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

		//Create and add the report output type combo box
		String optionType[] =
			{
				GETAVAILABLEPRINTERS,
				ADDPRINTER,
				DELETEPRINTER,
				CHANGEPRINTERNAME,
				CHANGEPRINTERADDRESS,
				STARTPRINT };
		sampleOption = new JComboBox(optionType);
		sampleOption.setSelectedItem(null);
		sampleOption.addActionListener(new sampleOptionSelectionHandler());
		buttonPanel.add(sampleOption, 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 and add the Button
		sampleOptionButton = new JButton("Run Option");
		sampleOptionButton.addActionListener(new allButtonsHandler());
		buttonPanel.add(sampleOptionButton, BorderLayout.EAST);

		// Add the status text pane.
		textAreaPane = new JTextArea();

		// Add the panels to the mainPanel
		mainPanel.add(cmURLPanel);
		mainPanel.add(buttonPanel);
		mainPanel.add(textAreaPane);

		//Add the ScrollPane to outputPanel
		JScrollPane areaScrollPane = new JScrollPane(textAreaPane);
		areaScrollPane.setVerticalScrollBarPolicy(
			JScrollPane.VERTICAL_SCROLLBAR_ALWAYS);
		areaScrollPane.setPreferredSize(new Dimension(300, 275));
		areaScrollPane.setBorder(
			BorderFactory.createCompoundBorder(
				BorderFactory.createCompoundBorder(
					BorderFactory.createTitledBorder("Output"),
					BorderFactory.createEmptyBorder(5, 5, 5, 5)),
				areaScrollPane.getBorder()));

		JPanel outputPanel = new JPanel(new GridLayout(0, 1));
		outputPanel.add(areaScrollPane);

		JPanel panel = new JPanel(new BorderLayout());
		panel.add(mainPanel, BorderLayout.NORTH);
		panel.add(outputPanel);

		setContentPane(panel);
	}

	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 Print Report Sample");
					File explainFile = new File("Java_PrintUI_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
	{
		public void actionPerformed(ActionEvent e)
		{
			if (!Logon.loggedIn(connect))
			{
				try
				{
					sessionLogon.logon(connect);
				}
				catch (Exception logonException)
				{
					textAreaPane.setText("");
					textAreaPane.append("Login Failed. Please try again.\n");
					return;
				}
			}

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

			if (buttonPressed == sampleOptionButton)
			{
				Print printObj = new Print();
				if (selectedSampleOption.compareTo(GETAVAILABLEPRINTERS) == 0)
				{
					BaseClass[] printers =
						printObj.getAvailablePrinters(connect);
					if (printers.length <= 0)
					{
						textAreaPane.setText("");
						textAreaPane.append(
							"There are no printers available.\n");
						return;
					}
					else
					{
						output = "List of Available Printers:\n\n";
						for (int i = 0; i < printers.length; i++)
						{
							output += "\tName: "
								+ printers[i].getDefaultName().getValue()
								+ "\n";
							output += "\tPath: "
								+ printers[i].getSearchPath().getValue()
								+ "\n\n";
						}
					}
				}
				else if (selectedSampleOption.compareTo(ADDPRINTER) == 0)
				{
					String printerName =
						JOptionPane.showInputDialog(
							"Please enter a name for the new printer.");
					String printerAddress =
						JOptionPane.showInputDialog(
							"Please enter a valid Network Address for the new printer.");
					if ((printerName != null) && (printerAddress != null))
					{
						output =
							printObj.addPrinter(
								connect,
								printerName,
								printerAddress);
					}
					else
					{
						output = "Action cancelled.";
					}
				}
				else if (selectedSampleOption.compareTo(DELETEPRINTER) == 0)
				{
					BaseClass[] printers =
						printObj.getAvailablePrinters(connect);
					if (printers.length <= 0)
					{
						textAreaPane.setText("");
						textAreaPane.append(
							"There are no printers available.\n");
						return;
					}
					else
					{
						String possibleValues[] = new String[printers.length];
						for (int i = 0; i < printers.length; i++)
						{
							possibleValues[i] =
							printers[i].getDefaultName().getValue();
						}
						//Display a prompt asking the user to select a printer.
						Object selectedValue =
							JOptionPane.showInputDialog(
								null,
								"Please choose a printer",
								"Choose Printer",
								JOptionPane.INFORMATION_MESSAGE,
								null,
								possibleValues,
								possibleValues[0]);


						String printerName=(String)selectedValue;

						int proceed =
							JOptionPane.showConfirmDialog(
								null,
								"The printer '"
									+ printerName
									+ "' will be deleted.");
						if (proceed == JOptionPane.YES_OPTION)
						{
							output =
								printObj.deletePrinter(
									connect,
									printerName);
						}
						else
						{
							output = "Action cancelled.";
						}
					}
				}
				else if (
					selectedSampleOption.compareTo(CHANGEPRINTERNAME) == 0)
				{
					BaseClass[] printers =
						printObj.getAvailablePrinters(connect);
					if (printers.length <= 0)
					{
						textAreaPane.setText("");
						textAreaPane.append(
							"There are no printers available.\n");
						return;
					}
					else
					{
						String possibleValues[] = new String[printers.length];
						for (int i = 0; i < printers.length; i++)
						{
							possibleValues[i] =
							printers[i].getDefaultName().getValue();
						}
						//Display a prompt asking the user to select a printer.
						Object selectedValue =
							JOptionPane.showInputDialog(
								null,
								"Please choose a printer",
								"Choose Printer",
								JOptionPane.INFORMATION_MESSAGE,
								null,
								possibleValues,
								possibleValues[0]);

						String printerName=(String)selectedValue;

						String newPrinterName =
							JOptionPane.showInputDialog(
								"Please enter a new printer name for "
									+ printerName);
						if (newPrinterName != null)
						{
							output =
								printObj.changePrinterName(
									connect,
									printerName,
									newPrinterName);
						}
						else
						{
							output = "Action cancelled.";
						}
					}
				}
				else if (
					selectedSampleOption.compareTo(CHANGEPRINTERADDRESS) == 0)
				{
					BaseClass[] printers =
						printObj.getAvailablePrinters(connect);
					if (printers.length <= 0)
					{
						textAreaPane.setText("");
						textAreaPane.append(
							"There are no printers available.\n");
						return;
					}
					else
					{
						String possibleValues[] = new String[printers.length];
						for (int i = 0; i < printers.length; i++)
						{
							possibleValues[i] =
							printers[i].getDefaultName().getValue();
						}
						//Display a prompt asking the user to select a printer.
						Object selectedValue =
							JOptionPane.showInputDialog(
								null,
								"Please choose a printer",
								"Choose Printer",
								JOptionPane.INFORMATION_MESSAGE,
								null,
								possibleValues,
								possibleValues[0]);

						String printerName=(String)selectedValue;

						String newPrinterAddress =
							JOptionPane.showInputDialog(
								"Please enter a new printer address for "
									+ printerName);
						if (newPrinterAddress != null)
						{
							output =
								printObj.changePrinterAddress(
									connect,
									printerName,
									newPrinterAddress);
						}
						else
						{
							output = "Action cancelled";
						}
					}
				}
				else if (selectedSampleOption.compareTo(STARTPRINT) == 0)
				{

					try
					{
						BaseClass[] printers =
							printObj.getAvailablePrinters(connect);
						String possibleValues[] = new String[printers.length];
						String printerPath = new String();
						String reportPath = new String();
						for (int i = 0; i < printers.length; i++)
						{
							possibleValues[i] =
								printers[i].getDefaultName().getValue();
						}
						//Display a prompt asking the user to select a printer.
						Object selectedValue =
							JOptionPane.showInputDialog(
								null,
								"Please choose a printer",
								"Choose Printer",
								JOptionPane.INFORMATION_MESSAGE,
								null,
								possibleValues,
								possibleValues[0]);

						//Get the searchPath for the selected printer.
						for (int i = 0; i < printers.length; i++)
						{
							if (((String)selectedValue)
								.equals(
									printers[i].getDefaultName().getValue()))
							{
								printerPath =
									printers[i].getSearchPath().getValue();
								break;
							}
						}
						printObj.print(
							connect,
							bcReport,
							printerPath,
							null);
					}
					catch (Exception ex)
					{
						System.out.println(ex.getMessage());
						output =
							"Print Report:\nAn error occurred\nMake sure a "
								+ "Report Name is selected and IBM Cognos is running";
					}
				}
			}
			if (output.compareTo("") != 0)
			{
				textAreaPane.setText("");
				textAreaPane.append(output);
			}
		}
	}

	private class ReportSelectionHandler implements ActionListener
	{
		public void actionPerformed(ActionEvent repSelectedEvent)
		{
			bcReport = (BaseClassWrapper)repSelectOption.getSelectedItem();
		}
	}

	private class sampleOptionSelectionHandler implements ActionListener
	{
		public void actionPerformed(ActionEvent optionSelectedEvent)
		{
			selectedSampleOption = (String)sampleOption.getSelectedItem();
		}
	}

//	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 };
		  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
		  {
			  reports =
				  connection.getCMService().query(
					  new SearchPathMultipleObject("/content//report"),
					  props,
					  sortOptions,
					  new QueryOptions());
			  queries =
				  connection.getCMService().query(
					  new SearchPathMultipleObject("/content//query"),
					  props,
					  sortOptions,
					  new QueryOptions());
		  }
		  catch (java.rmi.RemoteException remoteEx)
		  {
			  System.out.println("Caught Remote Exception:\n");
			  remoteEx.printStackTrace();
		  }

		  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);
				}
			}

		}

		PrintUI frame = new PrintUI("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.textAreaPane.setText(output);

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

	}

}