prajna.structure

Class FilterReasoner

java.lang.Object

prajna.structure.FilterReasoner

All Implemented Interfaces:

java.io.Serializable, RecordReasoner

public class FilterReasoner
extends java.lang.Object
implements RecordReasoner, java.io.Serializable

Reasoner which uses a DataFilter to determine when to augment a DataRecord. The record can be augmented in two ways - adding field values or setting them to preset values. The FilterReasoner maintains two DataRecords, the AddFields record and the SetFields record.

If a record is accepted by the DataFilter, it will augment the record. First, any field value from the AddFields record will be added to the record. Second, any field values which occur in the SetFields record will replace those in the original record. Therefore, if a field occurs in both the AddFields and SetFields records, the SetFields record takes precedence.

As an option, the FilterReasoner includes a clearSetFields flag. If this flag is set, when a record does NOT match the data filter, it will clear the field values matching the fields from the SetFields record. This is particularly useful when the filter is a dynamic filter, such as a GuiDataFilter.

Author:

Edward Swing

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
FilterReasoner(DataFilter dataFilter) Initialize the FilterReasoner with the data filter provided

Method Summary

Methods

Modifier and Type	Method and Description
boolean	augmentRecord(DataRecord rec) Augment the DataRecord.
void	setAddFieldsRecord(DataRecord rec) Set the AddFields record
void	setClearSetFields(boolean flag) Set a flag whether to clear the Set fields if a record does not match.
void	setSetFieldsRecord(DataRecord rec) Set the SetFields record

Methods inherited from class java.lang.Object

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

Constructor Detail

FilterReasoner

public FilterReasoner(DataFilter dataFilter)

Initialize the FilterReasoner with the data filter provided

Parameters:

dataFilter - the DataFilter to use as a filter.

Method Detail

augmentRecord

public boolean augmentRecord(DataRecord rec)

Augment the DataRecord. If the DataFilter accepts the DataRecord, the values from the AddFields record will be added to the DataRecord. Then the values from the SetFields record will replace those in the original data record. Finally, if the clearSetFields flag is set, and the record fails to accept the record, any fields matching those in the SetFields record will be cleared.

Specified by:

augmentRecord in interface RecordReasoner

Parameters:

rec - the DataRecord to augment

Returns:

true if the DataRecord has its field values modified

setAddFieldsRecord

public void setAddFieldsRecord(DataRecord rec)

Set the AddFields record

Parameters:

rec - the AddFields record

setClearSetFields

public void setClearSetFields(boolean flag)

Set a flag whether to clear the Set fields if a record does not match. This is particularly useful when using a dynamic filter which changes state, such as a GuiDataFilter.

Parameters:

flag - if true, and a record does not match the filter, any record fields which occur in the SetFields record will be cleared. T

setSetFieldsRecord

public void setSetFieldsRecord(DataRecord rec)

Set the SetFields record

Parameters:

rec - the SetFields record