org.ka2ddo.yaac.pluginapi

Interface SupportsExtraData

All Known Implementing Classes:

LocalObjectTracker.ObjectLink, StationState

public interface SupportsExtraData

This interface specifies how to generically get the identifier of a record within a record set, and and add, get, and remove extra data from the record. Used by the ExtraColumn implementing code to identify specific records associated with ExtraColumn getValueAt().

Author:

Andrew Pavlin, KA2DDO

Method Summary

Modifier and Type	Method and Description
java.lang.Object	getAttachment(java.lang.Object key) Get a named attachment for this record.
java.lang.Object	getRecordIdentifier() Return the hashable and comparable identifier for the record.
java.lang.Object	putAttachment(java.lang.Object key, java.lang.Object attachment) Add an attachment to this record.
java.lang.Object	removeAttachment(java.lang.Object key) Remove an attachment from this record.

Method Detail

getRecordIdentifier

java.lang.Object getRecordIdentifier()

Return the hashable and comparable identifier for the record.

Returns:

Object that uniquely identifies the record within its GuiContentType domain

getAttachment

java.lang.Object getAttachment(java.lang.Object key)

Get a named attachment for this record.

Parameters:

key - Object identifying the particular attachment

Returns:

the attached data, or null if no attachment with the specified key

putAttachment

java.lang.Object putAttachment(java.lang.Object key,
                               java.lang.Object attachment)
                        throws java.lang.NullPointerException

Add an attachment to this record.

Parameters:

key - Object that will identify this particular attachment

attachment - data to be attached

Returns:

previous attachment under this key, or null if no previous attachment

Throws:

java.lang.NullPointerException - if a null attachment is specified

removeAttachment

java.lang.Object removeAttachment(java.lang.Object key)

Remove an attachment from this record.

Parameters:

key - Object identifying the attachment to be removed

Returns:

whatever attachment was formerly associated with this key, or null if no previous attachment