analytics/sdk/java/ReportSpec/EditReportSpecUI.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.
*/
/**
 * EditReportSpecUI.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.GridBagLayout;
import java.awt.GridBagConstraints;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.awt.event.WindowAdapter;
import java.awt.event.WindowEvent;
import java.util.Vector;

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.AsynchDetailReportObject;
import com.cognos.developer.schemas.bibus._3.AsynchReply;
import com.cognos.developer.schemas.bibus._3.BaseClass;
import com.cognos.developer.schemas.bibus._3.Option;
import com.cognos.developer.schemas.bibus._3.OrderEnum;
import com.cognos.developer.schemas.bibus._3.ParameterValue;
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.SearchPathSingleObject;
import com.cognos.developer.schemas.bibus._3.Sort;

// This Java class extends the JFrame class so that you can 
// display a window.
public class EditReportSpecUI extends JFrame
{
	private CRNConnect connect;
	private CSHandlers csh = new CSHandlers();

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

	private static Logon sessionLogon;
	private static BaseClassWrapper selectedReport = null;

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

		//Create the html scrollPane
		textAreaPane = new JTextArea();
		JScrollPane textScrollPane = new JScrollPane(textAreaPane);
		textScrollPane.setVerticalScrollBarPolicy(
			JScrollPane.VERTICAL_SCROLLBAR_ALWAYS);
		textScrollPane.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(textScrollPane, layoutConstraints);
		outputNavPanel.add(textScrollPane);
		
		//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()
	{
		// 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);
		
		// Create the searchPath text field and label
		selectedSearchPath = new JTextField(CRNConnect.CM_URL.length() - 10); //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 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
		editReportSpecButton = new JButton("Edit Report");
		editReportSpecButton.addActionListener(new allButtonsHandler());
		buttonPanel.add(editReportSpecButton, 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 Edit Report Specification Sample");
					File explainFile = new File("Java_EditReportSpecUI_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)
				{}
			}

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

			if (buttonPressed == editReportSpecButton)
			{
				try
				{
					EditReportSpec editReport = new EditReportSpec();
					String reportSpec =
						editReport.getReportSpec(connect, selectedReport);
					if ((reportSpec == null) || (reportSpec == ""))
					{
						output = "Edit Report:\nAn error occurred retrieving the specification for the selected report.";
					}
					else
					{
						output = editSpec(connect, selectedReport, reportSpec);
					}
				}
				catch (Exception ex)
				{
					System.out.println(ex.getMessage());
					ex.printStackTrace();
					output =
						"Edit 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)
		{
			selectedReport = (BaseClassWrapper) repSelectOption.getSelectedItem();
			if (selectedReport != null)
			{
				selectedSearchPath.setText(selectedReport.getBaseClassObject().getSearchPath().getValue());
				return;
			}
			selectedSearchPath.setText("");
		}
	}

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

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

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

		if (!Logon.loggedIn(connection))
		{
			try
			{
				sessionLogon.logon(connection);
			}
			catch (Exception logonException)
			{}
		}
		try
		{
			reports =
				connection.getCMService().query(
					new SearchPathMultipleObject("/content//report"),
					props,
					sortOptions,
					new QueryOptions());
		}
		catch (java.rmi.RemoteException remoteEx)
		{
			System.out.println("Caught Remote Exception:\n");
			remoteEx.printStackTrace();
		}

		reportList = new BaseClassWrapper[reports.length];

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

	/** 
		* This java method is used to display a simple dialog box for 
		* removing column and adding columns to a simple list report. 
		* There is also a button to modify a column title.
		* 
		* @param connection   Connection to Server.
		* @param report       Specifies a report object.
		* @param reportSpec   Specifies a report specification XML document.
		*/
	public String editSpec(CRNConnect connection, BaseClassWrapper oldReport, String reportSpec)
	{
		String output = "";
	
		String packageName = getPackageSearchPath(connection, oldReport);

		// Create a new report object which uses DOM to traverse the 
		// report specification.
		ReportObject newReport =
			new ReportObject(connect, packageName, reportSpec);

		// Use the existing report specification to extract 
		// all necessary information.
		// Get column names, expressions and titles
		Vector selectedDisplayColumns = newReport.getColumnNames();
		Vector selectedColumnExpression = newReport.getColumnExpressions();
		Vector selectedColumnTitles = newReport.getColumnTitles();

		// Keep the original list of columns, expression, and titles 
		// for comparision after changes are made.
		Vector originalColumnExpression =
			(Vector)selectedColumnExpression.clone();
		Vector originalColumnReference = (Vector)selectedDisplayColumns.clone();
		Vector originalColumnTitles = (Vector)selectedColumnTitles.clone();

		Vector columnTitleToChange = new Vector();
		Vector columnTitleNewName = new Vector();

		// Return the existing metadata of the package to display 
		// in the Report Wizard dialog box.
		MetaData md = new MetaData();
		Vector packageMetaData = md.parseMetaData(connection, newReport, packageName);

		// Get the package metadeta and the columns already in the report.
		ReportWizardDialog dialog =
			new ReportWizardDialog(
				null,
				"Report Wizard",
				true,
				packageMetaData,
				selectedDisplayColumns,
				selectedColumnExpression,
				selectedColumnTitles,
				columnTitleToChange,
				columnTitleNewName,
				true);

		dialog.setVisible(true);

		// Modify the column titles.
		newReport.modifyColumnTitles(columnTitleToChange, columnTitleNewName);

		// Compare the list of original columns to the list of new ones 
		// and add or remove columns where appropriate.
		newReport.modifyColumns(
			originalColumnExpression,
			originalColumnReference,
			originalColumnTitles,
			selectedColumnExpression,
			selectedColumnTitles);

		// Add the xmlns namespace back into the report specification 
		// before updating Content Manager.
		newReport.updateReportNS();
		newReport.saveReport(connection, oldReport.getBaseClassObject().getParent().getValue()[0], oldReport.toString());
		newReport.renderReport(connection, oldReport.getBaseClassObject().getSearchPath().getValue());
		output = "Report: " + oldReport + " updated successfully";
		return output;
	}
	
	
	public String getPackageSearchPath(CRNConnect connection, BaseClassWrapper report){
		
		String reportSearchPath = report.getSearchPath();
		String packagePath = "";
		
		try{
			AsynchReply response = connection.getReportService().query(new SearchPathSingleObject(reportSearchPath), new ParameterValue[] {}, new Option[] {});
			
			for (int i = 0; i < response.getDetails().length; i++)
			{
				if (response.getDetails()[i] instanceof AsynchDetailReportObject)

				{
					packagePath = ((AsynchDetailReportObject)response.getDetails()[i]).getReport().getMetadataModel().getValue()[0].getSearchPath().getValue();
				}
			}

			
			return packagePath;
		}
		
		catch (Exception e)
		{
			System.out.println(
				"An error occurred in the getPackageSearchPath Java method.\n" + e);
			return "An error occurred in the getPackageSearchPath Java method.";
		}
		

//		return packagePath;
	}

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

		}

		EditReportSpecUI frame = new EditReportSpecUI("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(640, 480);
		frame.setVisible(true);
		frame.setResizable(true);
	}
	

}