class JBrukerSubmit:
colHeads = ('block/sample #', 'Holder', 'Name', 'Experiment', 'Solvent',
'Group', 'Member', 'Sample Name')
if platform.node() == 'DM-CHEM-200':
basedir = r"W:\downloads\Eric\jython"
elif platform.node() == 'ERIC-PC':
basedir = r"C:\Users\ERIC\Dropbox\projects\programming\2020\python\autoNMRinput"
else:
# running from Bruker spectrometers
basedir = "/data/downloads/Eric"
def listSubmit(self, event):
"""Submit highlighted to csv file to automation folder of spectrometer
"""
# Ask for starting carousel position and submit experimets to topspin
# obtain file name of CSV file
selected = self.list.selectedIndex
csvName = self.data[selected]
# if no selected file and table is empty just return
if self.label.text == "Selected File":
return
# Create check dialog before submitting data to automation
self.dataTableModel.dataVector
# submitString = "submit " + csvName + " starting at carousel position " + self.carouselStartingPosition.text
submitString = "submit " + csvName + " starting at carousel position " + str(
(self.dataTableModel.dataVector)[0][1])
result = JOptionPane.showConfirmDialog(self.frame, submitString)
# if submission confirmed
if result == 0:
# submit csv file to automation
ret = readcsv243A.submitNMRexpts([
self.dataTableModel.dataVector, csvName,
self.carouselStartingPosition.text
])
# if successful or not update status string
if ret == 0:
self.statusLabel.text = "File " + csvName + " Submitted to TOPSPIN Starting at Carousel Position " + str(
(self.dataTableModel.dataVector)[0][1])
self.panelStatusLabel.setBackground(Color.GREEN)
elif ret == 1:
self.statusLabel.text = "Carousel Position not a number"
self.panelStatusLabel.setBackground(Color.RED)
elif ret == 2:
self.statusLabel.text = "Incompatible experiment chosen for spectrometer"
self.panelStatusLabel.setBackground(Color.RED)
elif ret == 3:
self.statusLabel.text = "A holder starting position is not between 1 and 60 inclusive"
self.panelStatusLabel.setBackground(Color.RED)
elif ret == 4:
self.statusLabel.text = "Too many samples for starting position chosen"
self.panelStatusLabel.setBackground(Color.RED)
# if an error occured display error message also in a warning dialog too.
if ret in [1, 2, 3, 4]:
JOptionPane.showMessageDialog(self.frame,
self.statusLabel.text)
def listSelect(self, event):
"""When a new csv file is selected from the list
read in the file and display its contents in the table.
Unordered csv files will be ordered based on the block/sample number.
A holder column will be added to the CSV data based on the carousel
starting position.
"""
# Process the events from the list box and update the label
# get the index from the list and then the filename
selected = self.list.selectedIndex
if selected >= 0:
# update file label and set background colour to normal
csvName = self.data[selected]
self.label.text = csvName
self.panelLabel.setBackground(self.standardBackgroundColor)
# reset status label
self.statusLabel.text = "Status"
self.panelStatusLabel.setBackground(self.standardBackgroundColor)
#
# update table by reading in csv file
# read in csv file and store as a list of dictionaries
# one dictionary for each line
fn = csvName
self.expt_list = []
f = open(os.path.join(JBrukerSubmit.basedir, fn), 'r')
reader = csv.DictReader(f)
for row in reader:
self.expt_list.append(row)
f.close()
# get carousel starting position, if the value cannot be converted
# to an integer reset it to 1 and reset the GUI to 1
try:
self.cnumber = int(self.carouselStartingPosition.text)
except:
self.cnumber = 1
self.self.carouselStartingPosition.text = "1"
# get the csv data into a list of lists form ready for displaying
self.tableData = returnJTableData(self.expt_list, self.cnumber)
# display csv table in table view
colNames = JBrukerSubmit.colHeads
# transfer the data over to the table model
self.dataTableModel.setDataVector(self.tableData, colNames)
# display the table in the GUI
self.scrollPaneTable.getViewport().setView((self.table))
# check to see if experiments will run on the spectometer
ok, pulseSequence = checkExperimentsWillRun(self.expt_list)
if not ok:
# display warning dialog
warningText = pulseSequence + " cannot be run on this spectrometer"
JOptionPane.showMessageDialog(self.frame, warningText)
def returnCSVlist(self, hiddenFiles):
""" read in csv files ommitting any that are created after
auto submission and return as list of strings.
Miss out any that have been hidden"""
csvlist = [
f for f in os.listdir(JBrukerSubmit.basedir)
if (f.endswith(".csv")) and (f[-6] not in ['A', 'B', 'N'])
]
csvlist = [f for f in csvlist if f not in self.hiddenFiles]
return csvlist
def listUpdate(self, event):
""" when update button clicked renew csv list """
self.data = self.returnCSVlist(self.hiddenFiles)
self.list.setListData(self.data)
def checkCarouselNumber(self, event):
""" check that carousel field is an integer change background to white
if okay, red if not."""
self.cnumber = self.carouselStartingPosition.text
try:
self.cnumber = int(self.cnumber)
self.carouselStartingPosition.background = Color.WHITE
self.listSelect(event)
except:
self.carouselStartingPosition.background = Color.RED
def tableMouseClicked(self, event):
"""Prior to editing the user will click the holder number cell
more often than not. This function saves the cell row and column and
the value in the cell prior to editing."""
tble = event.getSource()
self.rw = tble.getSelectedRow()
self.cl = tble.getSelectedColumn()
self.oldHolderValue = tble.getValueAt(self.rw, self.cl)
# print "table mouse clicked", self.rw, self.cl
def tableChangedCB(self, event):
"""Function is called when a cell is being edited. After the user
presses return the data is updated.
Should only work if Holder column is being edited"""
print "Table Changed"
tble = event.getSource()
if (event.keyChar == "\n") and (self.cl != 1):
tble.setValueAt(self.oldHolderValue, self.rw, self.cl)
elif (event.keyChar == "\n") and (self.cl == 1):
print "RETURN"
vlue = tble.getValueAt(self.rw, self.cl)
print "row", self.rw, "col", self.cl, "value", vlue
#
# check to see if new holder number is used by another sample
# get block number of sample changed
blckNumber = tble.getValueAt(self.rw, 0)
#
# get values in table
holderAlreadyOccupied = False
tableValues = self.dataTableModel.dataVector
for i, rw in enumerate(tableValues):
print i
if (int(rw[1])
== int(vlue)) and (int(blckNumber) != int(rw[0])):
tble.setValueAt(int(self.oldHolderValue), self.rw, 1)
holderAlreadyOccupied = True
warningText = "Holder " + str(
vlue) + " already used for sample " + str(rw[0])
JOptionPane.showMessageDialog(self.frame, warningText)
break
#
# check to see if any other rows with same sample number need to be updated
if not holderAlreadyOccupied:
for i, rw in enumerate(tableValues):
if int(blckNumber) == int(rw[0]):
tble.setValueAt(int(vlue), i, 1)
# def tableKeyPressedCB(self, event):
# print "tableKeyPressedCB"
# tble = event.getSource()
# if event.keyChar == "\n":
# print "RETURN"
# vlue = tble.getValueAt(self.rw, self.cl)
# print "row", self.rw, "col", self.cl, "value", vlue
# elif (event.keyChar).isdigit():
# print "event.keyChar", event.keyChar
# self.rw = tble.getSelectedRow()
# self.cl = tble.getSelectedColumn()
def listShowAllFiles(self, event):
fp = open("hiddenFiles.txt", 'w')
fp.write('zzz\n')
fp.close()
self.hiddenFiles = ['zzz']
self.listUpdate(event)
def listHideFile(self, event):
# find highlighted csv file name
selected = self.list.selectedIndex
csvName = self.data[selected]
# add csv file name to hidden csv files list
self.hiddenFiles.append(csvName)
# update label above table view
self.label.text = "Selected File"
self.panelLabel.setBackground(self.standardBackgroundColor)
# display csv table in table view
# set table to blanks
self.tableData = []
for i in range(18):
self.tableData.append([
"",
] * len(JBrukerSubmit.colHeads))
self.dataTableModel.setDataVector(self.tableData,
JBrukerSubmit.colHeads)
self.listUpdate(event)
# save hiddenFiles file
fp = open("hiddenFiles.txt", 'w')
for f in self.hiddenFiles:
fp.write(f + '\n')
fp.close()
def __init__(self):
self.rw = 0 # table row
self.cl = 0 # table column
# load hidden files list
self.hiddenFiles = ["zzz"]
if os.path.exists("hiddenFiles.txt"):
fp = open("hiddenFiles.txt", "r")
self.hiddenFiles = fp.readlines()
fp.close()
self.hiddenFiles = [f.strip() for f in self.hiddenFiles]
print self.hiddenFiles
# These lines setup the basic frame, size and layout
# the setDefaultCloseOperation so that only the window closes and not TOPSPIN
self.frame = JFrame("Submit NMR Experimets")
self.frame.setSize(1200, 440)
self.frame.setLayout(BorderLayout())
self.frame.setDefaultCloseOperation(JFrame.DISPOSE_ON_CLOSE)
# set up the list and the contents of the list
# the python tuple get converted to a Java vector
self.data = self.returnCSVlist(self.hiddenFiles)
self.list = JList(self.data, valueChanged=self.listSelect)
self.spane = JScrollPane()
self.spane.setPreferredSize(Dimension(145, 150))
self.spane.getViewport().setView((self.list))
panel = JPanel()
panel.add(self.spane)
# define buttons
bpanel = JPanel()
btnS = JButton('Submit File', actionPerformed=self.listSubmit)
btnU = JButton('Update List', actionPerformed=self.listUpdate)
btnHideFile = JButton('Hide File', actionPerformed=self.listHideFile)
btnShowAllFiles = JButton('Show All Files',
actionPerformed=self.listShowAllFiles)
# label displaying CSV file selected
self.label = JLabel('Selected File', JLabel.CENTER)
# label to display warnings and confirm expriments submitted
self.statusLabel = JLabel('Status', JLabel.CENTER)
# Create table to display csv file
self.tableData = []
for r in range(18):
self.tableData.append([
"",
] * len(JBrukerSubmit.colHeads))
colNames = JBrukerSubmit.colHeads
self.dataTableModel = DefaultTableModel(self.tableData, colNames)
self.table = JTable(self.dataTableModel,
keyTyped=self.tableChangedCB,
mouseClicked=self.tableMouseClicked)
# set all columns to uneditable except Holder column
# print dir(self.table)
# self.table.getColumn(0).setEditable(False)
# self.table.getColumn(2).setEditable(False)
# self.table.getColumn(3).setEditable(False)
# self.table.getColumn(4).setEditable(False)
# self.table.getColumn(5).setEditable(False)
# self.table.getColumn(6).setEditable(False)
# self.table = JTable(self.dataTableModel,
# keyPressed=self.tableKeyPressedCB)
self.scrollPaneTable = JScrollPane()
self.scrollPaneTable.setPreferredSize(Dimension(900, 300))
self.scrollPaneTable.getViewport().setView((self.table))
panelTable = JPanel()
panelTable.add(self.scrollPaneTable)
# create text field to get carousel starting position
self.carouselLabel = JLabel("Carousel Position", JLabel.CENTER)
self.carouselStartingPosition = JTextField(
'1', 13, keyPressed=self.checkCarouselNumber)
# add widgets to do with manupulating csv list in FlowLayout Mode
panelList = JPanel()
panelList.setLayout(FlowLayout())
panelList.setPreferredSize(Dimension(170, 200))
# set preferred size of buttons
btnU.setPreferredSize(Dimension(140, 20))
btnS.setPreferredSize(Dimension(140, 20))
btnHideFile.setPreferredSize(Dimension(140, 20))
btnShowAllFiles.setPreferredSize(Dimension(140, 20))
self.carouselLabel.setPreferredSize(Dimension(140, 20))
self.carouselStartingPosition.setPreferredSize(Dimension(170, 20))
panelList.add(btnU)
panelList.add(panel)
panelList.add(btnHideFile)
panelList.add(btnShowAllFiles)
panelList.add(JSeparator(JSeparator.HORIZONTAL),
BorderLayout.LINE_START)
panelList.add(self.carouselLabel)
panelList.add(self.carouselStartingPosition)
panelList.add(btnS)
self.panelLabel = JPanel()
self.panelLabel.add(self.label)
self.standardBackgroundColor = self.panelLabel.getBackground()
# put status label in a panel so that background color can be changed
self.panelStatusLabel = JPanel()
self.panelStatusLabel.add(self.statusLabel)
# add widgets to frame
self.frame.add(self.panelLabel, BorderLayout.NORTH)
self.frame.add(panelList, BorderLayout.WEST)
self.frame.add(panelTable, BorderLayout.CENTER)
self.frame.add(self.panelStatusLabel, BorderLayout.SOUTH)
self.frame.setVisible(True)
class QatDialog(ToggleDialog):
"""ToggleDialog for error type selection and buttons for reviewing
errors in sequence
"""
def __init__(self, name, iconName, tooltip, shortcut, height, app):
ToggleDialog.__init__(self, name, iconName, tooltip, shortcut, height)
self.app = app
tools = app.tools
#Main panel of the dialog
mainPnl = JPanel(BorderLayout())
mainPnl.setBorder(BorderFactory.createEmptyBorder(0, 1, 1, 1))
### First tab: errors selection and download ###########################
#ComboBox with tools names
self.toolsComboModel = DefaultComboBoxModel()
for tool in tools:
self.add_data_to_models(tool)
self.toolsCombo = JComboBox(self.toolsComboModel,
actionListener=ToolsComboListener(app))
renderer = ToolsComboRenderer(self.app)
renderer.setPreferredSize(Dimension(20, 20))
self.toolsCombo.setRenderer(renderer)
self.toolsCombo.setToolTipText(app.strings.getString("Select_a_quality_assurance_tool"))
#ComboBox with categories names ("views"), of the selected tool
self.viewsCombo = JComboBox(actionListener=ViewsComboListener(app))
self.viewsCombo.setToolTipText(app.strings.getString("Select_a_category_of_error"))
#Popup for checks table
self.checkPopup = JPopupMenu()
#add favourite check
self.menuItemAdd = JMenuItem(self.app.strings.getString("Add_to_favourites"))
self.menuItemAdd.setIcon(ImageIcon(File.separator.join([self.app.SCRIPTDIR,
"tools",
"data",
"Favourites",
"icons",
"tool_16.png"])))
self.menuItemAdd.addActionListener(PopupActionListener(self.app))
self.checkPopup.add(self.menuItemAdd)
#remove favourite check
self.menuItemRemove = JMenuItem(self.app.strings.getString("Remove_from_favourites"))
self.menuItemRemove.setIcon(ImageIcon(File.separator.join([self.app.SCRIPTDIR,
"tools",
"data",
"Favourites",
"icons",
"black_tool_16.png"])))
self.menuItemRemove.addActionListener(PopupActionListener(self.app))
self.checkPopup.add(self.menuItemRemove)
#Help link for selected check
self.menuItemHelp = JMenuItem(self.app.strings.getString("check_help"))
self.menuItemHelp.setIcon(ImageIcon(File.separator.join([self.app.SCRIPTDIR,
"images",
"icons",
"info_16.png"])))
self.checkPopup.add(self.menuItemHelp)
self.menuItemHelp.addActionListener(PopupActionListener(self.app))
#Table with checks of selected tool and view
self.checksTable = JTable()
self.iconrenderer = IconRenderer()
self.iconrenderer.setHorizontalAlignment(JLabel.CENTER)
scrollPane = JScrollPane(self.checksTable)
self.checksTable.setFillsViewportHeight(True)
tableSelectionModel = self.checksTable.getSelectionModel()
tableSelectionModel.addListSelectionListener(ChecksTableListener(app))
self.checksTable.addMouseListener(ChecksTableClickListener(app,
self.checkPopup,
self.checksTable))
#Favourite area status indicator
self.favAreaIndicator = JLabel()
self.update_favourite_zone_indicator()
self.favAreaIndicator.addMouseListener(FavAreaIndicatorListener(app))
#label with OSM id of the object currently edited and number of
#errors still to review
self.checksTextFld = JTextField("",
editable=0,
border=None,
background=None)
#checks buttons
btnsIconsDir = File.separator.join([app.SCRIPTDIR, "images", "icons"])
downloadIcon = ImageIcon(File.separator.join([btnsIconsDir, "download.png"]))
self.downloadBtn = JButton(downloadIcon,
actionPerformed=app.on_downloadBtn_clicked,
enabled=0)
startIcon = ImageIcon(File.separator.join([btnsIconsDir, "start_fixing.png"]))
self.startBtn = JButton(startIcon,
actionPerformed=app.on_startBtn_clicked,
enabled=0)
self.downloadBtn.setToolTipText(app.strings.getString("Download_errors_in_this_area"))
self.startBtn.setToolTipText(app.strings.getString("Start_fixing_the_selected_errors"))
#tab layout
panel1 = JPanel(BorderLayout(0, 1))
comboboxesPnl = JPanel(GridLayout(0, 2, 5, 0))
comboboxesPnl.add(self.toolsCombo)
comboboxesPnl.add(self.viewsCombo)
checksPnl = JPanel(BorderLayout(0, 1))
checksPnl.add(scrollPane, BorderLayout.CENTER)
self.statsPanel = JPanel(BorderLayout(4, 0))
self.statsPanel_def_color = self.statsPanel.getBackground()
self.statsPanel.add(self.checksTextFld, BorderLayout.CENTER)
self.statsPanel.add(self.favAreaIndicator, BorderLayout.LINE_START)
checksPnl.add(self.statsPanel, BorderLayout.PAGE_END)
checksButtonsPnl = JPanel(GridLayout(0, 2, 0, 0))
checksButtonsPnl.add(self.downloadBtn)
checksButtonsPnl.add(self.startBtn)
panel1.add(comboboxesPnl, BorderLayout.PAGE_START)
panel1.add(checksPnl, BorderLayout.CENTER)
panel1.add(checksButtonsPnl, BorderLayout.PAGE_END)
### Second tab: errors fixing ##########################################
#label with error stats
self.errorTextFld = JTextField("",
editable=0,
border=None,
background=None)
#label with current error description
self.errorDesc = JLabel("")
self.errorDesc.setAlignmentX(0.5)
#error buttons
errorInfoBtnIcon = ImageProvider.get("info")
self.errorInfoBtn = JButton(errorInfoBtnIcon,
actionPerformed=app.on_errorInfoBtn_clicked,
enabled=0)
notErrorIcon = ImageIcon(File.separator.join([btnsIconsDir, "not_error.png"]))
self.notErrorBtn = JButton(notErrorIcon,
actionPerformed=app.on_falsePositiveBtn_clicked,
enabled=0)
ignoreIcon = ImageIcon(File.separator.join([btnsIconsDir, "skip.png"]))
self.ignoreBtn = JButton(ignoreIcon,
actionPerformed=app.on_ignoreBtn_clicked,
enabled=0)
correctedIcon = ImageIcon(File.separator.join([btnsIconsDir, "corrected.png"]))
self.correctedBtn = JButton(correctedIcon,
actionPerformed=app.on_correctedBtn_clicked,
enabled=0)
nextIcon = ImageIcon(File.separator.join([btnsIconsDir, "next.png"]))
self.nextBtn = JButton(nextIcon,
actionPerformed=app.on_nextBtn_clicked,
enabled=0)
#self.nextBtn.setMnemonic(KeyEvent.VK_RIGHT)
self.errorInfoBtn.setToolTipText(app.strings.getString("open_error_info_dialog"))
self.notErrorBtn.setToolTipText(app.strings.getString("flag_false_positive"))
self.ignoreBtn.setToolTipText(app.strings.getString("Skip_and_don't_show_me_this_error_again"))
self.correctedBtn.setToolTipText(app.strings.getString("flag_corrected_error"))
self.nextBtn.setToolTipText(app.strings.getString("Go_to_next_error"))
#tab layout
self.panel2 = JPanel(BorderLayout())
self.panel2.add(self.errorTextFld, BorderLayout.PAGE_START)
self.panel2.add(self.errorDesc, BorderLayout.CENTER)
errorButtonsPanel = JPanel(GridLayout(0, 5, 0, 0))
errorButtonsPanel.add(self.errorInfoBtn)
errorButtonsPanel.add(self.notErrorBtn)
errorButtonsPanel.add(self.ignoreBtn)
errorButtonsPanel.add(self.correctedBtn)
errorButtonsPanel.add(self.nextBtn)
self.panel2.add(errorButtonsPanel, BorderLayout.PAGE_END)
#Layout
self.tabbedPane = JTabbedPane()
self.tabbedPane.addTab(self.app.strings.getString("Download"),
None,
panel1,
self.app.strings.getString("download_tab"))
mainPnl.add(self.tabbedPane, BorderLayout.CENTER)
self.createLayout(mainPnl, False, None)
def add_data_to_models(self, tool):
"""Add data of a tool to the models of the dialog components
"""
#tools combobox model
if tool == self.app.favouritesTool:
self.toolsComboModel.addElement(JSeparator())
self.toolsComboModel.addElement(tool)
#views combobox model
tool.viewsComboModel = DefaultComboBoxModel()
for view in tool.views:
tool.viewsComboModel.addElement(view.title)
#checks table, one TableModel for each view, of each tool
columns = ["",
self.app.strings.getString("Check"),
self.app.strings.getString("Errors")]
for view in tool.views:
tableRows = []
for check in view.checks:
if check.icon is not None:
icon = check.icon
else:
icon = ""
errorsNumber = ""
tableRows.append([icon, check.title, errorsNumber])
view.tableModel = MyTableModel(tableRows, columns)
def update_favourite_zone_indicator(self):
#icon
if self.app.favZone is not None:
self.favAreaIndicator.setIcon(self.app.favZone.icon)
#tooltip
messageArguments = array([self.app.favZone.name], String)
formatter = MessageFormat("")
formatter.applyPattern(self.app.strings.getString("favAreaIndicator_tooltip"))
msg = formatter.format(messageArguments)
self.favAreaIndicator.setToolTipText(msg)
#status
self.favAreaIndicator.setVisible(self.app.favouriteZoneStatus)
def set_checksTextFld_color(self, color):
"""Change color of textField under checksTable
"""
colors = {"white": (255, 255, 255),
"black": (0, 0, 0),
"green": (100, 200, 0),
"red": (200, 0, 0)}
if color == "default":
self.statsPanel.background = self.statsPanel_def_color
self.checksTextFld.foreground = colors["black"]
else:
self.statsPanel.background = colors[color]
self.checksTextFld.foreground = colors["white"]
def change_selection(self, source):
"""Change comboboxes and checks table selections after a
selection has been made by the user
"""
if source in ("menu", "layer", "add favourite"):
self.app.selectionChangedFromMenuOrLayer = True
self.toolsCombo.setSelectedItem(self.app.selectedTool)
self.viewsCombo.setModel(self.app.selectedTool.viewsComboModel)
self.viewsCombo.setSelectedItem(self.app.selectedView.title)
self.checksTable.setModel(self.app.selectedTableModel)
self.refresh_checksTable_columns_geometries()
for i, c in enumerate(self.app.selectedView.checks):
if c == self.app.selectedChecks[0]:
break
self.checksTable.setRowSelectionInterval(i, i)
self.app.selectionChangedFromMenuOrLayer = False
else:
self.app.selectionChangedFromMenuOrLayer = False
if source == "toolsCombo":
self.viewsCombo.setModel(self.app.selectedTool.viewsComboModel)
self.viewsCombo.setSelectedIndex(0)
elif source == "viewsCombo":
self.checksTable.setModel(self.app.selectedTableModel)
self.refresh_checksTable_columns_geometries()
if self.app.selectedView.checks != []: # favourite checks may be none
self.checksTable.setRowSelectionInterval(0, 0)
def refresh_checksTable_columns_geometries(self):
self.checksTable.getColumnModel().getColumn(0).setCellRenderer(self.iconrenderer)
self.checksTable.getColumnModel().getColumn(0).setMaxWidth(25)
self.checksTable.getColumnModel().getColumn(2).setMaxWidth(60)
def activate_error_tab(self, status):
if status:
if self.tabbedPane.getTabCount() == 1:
self.tabbedPane.addTab(self.app.strings.getString("Fix"),
None,
self.panel2,
self.app.strings.getString("fix_tab"))
else:
if self.tabbedPane.getTabCount() == 2:
self.tabbedPane.remove(1)
def update_checks_buttons(self):
"""This method sets the status of downloadBtn and startBtn
"""
#none check selected
if len(self.app.selectedChecks) == 0:
self.downloadBtn.setEnabled(False)
self.startBtn.setEnabled(False)
else:
#some check selected
self.downloadBtn.setEnabled(True)
if len(self.app.selectedChecks) > 1:
self.startBtn.setEnabled(False)
else:
#only one check is selected
self.app.errors = self.app.selectedChecks[0].errors
if self.app.errors is None or len(self.app.errors) == 0:
#errors file has not been downloaded and parsed yet
self.startBtn.setEnabled(False)
else:
#errors file has been downloaded and parsed
if self.app.selectedChecks[0].toDo == 0:
#all errors have been corrected
self.startBtn.setEnabled(False)
else:
self.startBtn.setEnabled(True)
#self.nextBtn.setEnabled(True)
def update_error_buttons(self, mode):
"""This method sets the status of:
ignoreBtn, falsePositiveBtn, correctedBtn, nextBtn
"""
if mode == "new error":
status = True
else:
status = False
if self.app.selectedChecks[0].tool.fixedFeedbackMode is None:
self.correctedBtn.setEnabled(False)
else:
self.correctedBtn.setEnabled(status)
if self.app.selectedChecks[0].tool.falseFeedbackMode is None:
self.notErrorBtn.setEnabled(False)
else:
self.notErrorBtn.setEnabled(status)
self.errorInfoBtn.setEnabled(status)
self.ignoreBtn.setEnabled(status)
if mode in ("reset", "review end"):
self.nextBtn.setEnabled(False)
elif mode in ("errors downloaded", "show stats", "new error"):
self.nextBtn.setEnabled(True)
def update_text_fields(self, mode, errorInfo=""):
"""This method updates the text in:
checksTextFld, errorDesc, errorTextFld
"""
self.errorDesc.text = ""
if mode == "review end":
cheksTextColor = "green"
checksText = self.app.strings.getString("All_errors_reviewed.")
errorText = self.app.strings.getString("All_errors_reviewed.")
elif mode == "reset":
cheksTextColor = "default"
checksText = ""
errorText = ""
elif mode == "show stats":
cheksTextColor = "default"
checksText = "%s %d / %s" % (
self.app.strings.getString("to_do"),
self.app.selectedChecks[0].toDo,
len(self.app.selectedChecks[0].errors))
#print "checks text", checksText
errorText = "%s%s %d / %s" % (
errorInfo,
self.app.strings.getString("to_do"),
self.app.selectedChecks[0].toDo,
len(self.app.selectedChecks[0].errors))
#print "error text", errorText
if self.app.selectedError is not None and self.app.selectedError.desc != "":
self.errorDesc.text = "<html>%s</html>" % self.app.selectedError.desc
self.set_checksTextFld_color(cheksTextColor)
self.checksTextFld.text = checksText
self.errorTextFld.text = errorText
self.update_statsPanel_status()
def update_statsPanel_status(self):
if self.checksTextFld.text == "" and not self.app.favouriteZoneStatus:
self.statsPanel.setVisible(False)
else:
self.statsPanel.setVisible(True)
class QatDialog(ToggleDialog):
"""ToggleDialog for error type selection and buttons for reviewing
errors in sequence
"""
def __init__(self, name, iconName, tooltip, shortcut, height, app):
ToggleDialog.__init__(self, name, iconName, tooltip, shortcut, height)
self.app = app
tools = app.tools
#Main panel of the dialog
mainPnl = JPanel(BorderLayout())
mainPnl.setBorder(BorderFactory.createEmptyBorder(0, 1, 1, 1))
### First tab: errors selection and download ###########################
#ComboBox with tools names
self.toolsComboModel = DefaultComboBoxModel()
for tool in tools:
self.add_data_to_models(tool)
self.toolsCombo = JComboBox(self.toolsComboModel,
actionListener=ToolsComboListener(app))
renderer = ToolsComboRenderer(self.app)
renderer.setPreferredSize(Dimension(20, 20))
self.toolsCombo.setRenderer(renderer)
self.toolsCombo.setToolTipText(
app.strings.getString("Select_a_quality_assurance_tool"))
#ComboBox with categories names ("views"), of the selected tool
self.viewsCombo = JComboBox(actionListener=ViewsComboListener(app))
self.viewsCombo.setToolTipText(
app.strings.getString("Select_a_category_of_error"))
#Popup for checks table
self.checkPopup = JPopupMenu()
#add favourite check
self.menuItemAdd = JMenuItem(
self.app.strings.getString("Add_to_favourites"))
self.menuItemAdd.setIcon(
ImageIcon(
File.separator.join([
self.app.SCRIPTDIR, "tools", "data", "Favourites", "icons",
"tool_16.png"
])))
self.menuItemAdd.addActionListener(PopupActionListener(self.app))
self.checkPopup.add(self.menuItemAdd)
#remove favourite check
self.menuItemRemove = JMenuItem(
self.app.strings.getString("Remove_from_favourites"))
self.menuItemRemove.setIcon(
ImageIcon(
File.separator.join([
self.app.SCRIPTDIR, "tools", "data", "Favourites", "icons",
"black_tool_16.png"
])))
self.menuItemRemove.addActionListener(PopupActionListener(self.app))
self.checkPopup.add(self.menuItemRemove)
#Help link for selected check
self.menuItemHelp = JMenuItem(self.app.strings.getString("check_help"))
self.menuItemHelp.setIcon(
ImageIcon(
File.separator.join(
[self.app.SCRIPTDIR, "images", "icons", "info_16.png"])))
self.checkPopup.add(self.menuItemHelp)
self.menuItemHelp.addActionListener(PopupActionListener(self.app))
#Table with checks of selected tool and view
self.checksTable = JTable()
self.iconrenderer = IconRenderer()
self.iconrenderer.setHorizontalAlignment(JLabel.CENTER)
scrollPane = JScrollPane(self.checksTable)
self.checksTable.setFillsViewportHeight(True)
tableSelectionModel = self.checksTable.getSelectionModel()
tableSelectionModel.addListSelectionListener(ChecksTableListener(app))
self.checksTable.addMouseListener(
ChecksTableClickListener(app, self.checkPopup, self.checksTable))
#Favourite area status indicator
self.favAreaIndicator = JLabel()
self.update_favourite_zone_indicator()
self.favAreaIndicator.addMouseListener(FavAreaIndicatorListener(app))
#label with OSM id of the object currently edited and number of
#errors still to review
self.checksTextFld = JTextField("",
editable=0,
border=None,
background=None)
#checks buttons
btnsIconsDir = File.separator.join([app.SCRIPTDIR, "images", "icons"])
downloadIcon = ImageIcon(
File.separator.join([btnsIconsDir, "download.png"]))
self.downloadBtn = JButton(downloadIcon,
actionPerformed=app.on_downloadBtn_clicked,
enabled=0)
startIcon = ImageIcon(
File.separator.join([btnsIconsDir, "start_fixing.png"]))
self.startBtn = JButton(startIcon,
actionPerformed=app.on_startBtn_clicked,
enabled=0)
self.downloadBtn.setToolTipText(
app.strings.getString("Download_errors_in_this_area"))
self.startBtn.setToolTipText(
app.strings.getString("Start_fixing_the_selected_errors"))
#tab layout
panel1 = JPanel(BorderLayout(0, 1))
comboboxesPnl = JPanel(GridLayout(0, 2, 5, 0))
comboboxesPnl.add(self.toolsCombo)
comboboxesPnl.add(self.viewsCombo)
checksPnl = JPanel(BorderLayout(0, 1))
checksPnl.add(scrollPane, BorderLayout.CENTER)
self.statsPanel = JPanel(BorderLayout(4, 0))
self.statsPanel_def_color = self.statsPanel.getBackground()
self.statsPanel.add(self.checksTextFld, BorderLayout.CENTER)
self.statsPanel.add(self.favAreaIndicator, BorderLayout.LINE_START)
checksPnl.add(self.statsPanel, BorderLayout.PAGE_END)
checksButtonsPnl = JPanel(GridLayout(0, 2, 0, 0))
checksButtonsPnl.add(self.downloadBtn)
checksButtonsPnl.add(self.startBtn)
panel1.add(comboboxesPnl, BorderLayout.PAGE_START)
panel1.add(checksPnl, BorderLayout.CENTER)
panel1.add(checksButtonsPnl, BorderLayout.PAGE_END)
### Second tab: errors fixing ##########################################
#label with error stats
self.errorTextFld = JTextField("",
editable=0,
border=None,
background=None)
#label with current error description
self.errorDesc = JLabel("")
self.errorDesc.setAlignmentX(0.5)
#error buttons
errorInfoBtnIcon = ImageProvider.get("info")
self.errorInfoBtn = JButton(
errorInfoBtnIcon,
actionPerformed=app.on_errorInfoBtn_clicked,
enabled=0)
notErrorIcon = ImageIcon(
File.separator.join([btnsIconsDir, "not_error.png"]))
self.notErrorBtn = JButton(
notErrorIcon,
actionPerformed=app.on_falsePositiveBtn_clicked,
enabled=0)
ignoreIcon = ImageIcon(File.separator.join([btnsIconsDir, "skip.png"]))
self.ignoreBtn = JButton(ignoreIcon,
actionPerformed=app.on_ignoreBtn_clicked,
enabled=0)
correctedIcon = ImageIcon(
File.separator.join([btnsIconsDir, "corrected.png"]))
self.correctedBtn = JButton(
correctedIcon,
actionPerformed=app.on_correctedBtn_clicked,
enabled=0)
nextIcon = ImageIcon(File.separator.join([btnsIconsDir, "next.png"]))
self.nextBtn = JButton(nextIcon,
actionPerformed=app.on_nextBtn_clicked,
enabled=0)
#self.nextBtn.setMnemonic(KeyEvent.VK_RIGHT)
self.errorInfoBtn.setToolTipText(
app.strings.getString("open_error_info_dialog"))
self.notErrorBtn.setToolTipText(
app.strings.getString("flag_false_positive"))
self.ignoreBtn.setToolTipText(
app.strings.getString("Skip_and_don't_show_me_this_error_again"))
self.correctedBtn.setToolTipText(
app.strings.getString("flag_corrected_error"))
self.nextBtn.setToolTipText(app.strings.getString("Go_to_next_error"))
#tab layout
self.panel2 = JPanel(BorderLayout())
self.panel2.add(self.errorTextFld, BorderLayout.PAGE_START)
self.panel2.add(self.errorDesc, BorderLayout.CENTER)
errorButtonsPanel = JPanel(GridLayout(0, 5, 0, 0))
errorButtonsPanel.add(self.errorInfoBtn)
errorButtonsPanel.add(self.notErrorBtn)
errorButtonsPanel.add(self.ignoreBtn)
errorButtonsPanel.add(self.correctedBtn)
errorButtonsPanel.add(self.nextBtn)
self.panel2.add(errorButtonsPanel, BorderLayout.PAGE_END)
#Layout
self.tabbedPane = JTabbedPane()
self.tabbedPane.addTab(self.app.strings.getString("Download"), None,
panel1,
self.app.strings.getString("download_tab"))
mainPnl.add(self.tabbedPane, BorderLayout.CENTER)
self.createLayout(mainPnl, False, None)
def add_data_to_models(self, tool):
"""Add data of a tool to the models of the dialog components
"""
#tools combobox model
if tool == self.app.favouritesTool:
self.toolsComboModel.addElement(JSeparator())
self.toolsComboModel.addElement(tool)
#views combobox model
tool.viewsComboModel = DefaultComboBoxModel()
for view in tool.views:
tool.viewsComboModel.addElement(view.title)
#checks table, one TableModel for each view, of each tool
columns = [
"",
self.app.strings.getString("Check"),
self.app.strings.getString("Errors")
]
for view in tool.views:
tableRows = []
for check in view.checks:
if check.icon is not None:
icon = check.icon
else:
icon = ""
errorsNumber = ""
tableRows.append([icon, check.title, errorsNumber])
view.tableModel = MyTableModel(tableRows, columns)
def update_favourite_zone_indicator(self):
#icon
if self.app.favZone is not None:
self.favAreaIndicator.setIcon(self.app.favZone.icon)
#tooltip
messageArguments = array([self.app.favZone.name], String)
formatter = MessageFormat("")
formatter.applyPattern(
self.app.strings.getString("favAreaIndicator_tooltip"))
msg = formatter.format(messageArguments)
self.favAreaIndicator.setToolTipText(msg)
#status
self.favAreaIndicator.setVisible(self.app.favouriteZoneStatus)
def set_checksTextFld_color(self, color):
"""Change color of textField under checksTable
"""
colors = {
"white": (255, 255, 255),
"black": (0, 0, 0),
"green": (100, 200, 0),
"red": (200, 0, 0)
}
if color == "default":
self.statsPanel.background = self.statsPanel_def_color
self.checksTextFld.foreground = colors["black"]
else:
self.statsPanel.background = colors[color]
self.checksTextFld.foreground = colors["white"]
def change_selection(self, source):
"""Change comboboxes and checks table selections after a
selection has been made by the user
"""
if source in ("menu", "layer", "add favourite"):
self.app.selectionChangedFromMenuOrLayer = True
self.toolsCombo.setSelectedItem(self.app.selectedTool)
self.viewsCombo.setModel(self.app.selectedTool.viewsComboModel)
self.viewsCombo.setSelectedItem(self.app.selectedView.title)
self.checksTable.setModel(self.app.selectedTableModel)
self.refresh_checksTable_columns_geometries()
for i, c in enumerate(self.app.selectedView.checks):
if c == self.app.selectedChecks[0]:
break
self.checksTable.setRowSelectionInterval(i, i)
self.app.selectionChangedFromMenuOrLayer = False
else:
self.app.selectionChangedFromMenuOrLayer = False
if source == "toolsCombo":
self.viewsCombo.setModel(self.app.selectedTool.viewsComboModel)
self.viewsCombo.setSelectedIndex(0)
elif source == "viewsCombo":
self.checksTable.setModel(self.app.selectedTableModel)
self.refresh_checksTable_columns_geometries()
if self.app.selectedView.checks != []: # favourite checks may be none
self.checksTable.setRowSelectionInterval(0, 0)
def refresh_checksTable_columns_geometries(self):
self.checksTable.getColumnModel().getColumn(0).setCellRenderer(
self.iconrenderer)
self.checksTable.getColumnModel().getColumn(0).setMaxWidth(25)
self.checksTable.getColumnModel().getColumn(2).setMaxWidth(60)
def activate_error_tab(self, status):
if status:
if self.tabbedPane.getTabCount() == 1:
self.tabbedPane.addTab(self.app.strings.getString("Fix"), None,
self.panel2,
self.app.strings.getString("fix_tab"))
else:
if self.tabbedPane.getTabCount() == 2:
self.tabbedPane.remove(1)
def update_checks_buttons(self):
"""This method sets the status of downloadBtn and startBtn
"""
#none check selected
if len(self.app.selectedChecks) == 0:
self.downloadBtn.setEnabled(False)
self.startBtn.setEnabled(False)
else:
#some check selected
self.downloadBtn.setEnabled(True)
if len(self.app.selectedChecks) > 1:
self.startBtn.setEnabled(False)
else:
#only one check is selected
self.app.errors = self.app.selectedChecks[0].errors
if self.app.errors is None or len(self.app.errors) == 0:
#errors file has not been downloaded and parsed yet
self.startBtn.setEnabled(False)
else:
#errors file has been downloaded and parsed
if self.app.selectedChecks[0].toDo == 0:
#all errors have been corrected
self.startBtn.setEnabled(False)
else:
self.startBtn.setEnabled(True)
#self.nextBtn.setEnabled(True)
def update_error_buttons(self, mode):
"""This method sets the status of:
ignoreBtn, falsePositiveBtn, correctedBtn, nextBtn
"""
if mode == "new error":
status = True
else:
status = False
if self.app.selectedChecks[0].tool.fixedFeedbackMode is None:
self.correctedBtn.setEnabled(False)
else:
self.correctedBtn.setEnabled(status)
if self.app.selectedChecks[0].tool.falseFeedbackMode is None:
self.notErrorBtn.setEnabled(False)
else:
self.notErrorBtn.setEnabled(status)
self.errorInfoBtn.setEnabled(status)
self.ignoreBtn.setEnabled(status)
if mode in ("reset", "review end"):
self.nextBtn.setEnabled(False)
elif mode in ("errors downloaded", "show stats", "new error"):
self.nextBtn.setEnabled(True)
def update_text_fields(self, mode, errorInfo=""):
"""This method updates the text in:
checksTextFld, errorDesc, errorTextFld
"""
self.errorDesc.text = ""
if mode == "review end":
cheksTextColor = "green"
checksText = self.app.strings.getString("All_errors_reviewed.")
errorText = self.app.strings.getString("All_errors_reviewed.")
elif mode == "reset":
cheksTextColor = "default"
checksText = ""
errorText = ""
elif mode == "show stats":
cheksTextColor = "default"
checksText = "%s %d / %s" % (
self.app.strings.getString("to_do"),
self.app.selectedChecks[0].toDo,
len(self.app.selectedChecks[0].errors))
#print "checks text", checksText
errorText = "%s%s %d / %s" % (
errorInfo, self.app.strings.getString("to_do"),
self.app.selectedChecks[0].toDo,
len(self.app.selectedChecks[0].errors))
#print "error text", errorText
if self.app.selectedError is not None and self.app.selectedError.desc != "":
self.errorDesc.text = "<html>%s</html>" % self.app.selectedError.desc
self.set_checksTextFld_color(cheksTextColor)
self.checksTextFld.text = checksText
self.errorTextFld.text = errorText
self.update_statsPanel_status()
def update_statsPanel_status(self):
if self.checksTextFld.text == "" and not self.app.favouriteZoneStatus:
self.statsPanel.setVisible(False)
else:
self.statsPanel.setVisible(True)
