prajna.gui

Class TimeWindowFilter

java.lang.Object

prajna.data.DataFilter

prajna.gui.GuiDataFilter

prajna.gui.TimeWindowFilter

All Implemented Interfaces:

java.io.Serializable

public class TimeWindowFilter
extends GuiDataFilter

Implementation of a GuiDataFilter which filters records based upon time. The TimeWindowFilter includes components for entering start and stop time. Records match if the designated field has any times within the specified time window.

Author:

Edward Swing

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TimeWindowFilter(java.lang.String fieldName, TimeSpan span) Create a TimeWindowFilter for the specified field.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	accept(DataRecord rec) Return whether the DataRecord is accepted by this filter.
javax.swing.JComponent	getComponent() Return the Graphical User Interface component used for interacting with this DataFilter.
TimeSpan	getTimeSpan() Get the current time window
void	setWidgets(TimeWidget start, TimeWidget stop) Set the widgets used to enter start and stop time.

Methods inherited from class prajna.gui.GuiDataFilter

addChangeListener, fireStateChanged, removeChangeListener

Methods inherited from class prajna.data.DataFilter

filterRecords

Methods inherited from class java.lang.Object

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

Constructor Detail

TimeWindowFilter

public TimeWindowFilter(java.lang.String fieldName,
                TimeSpan span)

Create a TimeWindowFilter for the specified field. The time window is initialized to the specified time span.

Parameters:

fieldName - the field name to match

span - the initial time span for the TimeWindowFilter

Method Detail

accept

public boolean accept(DataRecord rec)

Return whether the DataRecord is accepted by this filter. This filter compares all time values for the specified field to the current time span of the TimeWindowFilter. If any time values overlap the current time window, the record is accepted.

Specified by:

accept in class DataFilter

Parameters:

rec - the data record to match.

Returns:

true if the record matches the filter, false otherwise

getComponent

public javax.swing.JComponent getComponent()

Return the Graphical User Interface component used for interacting with this DataFilter.

Specified by:

getComponent in class GuiDataFilter

Returns:

the component used to render the interface for this DataFilter

getTimeSpan

public TimeSpan getTimeSpan()

Get the current time window

Returns:

the current time window

setWidgets

public void setWidgets(TimeWidget start,
              TimeWidget stop)

Set the widgets used to enter start and stop time. The TimeWindowFilter uses TimeTextFields by default.

Parameters:

start - the TimeWidget used to specify and display start time

stop - the TimeWidget used to specify and display stop time