org.zaproxy.zap.view.table

Class AbstractCustomColumnHistoryReferencesTableModel<T extends HistoryReferencesTableEntry>

java.lang.Object

javax.swing.table.AbstractTableModel

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

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

Type Parameters:

T - the type of table model entries

All Implemented Interfaces:

Serializable, TableModel, HistoryReferencesTableModel<T>

Direct Known Subclasses:

SearchResultsTableModel

public abstract class AbstractCustomColumnHistoryReferencesTableModel<T extends HistoryReferencesTableEntry>
extends AbstractHistoryReferencesTableModel<T>

An abstract implementation of HistoryReferencesTableModel with support for custom columns.

See Also:

Serialized Form

Nested Class Summary

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 and Description
AbstractCustomColumnHistoryReferencesTableModel(HistoryReferencesTableModel.Column[] columns) Constructs an AbstractCustomColumnHistoryReferencesTableModel with the specified columns (in the specified order).

Method Summary

Modifier and Type	Method and Description
protected abstract Class<?>	getColumnClass(HistoryReferencesTableModel.Column column) Returns the Class of the column.
Class<?>	getColumnClass(int columnIndex) Returns the Class of the given column.
String	getColumnName(int columnIndex)
protected abstract Class<?>	getCustomColumnClass(int columnIndex) Returns the Class of the column at the given column index.
protected int	getCustomColumnIndex(int columnIndex) Returns the index of the custom column as if no default columns existed.
protected abstract String	getCustomColumnName(int columnIndex) Returns the name of the column at the given column index.
protected abstract Object	getCustomPrototypeValue(int columnIndex) Returns the prototype value for the column at the given column index.
protected abstract Object	getCustomValueAt(T entry, int columnIndex) Returns the value for the entry at the given column index.
protected abstract Object	getPrototypeValue(HistoryReferencesTableModel.Column column) Returns the prototype value for the given column.
Object	getPrototypeValue(int columnIndex) Returns the prototype value for the given column index.
Object	getValueAt(int rowIndex, int columnIndex)

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 org.zaproxy.zap.view.table.HistoryReferencesTableModel

addEntry, clear, getEntry, getEntryRowIndex, getEntryWithHistoryId, refreshEntryRow, removeEntry

Methods inherited from interface javax.swing.table.TableModel

addTableModelListener, getRowCount, isCellEditable, removeTableModelListener, setValueAt

Constructor Detail

AbstractCustomColumnHistoryReferencesTableModel

public AbstractCustomColumnHistoryReferencesTableModel(HistoryReferencesTableModel.Column[] columns)

Constructs an AbstractCustomColumnHistoryReferencesTableModel with the specified columns (in the specified order).

Parameters:

columns - the columns that will have the model

Throws:

IllegalArgumentException - if columns is null or empty.

Method Detail

getValueAt

public Object getValueAt(int rowIndex,
                         int columnIndex)

Specified by:

getValueAt in interface TableModel

Overrides:

getValueAt in class AbstractHistoryReferencesTableModel<T extends HistoryReferencesTableEntry>

getCustomValueAt

protected abstract Object getCustomValueAt(T entry,
                                           int columnIndex)

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

Parameters:

entry - the entry with the values

columnIndex - the column index

Returns:

the entry value at the specified column index

See Also:

getCustomColumnIndex(int), HistoryReferencesTableModel.Column.CUSTOM

getColumnName

public String getColumnName(int columnIndex)

Specified by:

getColumnName in interface TableModel

Overrides:

getColumnName in class AbstractHistoryReferencesTableModel<T extends HistoryReferencesTableEntry>

getCustomColumnName

protected abstract String getCustomColumnName(int columnIndex)

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

Parameters:

columnIndex - the column index

Returns:

the name of the custom column

See Also:

getCustomColumnIndex(int), HistoryReferencesTableModel.Column.CUSTOM

getColumnClass

public final Class<?> getColumnClass(int columnIndex)

Returns the Class of the given column.

Specified by:

getColumnClass in interface TableModel

Specified by:

getColumnClass in class AbstractHistoryReferencesTableModel<T extends HistoryReferencesTableEntry>

Parameters:

columnIndex - the column being queried

Returns:

the Class of the column

See Also:

getColumnClass(HistoryReferencesTableModel.Column), getCustomColumnClass(int)

getColumnClass

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

Returns the Class of the column.

Parameters:

column - the column

Returns:

the Class of the column

getCustomColumnClass

protected abstract Class<?> getCustomColumnClass(int columnIndex)

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

Parameters:

columnIndex - the column index

Returns:

the Class of the custom column

See Also:

getCustomColumnIndex(int), HistoryReferencesTableModel.Column.CUSTOM

getPrototypeValue

public Object getPrototypeValue(int columnIndex)

Description copied from interface: HistoryReferencesTableModel

Returns the prototype value for the given column index. The prototype value is a possible representation of the values that might exist in the column. It's used to set an expected width for the column.

Parameters:

columnIndex - the column index that will be checked.

Returns:

the prototype value for the column

getPrototypeValue

protected abstract Object getPrototypeValue(HistoryReferencesTableModel.Column column)

Returns the prototype value for the given column.

Parameters:

column - the column

Returns:

the prototype value for the column

getCustomPrototypeValue

protected abstract Object getCustomPrototypeValue(int columnIndex)

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

Parameters:

columnIndex - the column index

Returns:

the prototype value for the column

See Also:

getCustomColumnIndex(int), HistoryReferencesTableModel.Column.CUSTOM

getCustomColumnIndex

protected int getCustomColumnIndex(int columnIndex)

Returns the index of the custom column as if no default columns existed.

Helper method for subclasses to use the column index without worrying of the actual position of the column in relation to default columns.

It can be used, for example, with getCustomColumnClass(int) as:

 protected Class<?> getCustomColumnClass(int columnIndex) {
     switch (getCustomColumnIndex(columnIndex)) {
     case 0:
         // Class of the first custom column
         return String.class;
         break;
     case 1:
         // Class of the second custom column
         return Integer.class;
     default:
         return String.class;
     }
 }
 

Parameters:

columnIndex - the column index

Returns:

the custom column index as if no default columns existed or -1 if not a custom column.