CLEFClient

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> recoinx >> [ clef overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

SOURCE |

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

recoinx.clef
Class CLEFClient

java.lang.Object
  recoinx.clef.CLEFClient

All Implemented Interfaces:: java.awt.event.ActionListener, java.util.EventListener, java.awt.event.WindowListener

public class CLEFClient
extends java.lang.Object
implements java.awt.event.ActionListener, java.awt.event.WindowListener

The CLEFClient represents an application that offers graphical means to enter all parameters needed to execute the retrieval process, send them and process the results upon completion.

Version:: 0.2.9

Nested Class Summary

private class CLEFClient.CLEFFileChooser
          The CLEFFileChooser class represents a JFileChooser to select a file or a folder from the file system.

private class CLEFClient.ResultFrame
          Inner class that represents a single JFrame to display the results.

protected class CLEFClient.RMIClient
          Inner class that implements an RMI service to receive the results from the RemoteCLEFConnector.

private class CLEFClient.TRECFormatWriter
          The TRECFormatWriter class extends the BufferedWriter to print to a File.

Field Summary

private javax.swing.JFrame appletFrame
          A JFrame for this CLEFClient.

private javax.swing.JButton bBrowseSave
          The JButtons.

private javax.swing.JButton bBrowseTopic
          The JButtons.

private javax.swing.JButton bSubmit
          The JButtons.

private CLEFClient.RMIClient client
          A RMI service that receives the answer from the RemoteCLEFConnector.

private CLEFClient.TRECFormatWriter formatWriter
          A TRECFormatWriter to create the official TREC format for results.

private javax.swing.JLabel lMessage
          The JLabels.

(package private) static org.apache.log4j.Logger logger
          The logger for this class.

private javax.swing.JLabel lSave
          The JLabels.

private javax.swing.JLabel lTopic
          The JLabels.

private RemoteCLEFConnector remoteConnector
          The RemoteCLEFConnector.

private CLEFClient.CLEFFileChooser saveChooser
          A CLEFFileChooser to select the directory to save results to from the file system.

private java.lang.String serverURL
          The URL of the CLEF RMI service.

private javax.swing.JTextField tfCutOff
          The JTextFields.

private javax.swing.JTextField tfSavePath
          The JTextFields.

private javax.swing.JTextField tfTopicNumber
          The JTextFields.

private javax.swing.JTextField tfTopicPath
          The JTextFields.

private CLEFClient.CLEFFileChooser topicChooser
          A CLEFFileChooser to select the topic file from the file system.

private java.io.File topicFile
          The file with the topics.

private org.dom4j.io.SAXReader xmlReader
          A SAXReader to read XML files.

private org.dom4j.io.XMLWriter xmlWriter
          A SAXWriter to write XML files.

Constructor Summary

CLEFClient()
          Creates a new CLEFClient.

Method Summary

void actionPerformed(java.awt.event.ActionEvent event)
          Handles ActionEvents from the buttons of this CLEFClient and triggers the submit mechanism or opens the CLEFFileChooser, for example.

private org.dom4j.Document createDocument(java.io.File file)
          Returns a org.dom4j.Document that represents the specified file.

private org.dom4j.Document createDocument(java.io.Reader reader)
          Returns a org.dom4j.Document that is created using the specified Reader.

private java.util.Iterator getTopicIterator(org.dom4j.Document doc)
          Returns an Iterator ocer the topic elements in the specified Document.

private void initiateComponents()
          Initiates the GUI components of this CLEFClient.

RemoteCLEFConnector lookupConnector(java.lang.String connectorURL)
          Looks up the RemoteCLEFConnector service in the rmiregistry using the specified URL.

static void main(java.lang.String[] args)
          Main-method of this CLEFClient that starts the client.

private void printMessage(java.lang.String msg)
          Outputs the specified message to the user.

void windowActivated(java.awt.event.WindowEvent windowEvent)
          Empty implementation of WindowListener method.

void windowClosed(java.awt.event.WindowEvent windowEvent)
          Empty implementation of WindowListener method.

void windowClosing(java.awt.event.WindowEvent windowEvent)
          Exits this CLEFClient.

void windowDeactivated(java.awt.event.WindowEvent windowEvent)
          Empty implementation of WindowListener method.

void windowDeiconified(java.awt.event.WindowEvent windowEvent)
          Empty implementation of WindowListener method.

void windowIconified(java.awt.event.WindowEvent windowEvent)
          Empty implementation of WindowListener method.

void windowOpened(java.awt.event.WindowEvent windowEvent)
          Empty implementation of WindowListener method.

private void writeDoc(org.dom4j.io.XMLWriter writer, org.dom4j.Document doc)
          Writes the specified Document using the specified XMLWriter

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

logger

static org.apache.log4j.Logger logger

The logger for this class.

xmlReader

private org.dom4j.io.SAXReader xmlReader

A SAXReader to read XML files.

xmlWriter

private org.dom4j.io.XMLWriter xmlWriter

A SAXWriter to write XML files.

formatWriter

private CLEFClient.TRECFormatWriter formatWriter

A TRECFormatWriter to create the official TREC format for results.

topicFile

private java.io.File topicFile

The file with the topics.

serverURL

private java.lang.String serverURL

The URL of the CLEF RMI service.

remoteConnector

private RemoteCLEFConnector remoteConnector

The RemoteCLEFConnector.

appletFrame

private javax.swing.JFrame appletFrame

A JFrame for this CLEFClient.

tfCutOff

private javax.swing.JTextField tfCutOff

The JTextFields.

tfTopicNumber

private javax.swing.JTextField tfTopicNumber

The JTextFields.

tfTopicPath

private javax.swing.JTextField tfTopicPath

The JTextFields.

tfSavePath

private javax.swing.JTextField tfSavePath

The JTextFields.

lTopic

private javax.swing.JLabel lTopic

The JLabels.

lSave

private javax.swing.JLabel lSave

The JLabels.

lMessage

private javax.swing.JLabel lMessage

The JLabels.

bBrowseTopic

private javax.swing.JButton bBrowseTopic

The JButtons.

bBrowseSave

private javax.swing.JButton bBrowseSave

The JButtons.

bSubmit

private javax.swing.JButton bSubmit

The JButtons.

client

private CLEFClient.RMIClient client

A RMI service that receives the answer from the RemoteCLEFConnector.

topicChooser

private CLEFClient.CLEFFileChooser topicChooser

A CLEFFileChooser to select the topic file from the file system.

saveChooser

private CLEFClient.CLEFFileChooser saveChooser

A CLEFFileChooser to select the directory to save results to from the file system.

Constructor Detail

CLEFClient

public CLEFClient()

Creates a new CLEFClient.

Method Detail

lookupConnector

public RemoteCLEFConnector lookupConnector(java.lang.String connectorURL)

Looks up the RemoteCLEFConnector service in the rmiregistry using the specified URL.

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent event)

Handles ActionEvents from the buttons of this CLEFClient and triggers the submit mechanism or opens the CLEFFileChooser, for example.

Specified by:: actionPerformed in interface java.awt.event.ActionListener

printMessage

private void printMessage(java.lang.String msg)

Outputs the specified message to the user.

main

public static void main(java.lang.String[] args)

Main-method of this CLEFClient that starts the client.

windowClosing

public void windowClosing(java.awt.event.WindowEvent windowEvent)

Exits this CLEFClient.

Specified by:: windowClosing in interface java.awt.event.WindowListener