returnattributesdisplay.java

JAVA开源LDAP浏览器jxplorer的源码!

package com.ca.directory.jxplorer.search;

import java.awt.*;
import java.awt.event.*;
import java.awt.print.*;
import java.util.*;
import java.util.logging.Logger;
import java.util.logging.Level;
import java.io.*;
import javax.swing.*;
import javax.swing.table.*;
import javax.naming.*;
import javax.naming.directory.*;

import com.ca.commons.cbutil.*;
import com.ca.directory.jxplorer.*;
import com.ca.commons.naming.*;
import com.ca.directory.jxplorer.tree.SmartTree;

/**
*	This class is currently called from the Search GUI when the user has requested that certain
*	attributes are returned in the search.  
*	<p>
*	The way it is <i>intended</i> to work is the <code>SearchGUI</code> creates a <code>ReturnAttributesDisplay</code> 
*	object by calling the constructor.  The constructor does nothing more than registers two global variables.  
*	The creator of the object is expected to register a DataSource via the <code>registerDataSource</code> method  
*	so that this object is added to it as a <code>DataListener</code>. 
*	<p>
*	When the search returns, all the <code>DataListener</code> objects are notified with the results of the search 
*	(hense this class) via the <code>dataReady</code> method.  The <code>dataReady</code> method calls the 
*	<code>displaySearchResult</code> method which extracts the attribute values from the search results.
*	It is this method that creates a static <code>ReturnAttributesGUI</code> which displays the results in a 
*	table.  Only one copy of <code>ReturnAttributesGUI</code> is initiated.  If one is already open when a
*	search result is received we just reset the data in it's table.
*/
public class ReturnAttributesDisplay 
	implements DataListener
{
    private static Logger log = Logger.getLogger(ReturnAttributesDisplay.class.getName());

    /**
     * The owning frame.
     */
	private JXplorer jx;

    /**
     * Where we get the search results from.
     */
	private DataSource dataSource = null;

    /**
     * Returned attribute values (populates the table).
     */
	private Object[][] tableData = null;

    /**
     * Return attributes (is used for table header).
     */
	private String[] tableHeader = null;

   /**
	*  	Because this isn't modal, the user might 'lose' it behind the 
	*  	main gui or something.  Since we only ever want one of these,
	*  	we'll simply reuse a single object, and make sure it's visible
	*  	when we need it. 
	*/
	private static 	ReturnAttributesGUI gui = null;

   /**
    *	Constructor that does nothing more than register the params as global 
	*	variables.
	*	@param jx the owing frame.
	*	@param tableHeader contains a list of attributes that the user wants returned (is used as the table header).
	*/
	public ReturnAttributesDisplay(JXplorer jx, String[] tableHeader)
	{			
		this.tableHeader = tableHeader;		  
		this.jx = jx;
	}

   /**
    *	Registers a given DataSource and notifies it that this class is
	*	a DataListener.
	*	@param ds the DataSource to be registered.
	*/
	public void registerDataSource(DataSource ds)
	{
		dataSource = ds;
		dataSource.addDataListener(this);
	}

   /**
	*  	This is the data listener interface - this method is called when a (Search) data query is finished
	*  	by a Broker.  
	*	@param result the search result.
	*/
    public void dataReady(DataQuery result)
    {
        int type = result.getType();

        if (result.hasException())
        {
            CBUtility.error("Unable to perform " + result.getTypeString() + " operation.", result.getException());
            return;
        }
        else
        {
            // Make sure we are dealing with a search result...
            if (type == DataQuery.SEARCH)
				displaySearchResult(result); 
        }
    }	
		
   /**
   	*	This method basically takes the search result and extracts the attribute
	*	values then populates a two-dimensional array with these values.  The
	*	array is used to initiate the JTable that is used in the gui.  
	*	@param result the search result.
	*/
    protected void displaySearchResult(DataQuery result)
    {	
		HashMap map = new HashMap(0);		
		
        try		
        {	
			DXNamingEnumeration myResults = result.getEnumeration();
			
			Object[] searchResults = myResults.toArray();

			int rows = searchResults.length;
			int cols = tableHeader.length;

			if (rows == 0)
			{
                // Nothing returned in the search so init the array with no values...
				tableData = new Object[0][0];
			}
			else
			{
                // Add the attribute value to the array - if no value exists add an empty string...
				tableData = new Object[rows][cols];

				String dn = "";
                Attribute att = null;
				String header = "";

                // Keep track of the position of the [DN] header.  It needs to be replaced with something more useful...
                int includeDNPos = -1;

				for (int i = 0; i < rows; i++)
				{
					for (int j = 0; j < cols; j++)
					{
						Attributes atts = ((SearchResult) searchResults[i]).getAttributes();

                        // Get the DN...
						dn = ((SearchResult) searchResults[i]).getName();

                        // Get the attribute from the results...
                        att = atts.get(tableHeader[j]);

                        // An attribute should look something like 'cn: Fred' so we need to substring
                        // it to just 'Fred' in the process of adding it to the array.  However, we first
                        // need to check that the header item isn't the include DN flage: [DN].  If it is
                        // the value will be the DN.
                        if(tableHeader[j].equalsIgnoreCase(ReturnAttributesDialog.INCLUDE_DN))
                        {
                            includeDNPos = j;
                            tableData[i][j] = dn;
                        }
                        else if(att == null)
                        {
                            tableData[i][j] = "";
                        }
                        else
                        {
                            header = att.toString();
                            tableData[i][j] = header.substring(header.indexOf(":") + 2);
                        }
					}

                    // Add the row number and the DN of the entry it represents...
					map.put(String.valueOf(i), dn);
				}

                // Only after we have finished processing the list, can we change the name of the DN header if needed...
                if(includeDNPos > -1)
                    tableHeader[includeDNPos] = "DN";
			}
			
			if (tableData==null || tableHeader==null)
			{
				log.warning("Problem retrieving the search results for the Return Attributes display");
				return;				
			}

			if (gui == null)			
			{
                // Only create one gui...
				gui = new ReturnAttributesGUI(tableData, tableHeader, rows, map);
			}
			else
			{
                // If one exists just set the data...
				gui.setTableData(tableData, tableHeader, rows, map);
			    gui.setVisible(true); 		
			}		
	    }
	    catch (NamingException e)
	    {
	        result.setException(e);  	// XXX set the exception on the result object, let someone else handle it.
	    }
	    catch (ClassCastException ee)
	    {
	    	log.log(Level.WARNING, "Casting problem in return attribute display ", ee);
	    }
		
		// Because we make a new ReturnAttributeDisplay each time a search is done - but only keep
		// one GUI floating around...make sure the data listener is removed after the search
		// result has been processed - otherwise the gui will try to display all previous search
		// results and everything falls over in a heap.  In otherwords - DON'T remove this...
		dataSource.removeDataListener(this);
    }	

   /**
    *	Class that sets up a dialog that displays the given data in a table.  The dialog
	*	has a print button that prints this table.
	*	@author Trudi	
	*/
	class ReturnAttributesGUI extends JDialog implements Printable
	{
		JTable 					table;
		DefaultTableModel		model;
		CBTableSorter 			sorter;
		CBButton					btnPrint, btnClose, btnHelp, btnSave;
		CBPanel					bottomPanel;
		CBPanel					topPanel;
		CBPanel					display;
		JScrollPane 			scrollPane;
		JFileChooser 			chooser;
		HashMap					map;
		
	   /*
		*    A temporary copy of a component that is to be printed, used by the
		*    print thread mechanism to pass an editor image around.
		*/
	    private Component printComponent = null;
			
			
	   /**
	    *	Sets up a dialog that displays the given data in a table.  The dialog
		*	has a print button that prints this table.
		*	@param tableData the data that is to be displayed in the tabel i.e. Object[rows][columns].
		*	@param tableHeader an array holding the attribute names that are used for the header of 
		*		each column (cn, sn etc).
		*	@param num the number of search results returned (this is just used in the title bar).
		*	@param map a store for the DN of a particular row number.		
		*/
		public ReturnAttributesGUI(Object[][] tableData, String[] tableHeader, int num, HashMap map)
		{
			super(jx, CBIntText.get(String.valueOf(num)+ CBIntText.get(" Search Results")), false); 					
					
			this.map = map;
					
			model = new DefaultTableModel(tableData, tableHeader);

            // For sorting via clicking on table headers...
			sorter = new CBTableSorter(model);

            // Requires a click/shift + click...
			table = new JTable(sorter);
			sorter.addMouseListenerToHeaderInTable(table);

            // Adds a mouse event listener to the table...
			addMouseListenerToTable();
			
	        // Create the scroll pane and add the table to it...
	        scrollPane = new JScrollPane(table);		
						
			// Main display (control & table holder)...
			display = new CBPanel();

			// Top panel (table holder)...
			topPanel = new CBPanel();
			topPanel.makeHeavy();
			topPanel.addln(scrollPane);
			
			display.makeHeavy();
			display.addln(topPanel);
								
	        // Bottom panel (control area)...
	        bottomPanel = new CBPanel();
		
			btnPrint = new CBButton(CBIntText.get("Print"), CBIntText.get("Print this page."));
			btnPrint.addActionListener(new ActionListener(){
					public void actionPerformed(ActionEvent e){
						print();
			}});
			
			btnSave = new CBButton(CBIntText.get("Save"), CBIntText.get("Save this page."));
			btnSave.addActionListener(new ActionListener(){
					public void actionPerformed(ActionEvent e){
						save();
			}});			
						
			btnClose = new CBButton(CBIntText.get("Close"), CBIntText.get("Close this window."));
			btnClose.addActionListener(new ActionListener(){
					public void actionPerformed(ActionEvent e){
						close();
			}});
			
			btnHelp = new CBButton(CBIntText.get("Help"), CBIntText.get("Help for this window."));
			CBHelpSystem.useDefaultHelp(btnHelp, HelpIDs.SEARCH_RESULTS);
					
			bottomPanel.makeWide();
			bottomPanel.add(new JLabel("  "));
			bottomPanel.makeLight();		
			bottomPanel.add(btnPrint);
			bottomPanel.add(btnSave);
			bottomPanel.add(btnClose);
			bottomPanel.add(btnHelp);
			
			display.makeLight();
			display.addln(bottomPanel);		
			
			// Get the Container & add the display components...
	        Container pane = getContentPane();
	        pane.setLayout(new BorderLayout());	
			pane.add(display);	
			
			setSize(500, 300);
			CBUtility.center(this, jx);	
			setVisible(true);		
		}	
		
   	   /**
	    *	To correctly set the data in the table, this method removes the scroll pane
		*	and therefore the table, then recreates the DefaultTableModel, the CBTableSorter,
		*	the JTable itself and the JScrollPane.  Adds the scroll pane back onto the top panel
		*	then repaints it all.  Phew...to not do this some weird painting occurs!
		*	<p>
		*	The title of the dialog is also set with the number of search results.
		*	@param tableData the data that is to be displayed in the tabel i.e. Object[rows][columns].
		*	@param tableHeader an array holding the attribute names that are used for the header of 
		*		each column (cn, sn etc).
		*	@param num the number of search results returned (this is just used in the title bar).
		*	@param map a store for the DN of a particular row number.
		*/
		public void setTableData(Object[][] tableData, String[] tableHeader, int num, HashMap map)
		{	 
			this.map = map;
			setTitle(CBIntText.get(String.valueOf(num)+ CBIntText.get(" Search Results")));