org.ka2ddo.yaac.util

Interface ClearableTableModel

All Known Implementing Classes:

BulletinBoard, DXTableModel, LocalObjectTableModel, MessageModel, RawPacketTableModel, SnifferDataModel

public interface ClearableTableModel

This interface identifies a table model within YAAC whose contents can be completely removed by user request.

Author:

Andrew Pavlin, KA2DDO

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ClearableTableModel.ClearType Enumeration specifying which types of records should be cleared when deleteAllRows is called.

Method Summary

Modifier and Type	Method and Description
int	deleteAllRows(ClearableTableModel.ClearType clearType) Delete all rows from this table.
default java.lang.String	getRecordTypeTag() Get a tag that can be given to the Localizer to return the term for the records to be or that have been deleted.
boolean	tableCanContainPlayback() Identifies whether this table can contain playback (historical) data.
boolean	tableCanContainRealtime() Identifies whether this table can contain realtime data.

Method Detail

deleteAllRows

int deleteAllRows(ClearableTableModel.ClearType clearType)

Delete all rows from this table.

Parameters:

clearType - type of rows to be deleted

Returns:

number of rows deleted

tableCanContainRealtime

boolean tableCanContainRealtime()

Identifies whether this table can contain realtime data.

Returns:

boolean true if table can contain realtime data.

tableCanContainPlayback

boolean tableCanContainPlayback()

Identifies whether this table can contain playback (historical) data.

Returns:

boolean true if table can contain playback data.

getRecordTypeTag

default java.lang.String getRecordTypeTag()

Get a tag that can be given to the Localizer to return the term for the records to be or that have been deleted. Should translate to a plural term, i.e., "messages" rather than "message".

Returns:

tag for looking up in a ResourceBundle