analytics/sdk/java/CreateDrillThrough/DrillThroughUI.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.
*/
/**
 * DrillThroughUI.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 java.util.Hashtable;

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;

public class DrillThroughUI extends JFrame {

	private CRNConnect connect;

	private static DrillThroughUI frame;

	// The following variables represent the dialog components.
	private JTextArea textAreaPane;

	private JTextField cmURL;

	private JButton createDefinitionButton;

	private JComboBox packageOption;

	private static Logon sessionLogon;

	private BaseClassWrapper chosenPackage = null;

	DrillThrough newDrillThrough = new DrillThrough();

	ReportParameters newReportParameters = new ReportParameters();

	BaseReportAndParameters ReportAndPara = new BaseReportAndParameters();

	// This is the constructor.
	public DrillThroughUI(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 = createMainPanel();
		JPanel outputNavPanel = createOutputPanel();
		JPanel panel = new JPanel(new BorderLayout());
		panel.add(mainPanel, BorderLayout.NORTH);
		panel.add(outputNavPanel);

		setContentPane(panel);
	}

	private JPanel createOutputPanel() {
		// Add the status text pane.
		textAreaPane = new JTextArea();

		// Add the ScrollPane to outputPanel
		JScrollPane areaScrollPane = new JScrollPane(textAreaPane);
		areaScrollPane
				.setVerticalScrollBarPolicy(JScrollPane.VERTICAL_SCROLLBAR_ALWAYS);
		areaScrollPane.setPreferredSize(new Dimension(500, 275));

		//Create the output panel and it's layout objects
		GridBagLayout layout = new GridBagLayout(); //GridLayout(0, 1)
		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(areaScrollPane, layoutConstraints);
		outputNavPanel.add(areaScrollPane);

		outputNavPanel.setBorder(BorderFactory.createCompoundBorder(
				BorderFactory.createCompoundBorder(BorderFactory
						.createTitledBorder("Output"), BorderFactory
						.createEmptyBorder(5, 5, 5, 5)), outputNavPanel
						.getBorder()));

		return outputNavPanel;
	}

	private JPanel createMainPanel() {
		// Add 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);

		//get dropdown box and button panel
		JPanel optionButtonPanel = createMainButtonPanel();

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

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

		return mainPanel;
	}

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

		// Create and add the package output type combo box
		BaseClassWrapper[] packageList = ReportAndPara
				.getListOfPackages(connect);
		packageOption = new JComboBox(packageList);
		packageOption.setSelectedItem(null);
		packageOption.addActionListener(new packageSelectionHandler());
		buttonPanel.add(new JLabel("Package Options:"), BorderLayout.WEST);
		buttonPanel.add(packageOption, BorderLayout.WEST);

		// Create and add the Button
		createDefinitionButton = new JButton("Create Drill-through definition");
		createDefinitionButton.addActionListener(new allButtonsHandler());
		buttonPanel.add(createDefinitionButton, BorderLayout.EAST);

		return buttonPanel;
	}

	// handle menu bar buttons
	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 Drill-through Definition Sample");
					File explainFile = new File(
							"Java_DrillThroughUI_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.
	private class allButtonsHandler implements ActionListener {
		public void actionPerformed(ActionEvent e) {
			if (!Logon.loggedIn(connect)) {
				try {
					sessionLogon.logon(connect);
				} catch (Exception logonException) {
					System.out.println("The error: "
							+ logonException.getMessage());
				}
			}

			JButton buttonPressed = ((JButton) e.getSource());

			if (buttonPressed == createDefinitionButton) {

				textAreaPane.setText("");
				if (chosenPackage != null) {
					String searchPath = null;
					searchPath = "/content/folder[@name='Samples']/folder[@name='Models']/package[@name='"
							+ chosenPackage.toString() + "']//report";

					Hashtable reportWithPara = ReportAndPara
							.hashReportNameAndPara(connect, searchPath);

					if (reportWithPara != null) {

						BaseClassWrapper[] reportList = ReportAndPara
								.getReports(reportWithPara);

						if (reportList != null && reportList.length > 0) {
							Object selectedReport = JOptionPane
									.showInputDialog(null, null,
											"Select the target report",
											JOptionPane.INFORMATION_MESSAGE,
											null, reportList, null);

							BaseClassWrapper chosenReport = (BaseClassWrapper) selectedReport;

							if (selectedReport != null) {
								String inputValue = null;
								do {
									inputValue = JOptionPane
											.showInputDialog(
													null,
													"Name:",
													"Specify a name - New Drill-through Definition",
													3);
									if (inputValue == null) {
										return;
									}

								} while (inputValue.length() == 0);

								if (inputValue != null
										&& inputValue.length() > 0) {

									String rs = newDrillThrough
											.createDrillThroughDefinition(
													connect, inputValue,
													chosenPackage,
													chosenReport,
													reportWithPara);
									packageOption.setSelectedItem(null);
									if (rs != null) {
										textAreaPane
												.setText("The Drill-through definition '"
														+ inputValue
														+ "' has been created successfully in the content store"
														+ "\n"
														+ "The Event ID:"
														+ "\n" + "    " + rs);
									} else {
										textAreaPane
												.setText("Failed to create the Drill-through definition in the content store");
									}
								}
							} else {
								packageOption.setSelectedItem(null);
								textAreaPane.setText("");
							}
						} else {
							JOptionPane.showMessageDialog(null, "No entries",
									"Select the target report",
									JOptionPane.INFORMATION_MESSAGE);
						}

					} else {
						packageOption.setSelectedItem(null);
						textAreaPane
								.setText("Error getting report parameters."
										+ "\nPlease see the console windows for details.");
					}
				} else {
					JOptionPane.showMessageDialog(null,
							"Please select a package.",
							"Select package", JOptionPane.INFORMATION_MESSAGE);
				}
			}
		}
	}

	// This is the package select combo box event handler.
	private class packageSelectionHandler implements ActionListener {
		public void actionPerformed(ActionEvent packageTypeSelectedEvent) {
			textAreaPane.setText("");
			chosenPackage = (BaseClassWrapper) packageOption.getSelectedItem();
		}
	}

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

		sessionLogon = new Logon();
		String logonOutput = "";

		while (!Logon.loggedIn(connection)) {
			logonOutput = 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);
				}
			}
		}

		frame = new DrillThroughUI("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(logonOutput);

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