Package org.zaproxy.zap.extension.search

Class SearchResultsTableModel

java.lang.Object

javax.swing.table.AbstractTableModel

org.zaproxy.zap.view.table.AbstractHistoryReferencesTableModel<T>

org.zaproxy.zap.view.table.AbstractCustomColumnHistoryReferencesTableModel<SearchResultsTableModel.SearchResultTableEntry>

org.zaproxy.zap.extension.search.SearchResultsTableModel

All Implemented Interfaces:

java.io.Serializable, javax.swing.table.TableModel, EventConsumer, HistoryReferencesTableModel<SearchResultsTableModel.SearchResultTableEntry>

public class SearchResultsTableModel
extends AbstractCustomColumnHistoryReferencesTableModel<SearchResultsTableModel.SearchResultTableEntry>
implements EventConsumer

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SearchResultsTableModel.SearchResultTableEntry

Nested classes/interfaces inherited from interface org.zaproxy.zap.view.table.HistoryReferencesTableModel

HistoryReferencesTableModel.Column

Field Summary

Fields inherited from class javax.swing.table.AbstractTableModel

listenerList

Constructor Summary

Constructors

Constructor	Description
SearchResultsTableModel()

Method Summary

Modifier and Type	Method	Description
void	addEntry(SearchResultsTableModel.SearchResultTableEntry entry)	Appends the given entry to the end of the entries.
void	addSearchResult(SearchResult sr)
void	clear()	Removes all the entries.
void	eventReceived(Event event)
protected java.lang.Class<?>	getColumnClass(HistoryReferencesTableModel.Column column)	Returns the Class of the column.
protected java.lang.Class<java.lang.String>	getCustomColumnClass(int columnIndex)	Returns the Class of the column at the given column index.
protected java.lang.String	getCustomColumnName(int columnIndex)	Returns the name of the column at the given column index.
protected java.lang.Object	getCustomPrototypeValue(int columnIndex)	Returns the prototype value for the column at the given column index.
protected java.lang.Object	getCustomValueAt(SearchResultsTableModel.SearchResultTableEntry entry, int columnIndex)	Returns the value for the entry at the given column index.
SearchResultsTableModel.SearchResultTableEntry	getEntry(int rowIndex)	Returns the entry at the given rowIndex.
int	getEntryRowIndex(int historyReferenceId)	Returns the row index of the entry with the given historyReferenceId.
SearchResultsTableModel.SearchResultTableEntry	getEntryWithHistoryId(int historyReferenceId)	Returns the entry with the given historyReferenceId.
protected java.lang.Object	getPrototypeValue(HistoryReferencesTableModel.Column column)	Returns the prototype value for the given column.
int	getRowCount()
void	refreshEntryRow(int historyReferenceId)	Notifies the table model listeners that the entry with the given historyReferenceId has changed.
void	removeEntry(int historyReferenceId)	Removes the entry with the given historyReferenceId.

Methods inherited from class org.zaproxy.zap.view.table.AbstractCustomColumnHistoryReferencesTableModel

getColumnClass, getColumnName, getCustomColumnIndex, getPrototypeValue, getValueAt

Methods inherited from class org.zaproxy.zap.view.table.AbstractHistoryReferencesTableModel

getColumn, getColumnCount, getColumnIndex, getColumns, isColumnEnabled, isCustomColumn, isCustomColumn

Methods inherited from class javax.swing.table.AbstractTableModel

addTableModelListener, findColumn, fireTableCellUpdated, fireTableChanged, fireTableDataChanged, fireTableRowsDeleted, fireTableRowsInserted, fireTableRowsUpdated, fireTableStructureChanged, getListeners, getTableModelListeners, isCellEditable, removeTableModelListener, setValueAt

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.swing.table.TableModel

addTableModelListener, isCellEditable, removeTableModelListener, setValueAt

Constructor Detail

SearchResultsTableModel

public SearchResultsTableModel()

Method Detail

addSearchResult

public void addSearchResult(SearchResult sr)

addEntry

public void addEntry(SearchResultsTableModel.SearchResultTableEntry entry)

Description copied from interface: HistoryReferencesTableModel

Appends the given entry to the end of the entries.

Specified by:

addEntry in interface HistoryReferencesTableModel<SearchResultsTableModel.SearchResultTableEntry>

Parameters:

entry - the entry that will be added

refreshEntryRow

public void refreshEntryRow(int historyReferenceId)

Description copied from interface: HistoryReferencesTableModel

Notifies the table model listeners that the entry with the given historyReferenceId has changed.

The call to this method has no effect if there is no entry with the given ID.

Specified by:

refreshEntryRow in interface HistoryReferencesTableModel<SearchResultsTableModel.SearchResultTableEntry>

Parameters:

historyReferenceId - the HistoryReference ID of the entry that has changed

See Also:

TableModelListener

removeEntry

public void removeEntry(int historyReferenceId)

Description copied from interface: HistoryReferencesTableModel

Removes the entry with the given historyReferenceId.

The call to this method has no effect if there is no entry with the given ID.

Specified by:

removeEntry in interface HistoryReferencesTableModel<SearchResultsTableModel.SearchResultTableEntry>

Parameters:

historyReferenceId - the HistoryReference ID of the entry that will be removed

getEntry

public SearchResultsTableModel.SearchResultTableEntry getEntry(int rowIndex)

Description copied from interface: HistoryReferencesTableModel

Returns the entry at the given rowIndex.

Specified by:

getEntry in interface HistoryReferencesTableModel<SearchResultsTableModel.SearchResultTableEntry>

Parameters:

rowIndex - the row index of the entry

Returns:

the entry at the given row index

getEntryWithHistoryId

public SearchResultsTableModel.SearchResultTableEntry getEntryWithHistoryId(int historyReferenceId)

Description copied from interface: HistoryReferencesTableModel

Returns the entry with the given historyReferenceId. If there is no entry with the given ID null is returned.

Specified by:

getEntryWithHistoryId in interface HistoryReferencesTableModel<SearchResultsTableModel.SearchResultTableEntry>

Parameters:

historyReferenceId - the HistoryReference ID of the entry that will be returned

Returns:

the entry with the given HistoryReference ID, or null if there is no entry with the given ID

getEntryRowIndex

public int getEntryRowIndex(int historyReferenceId)

Description copied from interface: HistoryReferencesTableModel

Returns the row index of the entry with the given historyReferenceId. If there is no entry with the given ID -1 is returned.

Specified by:

getEntryRowIndex in interface HistoryReferencesTableModel<SearchResultsTableModel.SearchResultTableEntry>

Parameters:

historyReferenceId - the HistoryReference ID of the entry that will be searched

Returns:

the row index of the entry with the given HistoryReference ID, or -1 if there is no entry with the given ID

clear

public void clear()

Description copied from interface: HistoryReferencesTableModel

Removes all the entries.

Specified by:

clear in interface HistoryReferencesTableModel<SearchResultsTableModel.SearchResultTableEntry>

getRowCount

public int getRowCount()

Specified by:

getRowCount in interface javax.swing.table.TableModel

getColumnClass

protected java.lang.Class<?> getColumnClass(HistoryReferencesTableModel.Column column)

Description copied from class: AbstractCustomColumnHistoryReferencesTableModel

Returns the Class of the column.

Specified by:

getColumnClass in class AbstractCustomColumnHistoryReferencesTableModel<SearchResultsTableModel.SearchResultTableEntry>

Parameters:

column - the column

Returns:

the Class of the column

getPrototypeValue

protected java.lang.Object getPrototypeValue(HistoryReferencesTableModel.Column column)

Description copied from class: AbstractCustomColumnHistoryReferencesTableModel

Returns the prototype value for the given column.

Specified by:

getPrototypeValue in class AbstractCustomColumnHistoryReferencesTableModel<SearchResultsTableModel.SearchResultTableEntry>

Parameters:

column - the column

Returns:

the prototype value for the column

getCustomValueAt

protected java.lang.Object getCustomValueAt(SearchResultsTableModel.SearchResultTableEntry entry,
                                            int columnIndex)

Description copied from class: AbstractCustomColumnHistoryReferencesTableModel

Returns the value for the entry at the given column index. Called when the column is a Column#CUSTOM.

Specified by:

getCustomValueAt in class AbstractCustomColumnHistoryReferencesTableModel<SearchResultsTableModel.SearchResultTableEntry>

Parameters:

entry - the entry with the values

columnIndex - the column index

Returns:

the entry value at the specified column index

See Also:

AbstractCustomColumnHistoryReferencesTableModel.getCustomColumnIndex(int), HistoryReferencesTableModel.Column.CUSTOM

getCustomColumnName

protected java.lang.String getCustomColumnName(int columnIndex)

Description copied from class: AbstractCustomColumnHistoryReferencesTableModel

Returns the name of the column at the given column index. Called when the column is a Column#CUSTOM.

Specified by:

getCustomColumnName in class AbstractCustomColumnHistoryReferencesTableModel<SearchResultsTableModel.SearchResultTableEntry>

Parameters:

columnIndex - the column index

Returns:

the name of the custom column

See Also:

AbstractCustomColumnHistoryReferencesTableModel.getCustomColumnIndex(int), HistoryReferencesTableModel.Column.CUSTOM

getCustomColumnClass

protected java.lang.Class<java.lang.String> getCustomColumnClass(int columnIndex)

Description copied from class: AbstractCustomColumnHistoryReferencesTableModel

Returns the Class of the column at the given column index. Called when the column is a Column#CUSTOM.

Specified by:

getCustomColumnClass in class AbstractCustomColumnHistoryReferencesTableModel<SearchResultsTableModel.SearchResultTableEntry>

Parameters:

columnIndex - the column index

Returns:

the Class of the custom column

See Also:

AbstractCustomColumnHistoryReferencesTableModel.getCustomColumnIndex(int), HistoryReferencesTableModel.Column.CUSTOM

getCustomPrototypeValue

protected java.lang.Object getCustomPrototypeValue(int columnIndex)

Description copied from class: AbstractCustomColumnHistoryReferencesTableModel

Returns the prototype value for the column at the given column index. Called when the column is a Column#CUSTOM.

Specified by:

getCustomPrototypeValue in class AbstractCustomColumnHistoryReferencesTableModel<SearchResultsTableModel.SearchResultTableEntry>

Parameters:

columnIndex - the column index

Returns:

the prototype value for the column

See Also:

AbstractCustomColumnHistoryReferencesTableModel.getCustomColumnIndex(int), HistoryReferencesTableModel.Column.CUSTOM

eventReceived

public void eventReceived(Event event)

Specified by:

eventReceived in interface EventConsumer