2008-02-07 1.1.0

org.eclipse.soda.dk.rfid.inventory.profile
Class RfidInventoryProfile

java.lang.Object
  extended by Profile
      extended by org.eclipse.soda.dk.rfid.inventory.profile.RfidInventoryProfile
All Implemented Interfaces:
RfidInventoryProfileService

public abstract class RfidInventoryProfile
extends Profile
implements RfidInventoryProfileService

RfidInventoryProfile controls RFID tag reading, tag filtering, and aggregation reporting. This profile supports starting and stopping the reading mode, providing tag data in a common format, filtering tags as duplicates or by interest masks, collecting tags into an aggregation report, and marking tag reports with metadata called data extensions. The RfidInventoryProfile can be configured to trigger reading, filtering, and aggregating behavior based on events published by the GpioProfile and ControlProfile. The RfidInventoryProfile class implements the RfidInventoryProfileService and provides the controls for the profile.

The list of exported services:

Version:
1.1.0
See Also:
RfidInventoryProfileService, org.eclipse.soda.dk.profile.service.ProfileService

Field Summary
protected  InterestMasks aggregationInterest
          Define the aggregation interest (InterestMasks) field.
protected  MethodMeasurement aggregationMaskSetting
          The AggregationMaskSetting specifies the definition of tags that should be published on the TagAggregationReport signal.
static java.lang.String CLASS_NAME
          Defines the full class name.
static java.lang.String CONTROL_PROFILE_PREFIX
          Define the control profile prefix configuration key.
protected  java.lang.String controlProfileServiceBitsExternalKey
          Define control profile service bits external key.
protected  java.lang.String controlProfileServiceBitsGetExternalKey
          Define control profile service bits get external key.
protected  java.lang.String controlProfileServiceLongsExternalKey
          Define control profile service longs external key.
protected  java.lang.String controlProfileServiceLongsGetExternalKey
          Define control profile service longs get external key.
protected  MethodMeasurement dataExtensions
          The DataExtensions measurement is a map of metadata to be associated with tag data.
protected  MethodMeasurement duplicateFiltering
          The DuplicateFiltering measurement specifies the state of duplicate tag filtering behavior.
protected  MethodMeasurement duplicateFilteringExpression
          The DuplicateFilteringExpression is an LDAP expression to trigger the behavior of duplicate tag filtering based on input pin and control values.
static java.lang.String GPIO_PROFILE_PREFIX
          Define the gpio profile prefix configuration key.
protected  java.lang.String gpioInput
          Define the gpio input (String) field.
protected  java.lang.String gpioProfileServiceAnalogInputExternalKey
          Define gpio profile service analog input external key.
protected  java.lang.String gpioProfileServiceAnalogInputGetExternalKey
          Define gpio profile service analog input get external key.
protected  java.lang.String gpioProfileServiceInputExternalKey
          Define gpio profile service input external key.
protected  java.lang.String gpioProfileServiceInputGetExternalKey
          Define gpio profile service input get external key.
protected  MethodMeasurement tagAggregating
          The TagAggregating measurement specifies the state of aggregating behavior.
protected  MethodMeasurement tagAggregatingExpression
          The TagAggregatingExpression is an LDAP expression to trigger the behavior of aggregating based on input pin and control values.
protected  Signal tagAggregationReport
          TagAggregationReport is a signal containing a collection of tag data in a map structure.
protected  InterestMasks tagInterest
          Define the tag interest (InterestMasks) field.
protected  MethodMeasurement tagMaskSetting
          The TagMaskSetting specifies the definition of tags that should be published on the TagReport signal.
protected  MethodMeasurement tagReading
          The TagReading measurement specifies the state of reading behavior.
protected  MethodMeasurement tagReadingExpression
          The TagReadingExpression is an LDAP expression to trigger the state of tag reading based on input pin and control values.
protected  Signal tagReport
          TagReport is a signal containing tag data in a map structure.
 
Fields inherited from interface org.eclipse.soda.dk.rfid.inventory.profile.service.RfidInventoryProfileService
AGGREGATION_MASK_SETTING_ERROR_EXTERNAL_KEY, AGGREGATION_MASK_SETTING_EXTERNAL_KEY, AGGREGATION_MASK_SETTING_GET_EXTERNAL_KEY, AGGREGATION_MASK_SETTING_KEY, AGGREGATION_MASK_SETTING_READ_EXTERNAL_KEY, AGGREGATION_MASK_SETTING_WRITE_EXTERNAL_KEY, AggregationMaskSetting, AGGREGATIONMASKSETTING_ERROR_EXTERNAL_KEY, AGGREGATIONMASKSETTING_EXTERNAL_KEY, AGGREGATIONMASKSETTING_GET_EXTERNAL_KEY, AGGREGATIONMASKSETTING_KEY, AGGREGATIONMASKSETTING_READ_EXTERNAL_KEY, AGGREGATIONMASKSETTING_WRITE_EXTERNAL_KEY, ALL_COMMANDS, ALL_MEASUREMENTS, ALL_SIGNALS, ANTENNA_DATA_KEY, Capabilities, CAPABILITIES_ERROR_EXTERNAL_KEY, CAPABILITIES_EXTERNAL_KEY, CAPABILITIES_GET_EXTERNAL_KEY, Configuration, CONFIGURATION_ERROR_EXTERNAL_KEY, CONFIGURATION_EXTERNAL_KEY, CONFIGURATION_GET_EXTERNAL_KEY, COUNT_DATA_KEY, DATA_EXTENSIONS_DATA_KEY, DATA_EXTENSIONS_ERROR_EXTERNAL_KEY, DATA_EXTENSIONS_EXTERNAL_KEY, DATA_EXTENSIONS_GET_EXTERNAL_KEY, DATA_EXTENSIONS_READ_EXTERNAL_KEY, DATA_EXTENSIONS_WRITE_EXTERNAL_KEY, DataExtensions, DATAEXTENSIONS_DATA_KEY, DATAEXTENSIONS_ERROR_EXTERNAL_KEY, DATAEXTENSIONS_EXTERNAL_KEY, DATAEXTENSIONS_GET_EXTERNAL_KEY, DATAEXTENSIONS_READ_EXTERNAL_KEY, DATAEXTENSIONS_WRITE_EXTERNAL_KEY, DEFAULT_READSTOPTIMEOUT, DUPLICATE_FILTERING_ERROR_EXTERNAL_KEY, DUPLICATE_FILTERING_EXPRESSION_ERROR_EXTERNAL_KEY, DUPLICATE_FILTERING_EXPRESSION_EXTERNAL_KEY, DUPLICATE_FILTERING_EXPRESSION_GET_EXTERNAL_KEY, DUPLICATE_FILTERING_EXPRESSION_KEY, DUPLICATE_FILTERING_EXPRESSION_READ_EXTERNAL_KEY, DUPLICATE_FILTERING_EXPRESSION_WRITE_EXTERNAL_KEY, DUPLICATE_FILTERING_EXTERNAL_KEY, DUPLICATE_FILTERING_GET_EXTERNAL_KEY, DUPLICATE_FILTERING_READ_EXTERNAL_KEY, DUPLICATE_FILTERING_WRITE_EXTERNAL_KEY, DuplicateFiltering, DUPLICATEFILTERING_ERROR_EXTERNAL_KEY, DUPLICATEFILTERING_EXTERNAL_KEY, DUPLICATEFILTERING_GET_EXTERNAL_KEY, DUPLICATEFILTERING_READ_EXTERNAL_KEY, DUPLICATEFILTERING_WRITE_EXTERNAL_KEY, DuplicateFilteringExpression, DUPLICATEFILTERINGEXPRESSION_ERROR_EXTERNAL_KEY, DUPLICATEFILTERINGEXPRESSION_EXTERNAL_KEY, DUPLICATEFILTERINGEXPRESSION_GET_EXTERNAL_KEY, DUPLICATEFILTERINGEXPRESSION_KEY, DUPLICATEFILTERINGEXPRESSION_READ_EXTERNAL_KEY, DUPLICATEFILTERINGEXPRESSION_WRITE_EXTERNAL_KEY, Metrics, METRICS_ERROR_EXTERNAL_KEY, METRICS_EXTERNAL_KEY, METRICS_GET_EXTERNAL_KEY, READ_STOP_TIMEOUT, READ_STOP_TIMEOUT_DEFAULT, READER_DATA_KEY, READSTOPTIMEOUT_DEFAULT, READSTOPTIMEOUT_KEY, RfidInventoryProfile, SERVICE_DESCRIPTION, SERVICE_NAME, Status, STATUS_ERROR_EXTERNAL_KEY, STATUS_EXTERNAL_KEY, STATUS_GET_EXTERNAL_KEY, TAG_AGGREGATING_ERROR_EXTERNAL_KEY, TAG_AGGREGATING_EXPRESSION_ERROR_EXTERNAL_KEY, TAG_AGGREGATING_EXPRESSION_EXTERNAL_KEY, TAG_AGGREGATING_EXPRESSION_GET_EXTERNAL_KEY, TAG_AGGREGATING_EXPRESSION_KEY, TAG_AGGREGATING_EXPRESSION_READ_EXTERNAL_KEY, TAG_AGGREGATING_EXPRESSION_WRITE_EXTERNAL_KEY, TAG_AGGREGATING_EXTERNAL_KEY, TAG_AGGREGATING_GET_EXTERNAL_KEY, TAG_AGGREGATING_READ_EXTERNAL_KEY, TAG_AGGREGATING_WRITE_EXTERNAL_KEY, TAG_AGGREGATION_REPORT_ERROR_EXTERNAL_KEY, TAG_AGGREGATION_REPORT_EXTERNAL_KEY, TAG_AGGREGATION_REPORT_TRIGGER_EXTERNAL_KEY, TAG_MASK_SETTING_ERROR_EXTERNAL_KEY, TAG_MASK_SETTING_EXTERNAL_KEY, TAG_MASK_SETTING_GET_EXTERNAL_KEY, TAG_MASK_SETTING_KEY, TAG_MASK_SETTING_READ_EXTERNAL_KEY, TAG_MASK_SETTING_WRITE_EXTERNAL_KEY, TAG_READING_ERROR_EXTERNAL_KEY, TAG_READING_EXPRESSION_ERROR_EXTERNAL_KEY, TAG_READING_EXPRESSION_EXTERNAL_KEY, TAG_READING_EXPRESSION_GET_EXTERNAL_KEY, TAG_READING_EXPRESSION_KEY, TAG_READING_EXPRESSION_READ_EXTERNAL_KEY, TAG_READING_EXPRESSION_WRITE_EXTERNAL_KEY, TAG_READING_EXTERNAL_KEY, TAG_READING_GET_EXTERNAL_KEY, TAG_READING_READ_EXTERNAL_KEY, TAG_READING_WRITE_EXTERNAL_KEY, TAG_REPORT_ERROR_EXTERNAL_KEY, TAG_REPORT_EXTERNAL_KEY, TAG_REPORT_TRIGGER_EXTERNAL_KEY, TagAggregating, TAGAGGREGATING_ERROR_EXTERNAL_KEY, TAGAGGREGATING_EXTERNAL_KEY, TAGAGGREGATING_GET_EXTERNAL_KEY, TAGAGGREGATING_READ_EXTERNAL_KEY, TAGAGGREGATING_WRITE_EXTERNAL_KEY, TagAggregatingExpression, TAGAGGREGATINGEXPRESSION_ERROR_EXTERNAL_KEY, TAGAGGREGATINGEXPRESSION_EXTERNAL_KEY, TAGAGGREGATINGEXPRESSION_GET_EXTERNAL_KEY, TAGAGGREGATINGEXPRESSION_KEY, TAGAGGREGATINGEXPRESSION_READ_EXTERNAL_KEY, TAGAGGREGATINGEXPRESSION_WRITE_EXTERNAL_KEY, TagAggregationReport, TAGAGGREGATIONREPORT_ERROR_EXTERNAL_KEY, TAGAGGREGATIONREPORT_EXTERNAL_KEY, TAGAGGREGATIONREPORT_TRIGGER_EXTERNAL_KEY, TagMaskSetting, TAGMASKSETTING_ERROR_EXTERNAL_KEY, TAGMASKSETTING_EXTERNAL_KEY, TAGMASKSETTING_GET_EXTERNAL_KEY, TAGMASKSETTING_KEY, TAGMASKSETTING_READ_EXTERNAL_KEY, TAGMASKSETTING_WRITE_EXTERNAL_KEY, TagReading, TAGREADING_ERROR_EXTERNAL_KEY, TAGREADING_EXTERNAL_KEY, TAGREADING_GET_EXTERNAL_KEY, TAGREADING_READ_EXTERNAL_KEY, TAGREADING_WRITE_EXTERNAL_KEY, TagReadingExpression, TAGREADINGEXPRESSION_ERROR_EXTERNAL_KEY, TAGREADINGEXPRESSION_EXTERNAL_KEY, TAGREADINGEXPRESSION_GET_EXTERNAL_KEY, TAGREADINGEXPRESSION_KEY, TAGREADINGEXPRESSION_READ_EXTERNAL_KEY, TAGREADINGEXPRESSION_WRITE_EXTERNAL_KEY, TagReport, TAGREPORT_ERROR_EXTERNAL_KEY, TAGREPORT_EXTERNAL_KEY, TAGREPORT_TRIGGER_EXTERNAL_KEY, TAGS_DATA_KEY, TID_DATA_KEY, TIMESTAMP_FIRST_DATA_KEY, TIMESTAMP_LAST_DATA_KEY, TIMESTAMPFIRST_DATA_KEY, TIMESTAMPLAST_DATA_KEY, USERDATA_DATA_KEY
 
Constructor Summary
RfidInventoryProfile()
          Constructs a new instance of the RfidInventoryProfile class.
 
Method Summary
 void activate()
          Activate.
protected  void addTagToCache(java.lang.String key, java.util.Map reads, java.util.Map cache)
           
protected  void applyDataExtensions(java.util.Map rfidData)
           
 void applyTagReadingFalse()
          Apply tag reading false.
 void applyTagReadingTrue()
          Apply tag reading true.
protected abstract  boolean autonomousModeOff()
          Autonomous mode off.
protected abstract  boolean autonomousModeOn()
          Autonomous mode on.
protected  java.util.Map buildOuterTagMessage(java.util.Map tags)
           
protected  java.util.Map buildTagMessage(java.lang.String key, java.util.Map reads)
           
protected  void consumeReadStopCommands()
          Consume read stop commands.
protected  Filter createLdapFilter(java.lang.String filterString)
           
 void deactivate()
          Deactivate.
protected  void evaluateDuplicateFilteringLdapFilter()
          Evaluate duplicate filtering ldap filter.
protected  void evaluateLdapFilters()
          Evaluate ldap filters.
protected  void evaluateTagAggregatingLdapFilter()
          Evaluate tag aggregating ldap filter.
protected  void evaluateTagReadingLdapFilter()
          Evaluate tag reading ldap filter.
 void flushAggregatorCache()
          Flush aggregator cache.
 void flushTagCache()
          Flush tag cache.
 MeasurementService getAggregationMaskSetting()
          The AggregationMaskSetting specifies the definition of tags that should be published on the TagAggregationReport signal.
 int getControlCapacity()
          Gets the control capacity.
 java.lang.String getControlProfilePrefix()
          Get the control profile prefix value.
 MeasurementService getDataExtensions()
          The DataExtensions measurement is a map of metadata to be associated with tag data.
 DeviceService getDefaultDevice()
          Gets the default DeviceService.
 java.lang.String getDefaultKey()
          Gets the default key of the profile.
 MeasurementService getDuplicateFiltering()
          The DuplicateFiltering measurement specifies the state of duplicate tag filtering behavior.
 MeasurementService getDuplicateFilteringExpression()
          The DuplicateFilteringExpression is an LDAP expression to trigger the behavior of duplicate tag filtering based on input pin and control values.
 java.lang.String getGpioProfilePrefix()
          Get the gpio profile prefix value.
 int getMessageCapacity()
          Gets the message capacity.
 int getReadStopTimeout()
          readStopTimeout is a configuration parameter to specify the timeout period in milliseconds that the profile will wait to receive an acknowledgement from the reader after commanding the reader to stop reading.
 MeasurementService getTagAggregating()
          The TagAggregating measurement specifies the state of aggregating behavior.
 MeasurementService getTagAggregatingExpression()
          The TagAggregatingExpression is an LDAP expression to trigger the behavior of aggregating based on input pin and control values.
 SignalService getTagAggregationReport()
          TagAggregationReport is a signal containing a collection of tag data in a map structure.
 MeasurementService getTagMaskSetting()
          The TagMaskSetting specifies the definition of tags that should be published on the TagReport signal.
 MeasurementService getTagReading()
          The TagReading measurement specifies the state of reading behavior.
 MeasurementService getTagReadingExpression()
          The TagReadingExpression is an LDAP expression to trigger the state of tag reading based on input pin and control values.
protected  boolean getTagReadingValue()
          Gets the tag reading value (boolean) value.
 SignalService getTagReport()
          TagReport is a signal containing tag data in a map structure.
protected  void handleControlProfileServiceBits(java.lang.String externalKey, java.util.Dictionary data)
           
protected  void handleControlProfileServiceLongs(java.lang.String externalKey, java.util.Dictionary data)
           
protected  void handleDuplicateFiltering(MeasurementService source, java.lang.Object timestamp, java.lang.Object newValue, java.lang.Object oldValue)
           
protected  void handleGpioProfileServiceAnalogInput(java.lang.String externalKey, java.util.Dictionary data)
          Handle gpio profile service analog input with the specified external key and data parameters.
protected  void handleGpioProfileServiceInput(java.lang.String externalKey, java.util.Dictionary data)
           
 java.lang.Object handleMethodAggregationMaskSetting(int code, Measurement measurement, java.lang.Object data)
          Handle method aggregation mask setting with the specified code, measurement and data parameters and return the Object result.
 java.lang.Object handleMethodDataExtensions(int code, Measurement measurement, java.lang.Object data)
          Handle method data extensions with the specified code, measurement and data parameters and return the Object result.
 java.lang.Object handleMethodDuplicateFiltering(int code, Measurement measurement, java.lang.Object data)
          Handle method duplicate filtering with the specified code, measurement and data parameters and return the Object result.
 java.lang.Object handleMethodDuplicateFilteringExpression(int code, Measurement measurement, java.lang.Object data)
          Handle method duplicate filtering expression with the specified code, measurement and data parameters and return the Object result.
 java.lang.Object handleMethodTagAggregating(int code, Measurement measurement, java.lang.Object data)
          Handle method tag aggregating with the specified code, measurement and data parameters and return the Object result.
 java.lang.Object handleMethodTagAggregatingExpression(int code, Measurement measurement, java.lang.Object data)
          Handle method tag aggregating expression with the specified code, measurement and data parameters and return the Object result.
 java.lang.Object handleMethodTagMaskSetting(int code, Measurement measurement, java.lang.Object data)
          Handle method tag mask setting with the specified code, measurement and data parameters and return the Object result.
 java.lang.Object handleMethodTagReading(int code, Measurement measurement, java.lang.Object data)
          Handle method tag reading with the specified code, measurement and data parameters and return the Object result.
 java.lang.Object handleMethodTagReadingExpression(int code, Measurement measurement, java.lang.Object data)
          Handle method tag reading expression with the specified code, measurement and data parameters and return the Object result.
protected  void handleSetAggregationMaskSetting(Measurement measurement, java.lang.Object data)
          Handle set aggregation mask setting with the specified measurement and data parameters.
protected  void handleSetDataExtensions(Measurement measurement, java.lang.Object newValue)
          Handle set data extensions with the specified measurement and new value parameters.
protected  void handleSetDuplicateFilteringExpression(Measurement measurement, java.lang.Object data)
          Handle set duplicate filtering expression with the specified measurement and data parameters.
protected  void handleSetTagAggregatingExpression(Measurement measurement, java.lang.Object data)
          Handle set tag aggregating expression with the specified measurement and data parameters.
protected  void handleSetTagMaskSetting(Measurement measurement, java.lang.Object data)
          Handle set tag mask setting with the specified measurement and data parameters.
protected  void handleSetTagReading(Measurement measurement, java.lang.Object data)
          Handle set tag reading with the specified measurement and data parameters.
protected  void handleSetTagReadingExpression(Measurement measurement, java.lang.Object data)
          Handle set tag reading expression with the specified measurement and data parameters.
protected  void handleTagAggregating(MeasurementService source, java.lang.Object timestamp, java.lang.Object newValue, java.lang.Object oldValue)
           
 boolean isDeviceNeeded()
          Is device needed.
protected  boolean isDuplicateTag(java.lang.String key)
           
 void measurementChanged(MeasurementService source, java.lang.Object timestamp, java.lang.Object newValue, java.lang.Object oldValue)
          Measurement changed.
protected  java.util.Map mergeMapOverMap(java.util.Map additionalValues, java.util.Map existingValues)
           
 void notificationReceived(java.lang.String externalKey, java.util.Dictionary data)
          Notification received.
protected  void notifyReadStop()
          Notify read stop.
 void notifyTagAggregation()
          Notify tag aggregation.
 void notifyTagRead(java.util.Map tags)
          Notify tag read with the specified tags parameter.
 void notifyTagRead(java.lang.String key, java.util.Map reads)
           
static java.lang.String[] parseDelimitedByToken(java.lang.String target, java.lang.String delimiter)
           
static byte[] parseHexSpaceDelimited(java.lang.String spaceDelimitedHex)
           
static InterestMasks parseInterestMasks(java.lang.String targetTagConfig)
           
protected  void setFilterDuplicatesLdapFilter(Filter filterDuplicatesLdapFilter)
          Sets the filter duplicates ldap filter value.
 void setReadStopTimeout(int readStopTimeout)
          readStopTimeout is a configuration parameter to specify the timeout period in milliseconds that the profile will wait to receive an acknowledgement from the reader after commanding the reader to stop reading.
protected  void setTagAggregatingLdapFilter(Filter tagAggregatingLdapFilter)
          Sets the tag aggregating ldap filter value.
protected  void setTagReadingLdapFilter(Filter tagReadingLdapFilter)
          Sets the tag reading ldap filter value.
 void setup()
           
 void setupNotification()
          Setup notification.
static byte[] toBytes(java.lang.String string)
           
protected  void updateTagInCache(java.lang.String key, java.util.Map reads, java.util.Map cache)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

CLASS_NAME

public static final java.lang.String CLASS_NAME
Defines the full class name.

See Also:
Constant Field Values

GPIO_PROFILE_PREFIX

public static final java.lang.String GPIO_PROFILE_PREFIX
Define the gpio profile prefix configuration key.

See Also:
Constant Field Values

gpioProfileServiceInputExternalKey

protected java.lang.String gpioProfileServiceInputExternalKey
Define gpio profile service input external key.


gpioProfileServiceInputGetExternalKey

protected java.lang.String gpioProfileServiceInputGetExternalKey
Define gpio profile service input get external key.


gpioProfileServiceAnalogInputExternalKey

protected java.lang.String gpioProfileServiceAnalogInputExternalKey
Define gpio profile service analog input external key.


gpioProfileServiceAnalogInputGetExternalKey

protected java.lang.String gpioProfileServiceAnalogInputGetExternalKey
Define gpio profile service analog input get external key.


CONTROL_PROFILE_PREFIX

public static final java.lang.String CONTROL_PROFILE_PREFIX
Define the control profile prefix configuration key.

See Also:
Constant Field Values

controlProfileServiceBitsExternalKey

protected java.lang.String controlProfileServiceBitsExternalKey
Define control profile service bits external key.


controlProfileServiceBitsGetExternalKey

protected java.lang.String controlProfileServiceBitsGetExternalKey
Define control profile service bits get external key.


controlProfileServiceLongsExternalKey

protected java.lang.String controlProfileServiceLongsExternalKey
Define control profile service longs external key.


controlProfileServiceLongsGetExternalKey

protected java.lang.String controlProfileServiceLongsGetExternalKey
Define control profile service longs get external key.


tagReadingExpression

protected final MethodMeasurement tagReadingExpression
The TagReadingExpression is an LDAP expression to trigger the state of tag reading based on input pin and control values.

See Also:
handleMethodTagReadingExpression(int, Measurement, java.lang.Object)

tagReading

protected final MethodMeasurement tagReading
The TagReading measurement specifies the state of reading behavior. When the measurement is true, the reader is reading tags in autonomous mode and the profile reports tag data on the TagReport signal. When the measurement is false, the reader's autonomous mode is not enabled and any unexpected tag data reported by the reader is published on the TagReport error signal. If an LDAP expression is specified for the TagReadingExpression, a publication to write a value to this measurement will result in an exception and will not update the measurement value.

See Also:
handleMethodTagReading(int, Measurement, java.lang.Object)

tagAggregatingExpression

protected final MethodMeasurement tagAggregatingExpression
The TagAggregatingExpression is an LDAP expression to trigger the behavior of aggregating based on input pin and control values.

See Also:
handleMethodTagAggregatingExpression(int, Measurement, java.lang.Object)

tagAggregating

protected final MethodMeasurement tagAggregating
The TagAggregating measurement specifies the state of aggregating behavior. When the measurement value is true, the profile is collecting all tags which pass the Aggregation Mask. When the measurement value is updated to false, the profile publishes the TagAggregationReport signal, clears the aggregation cache, and stops collecting incoming tags. If an LDAP expression is specified for the TagAggregatingExpression, a publication to write a value to this measurement will result in an exception and will not update the measurement value.

See Also:
handleMethodTagAggregating(int, Measurement, java.lang.Object)

tagMaskSetting

protected final MethodMeasurement tagMaskSetting
The TagMaskSetting specifies the definition of tags that should be published on the TagReport signal. A mask is specified by four comma-delimited parameters. The first parameter of a tag mask is a placeholder for future use, and the value is ignored. The second parameter is the pointer value. It is the first bit location of the tag id against which to compare the mask. The third parameter is the length. It specifies the number of bits of the tag id to compare against the mask. The final parameter is the mask value. It is the pattern against which the specified section of the tag id must match to pass the filter. Multiple masks can be specified by separating them with a semi-colon.

See Also:
handleMethodTagMaskSetting(int, Measurement, java.lang.Object)

duplicateFilteringExpression

protected final MethodMeasurement duplicateFilteringExpression
The DuplicateFilteringExpression is an LDAP expression to trigger the behavior of duplicate tag filtering based on input pin and control values.

See Also:
handleMethodDuplicateFilteringExpression(int, Measurement, java.lang.Object)

duplicateFiltering

protected final MethodMeasurement duplicateFiltering
The DuplicateFiltering measurement specifies the state of duplicate tag filtering behavior. When the measurement value is true, the profile signals only the initial report of each tag read during the filtering cycle. When the measurement value is updated to false, the profile clears the cache of tags it has seen during the filtering cycle. While the measurement value is false, the profile does not filter out duplicate tags or cache incoming tags. If an LDAP expression is specified for the DuplicateFilteringExpression, a publication to write a value to this measurement will result in an exception and will not update the measurement value.

See Also:
handleMethodDuplicateFiltering(int, Measurement, java.lang.Object)

aggregationMaskSetting

protected final MethodMeasurement aggregationMaskSetting
The AggregationMaskSetting specifies the definition of tags that should be published on the TagAggregationReport signal. A mask is specified by four comma-delimited parameters. The first parameter of a tag mask is a placeholder for future use, and the value is ignored. The second parameter is the pointer value. It is the first bit location of the tag id against which to compare the mask. The third parameter is the length. It specifies the number of bits of the tag id to compare against the mask. The final parameter is the mask value. It is the pattern against which the specified section of the tag id must match to pass the filter. Multiple masks can be specified by separating them with a semi-colon.

See Also:
handleMethodAggregationMaskSetting(int, Measurement, java.lang.Object)

dataExtensions

protected final MethodMeasurement dataExtensions
The DataExtensions measurement is a map of metadata to be associated with tag data. Data extensions are applied to TagReport data as the signal is published. Data extensions are applied to a TagAggregationReport at the beginning and end of the aggregation cycle. Writing a value to this measurement merges the new map with the current DataExtensions value. Setting the value of the measurement to an empty map clears the value.

See Also:
handleMethodDataExtensions(int, Measurement, java.lang.Object)

tagReport

protected final Signal tagReport
TagReport is a signal containing tag data in a map structure. The report contains one to many tags stored at the "tags" key. It may include data extension metadata stored at the "dataExtensions" key. See the tags and dataExtensions descriptions for details.


tagAggregationReport

protected final Signal tagAggregationReport
TagAggregationReport is a signal containing a collection of tag data in a map structure. The report can contain zero to many tags stored at the "tags" key. It may include data extension metadata stored at the "dataExtensions" key. See the tags and dataExtensions descriptions for details.


gpioInput

protected java.lang.String gpioInput
Define the gpio input (String) field.


tagInterest

protected InterestMasks tagInterest
Define the tag interest (InterestMasks) field.


aggregationInterest

protected InterestMasks aggregationInterest
Define the aggregation interest (InterestMasks) field.

Constructor Detail

RfidInventoryProfile

public RfidInventoryProfile()
Constructs a new instance of the RfidInventoryProfile class.

Method Detail

getGpioProfilePrefix

public java.lang.String getGpioProfilePrefix()
Get the gpio profile prefix value.

Returns:
The gpio profile prefix value.
See Also:
GPIO_PROFILE_PREFIX

getControlProfilePrefix

public java.lang.String getControlProfilePrefix()
Get the control profile prefix value.

Returns:
The control profile prefix value.
See Also:
CONTROL_PROFILE_PREFIX

notificationReceived

public void notificationReceived(java.lang.String externalKey,
                                 java.util.Dictionary data)
Notification received.

Parameters:
externalKey - external key.
data - data.

setupNotification

public void setupNotification()
Setup notification.


measurementChanged

public void measurementChanged(MeasurementService source,
                               java.lang.Object timestamp,
                               java.lang.Object newValue,
                               java.lang.Object oldValue)
Measurement changed.

Parameters:
source - source.
timestamp - timestamp.
newValue - new value.
oldValue - old value.

getDefaultKey

public java.lang.String getDefaultKey()
Gets the default key of the profile.

Returns:
String The default key

getDefaultDevice

public DeviceService getDefaultDevice()
Gets the default DeviceService.

Returns:
DeviceService The default DeviceService.

isDeviceNeeded

public boolean isDeviceNeeded()
Is device needed.

Returns:
The results of this method.

getControlCapacity

public int getControlCapacity()
Gets the control capacity.

Returns:
The control capacity value.

getMessageCapacity

public int getMessageCapacity()
Gets the message capacity.

Returns:
int The message capacity.

getTagReadingExpression

public MeasurementService getTagReadingExpression()
The TagReadingExpression is an LDAP expression to trigger the state of tag reading based on input pin and control values.

Returns:
The tag reading expression value.
See Also:
handleMethodTagReadingExpression(int, Measurement, java.lang.Object)

getTagReading

public MeasurementService getTagReading()
The TagReading measurement specifies the state of reading behavior. When the measurement is true, the reader is reading tags in autonomous mode and the profile reports tag data on the TagReport signal. When the measurement is false, the reader's autonomous mode is not enabled and any unexpected tag data reported by the reader is published on the TagReport error signal. If an LDAP expression is specified for the TagReadingExpression, a publication to write a value to this measurement will result in an exception and will not update the measurement value.

Returns:
The tag reading value.
See Also:
handleMethodTagReading(int, Measurement, java.lang.Object)

getTagAggregatingExpression

public MeasurementService getTagAggregatingExpression()
The TagAggregatingExpression is an LDAP expression to trigger the behavior of aggregating based on input pin and control values.

Returns:
The tag aggregating expression value.
See Also:
handleMethodTagAggregatingExpression(int, Measurement, java.lang.Object)

getTagAggregating

public MeasurementService getTagAggregating()
The TagAggregating measurement specifies the state of aggregating behavior. When the measurement value is true, the profile is collecting all tags which pass the Aggregation Mask. When the measurement value is updated to false, the profile publishes the TagAggregationReport signal, clears the aggregation cache, and stops collecting incoming tags. If an LDAP expression is specified for the TagAggregatingExpression, a publication to write a value to this measurement will result in an exception and will not update the measurement value.

Returns:
The tag aggregating value.
See Also:
handleMethodTagAggregating(int, Measurement, java.lang.Object)

getTagMaskSetting

public MeasurementService getTagMaskSetting()
The TagMaskSetting specifies the definition of tags that should be published on the TagReport signal. A mask is specified by four comma-delimited parameters. The first parameter of a tag mask is a placeholder for future use, and the value is ignored. The second parameter is the pointer value. It is the first bit location of the tag id against which to compare the mask. The third parameter is the length. It specifies the number of bits of the tag id to compare against the mask. The final parameter is the mask value. It is the pattern against which the specified section of the tag id must match to pass the filter. Multiple masks can be specified by separating them with a semi-colon.

Returns:
The tag mask setting value.
See Also:
handleMethodTagMaskSetting(int, Measurement, java.lang.Object)

getDuplicateFilteringExpression

public MeasurementService getDuplicateFilteringExpression()
The DuplicateFilteringExpression is an LDAP expression to trigger the behavior of duplicate tag filtering based on input pin and control values.

Returns:
The duplicate filtering expression value.
See Also:
handleMethodDuplicateFilteringExpression(int, Measurement, java.lang.Object)

getDuplicateFiltering

public MeasurementService getDuplicateFiltering()
The DuplicateFiltering measurement specifies the state of duplicate tag filtering behavior. When the measurement value is true, the profile signals only the initial report of each tag read during the filtering cycle. When the measurement value is updated to false, the profile clears the cache of tags it has seen during the filtering cycle. While the measurement value is false, the profile does not filter out duplicate tags or cache incoming tags. If an LDAP expression is specified for the DuplicateFilteringExpression, a publication to write a value to this measurement will result in an exception and will not update the measurement value.

Returns:
The duplicate filtering value.
See Also:
handleMethodDuplicateFiltering(int, Measurement, java.lang.Object)

getAggregationMaskSetting

public MeasurementService getAggregationMaskSetting()
The AggregationMaskSetting specifies the definition of tags that should be published on the TagAggregationReport signal. A mask is specified by four comma-delimited parameters. The first parameter of a tag mask is a placeholder for future use, and the value is ignored. The second parameter is the pointer value. It is the first bit location of the tag id against which to compare the mask. The third parameter is the length. It specifies the number of bits of the tag id to compare against the mask. The final parameter is the mask value. It is the pattern against which the specified section of the tag id must match to pass the filter. Multiple masks can be specified by separating them with a semi-colon.

Returns:
The aggregation mask setting value.
See Also:
handleMethodAggregationMaskSetting(int, Measurement, java.lang.Object)

getDataExtensions

public MeasurementService getDataExtensions()
The DataExtensions measurement is a map of metadata to be associated with tag data. Data extensions are applied to TagReport data as the signal is published. Data extensions are applied to a TagAggregationReport at the beginning and end of the aggregation cycle. Writing a value to this measurement merges the new map with the current DataExtensions value. Setting the value of the measurement to an empty map clears the value.

Returns:
The data extensions value.
See Also:
handleMethodDataExtensions(int, Measurement, java.lang.Object)

getTagReport

public SignalService getTagReport()
TagReport is a signal containing tag data in a map structure. The report contains one to many tags stored at the "tags" key. It may include data extension metadata stored at the "dataExtensions" key. See the tags and dataExtensions descriptions for details.

Returns:
The tag report value.

getTagAggregationReport

public SignalService getTagAggregationReport()
TagAggregationReport is a signal containing a collection of tag data in a map structure. The report can contain zero to many tags stored at the "tags" key. It may include data extension metadata stored at the "dataExtensions" key. See the tags and dataExtensions descriptions for details.

Returns:
The tag aggregation report value.

setReadStopTimeout

public void setReadStopTimeout(int readStopTimeout)
readStopTimeout is a configuration parameter to specify the timeout period in milliseconds that the profile will wait to receive an acknowledgement from the reader after commanding the reader to stop reading. The profile updates the TagReading measurement to "false" after either a response is received from the reader device or the time specified in readStopTimeout elapses. .

Parameters:
readStopTimeout - The read stop timeout custom parameter.
See Also:
getReadStopTimeout()

getReadStopTimeout

public int getReadStopTimeout()
readStopTimeout is a configuration parameter to specify the timeout period in milliseconds that the profile will wait to receive an acknowledgement from the reader after commanding the reader to stop reading. The profile updates the TagReading measurement to "false" after either a response is received from the reader device or the time specified in readStopTimeout elapses. .

Returns:
read stop timeout custom parameter.
See Also:
setReadStopTimeout(int)

setup

public void setup()
See Also:
org.eclipse.soda.dk.device.Container#setup()

parseDelimitedByToken

public static java.lang.String[] parseDelimitedByToken(java.lang.String target,
                                                       java.lang.String delimiter)
Parameters:
target - The target (String) parameter.
delimiter - The delimiter (String) parameter.
Returns:
Results of the parse comma delimited (String[]) value. The target (String) parameter. The delimiter (String) parameter.

parseHexSpaceDelimited

public static byte[] parseHexSpaceDelimited(java.lang.String spaceDelimitedHex)
Parameters:
spaceDelimitedHex - The space delimited hex (String) parameter.
Returns:
Results of the parse hex space delimited (byte[]) value.

parseInterestMasks

public static InterestMasks parseInterestMasks(java.lang.String targetTagConfig)
Parameters:
targetTagConfig - The target tag config (String) parameter.
Returns:
Results of the parse interest masks (InterestMasks) value. The target tag config (String) parameter.

toBytes

public static byte[] toBytes(java.lang.String string)
                      throws java.lang.RuntimeException
Parameters:
string - The string (String) parameter.
Returns:
Results of the to bytes (byte[]) value. Runtime Exception.
Throws:
java.lang.RuntimeException - Runtime Exception.

activate

public void activate()
Activate.


addTagToCache

protected void addTagToCache(java.lang.String key,
                             java.util.Map reads,
                             java.util.Map cache)
Parameters:
key - The key (String) parameter.
reads - The reads (Map) parameter.
cache - The cache (Map) parameter.

applyDataExtensions

protected void applyDataExtensions(java.util.Map rfidData)
Parameters:
rfidData - The rfid data (Map) parameter.
See Also:
getDataExtensions(), handleMethodDataExtensions(int,Measurement,Object), handleSetDataExtensions(Measurement,Object)

applyTagReadingFalse

public void applyTagReadingFalse()
                          throws java.lang.InterruptedException
Apply tag reading false.

Throws:
java.lang.InterruptedException - Interrupted Exception.

applyTagReadingTrue

public void applyTagReadingTrue()
Apply tag reading true.


autonomousModeOff

protected abstract boolean autonomousModeOff()
Autonomous mode off.

Returns:
Results of the autonomous mode off (boolean) value.

autonomousModeOn

protected abstract boolean autonomousModeOn()
Autonomous mode on.

Returns:
Results of the autonomous mode on (boolean) value.

buildOuterTagMessage

protected java.util.Map buildOuterTagMessage(java.util.Map tags)
Parameters:
tags - The tags (Map) parameter.
Returns:
Results of the build outer tag message (Map) value.

buildTagMessage

protected java.util.Map buildTagMessage(java.lang.String key,
                                        java.util.Map reads)
Parameters:
key - The key (String) parameter.
reads - The reads (Map) parameter.
Returns:
Results of the build tag message (Map) value.
See Also:
buildOuterTagMessage(Map)

consumeReadStopCommands

protected void consumeReadStopCommands()
                                throws java.lang.InterruptedException
Consume read stop commands.

Throws:
java.lang.InterruptedException - Interrupted Exception.

createLdapFilter

protected Filter createLdapFilter(java.lang.String filterString)
                           throws InvalidSyntaxException
Parameters:
filterString - The filter string (String) parameter.
Returns:
Results of the create ldap filter (Filter) value. Invalid Syntax Exception.
Throws:
InvalidSyntaxException - Invalid Syntax Exception.
See Also:
evaluateDuplicateFilteringLdapFilter(), evaluateTagAggregatingLdapFilter(), evaluateTagReadingLdapFilter(), setFilterDuplicatesLdapFilter(Filter), setTagAggregatingLdapFilter(Filter), setTagReadingLdapFilter(Filter)

deactivate

public void deactivate()
Deactivate.


evaluateDuplicateFilteringLdapFilter

protected void evaluateDuplicateFilteringLdapFilter()
Evaluate duplicate filtering ldap filter.


evaluateLdapFilters

protected void evaluateLdapFilters()
                            throws java.lang.InterruptedException
Evaluate ldap filters.

Throws:
java.lang.InterruptedException - Interrupted Exception.

evaluateTagAggregatingLdapFilter

protected void evaluateTagAggregatingLdapFilter()
Evaluate tag aggregating ldap filter.

See Also:
setTagAggregatingLdapFilter(Filter)

evaluateTagReadingLdapFilter

protected void evaluateTagReadingLdapFilter()
Evaluate tag reading ldap filter.

See Also:
setTagReadingLdapFilter(Filter)

flushAggregatorCache

public void flushAggregatorCache()
Flush aggregator cache.


flushTagCache

public void flushTagCache()
Flush tag cache.


getTagReadingValue

protected boolean getTagReadingValue()
Gets the tag reading value (boolean) value.

Returns:
The tag reading value (boolean) value.

handleControlProfileServiceBits

protected void handleControlProfileServiceBits(java.lang.String externalKey,
                                               java.util.Dictionary data)
Parameters:
externalKey - The external key (String) parameter.
data - The data (Dictionary) parameter.

handleControlProfileServiceLongs

protected void handleControlProfileServiceLongs(java.lang.String externalKey,
                                                java.util.Dictionary data)
Parameters:
externalKey - The external key (String) parameter.
data - The data (Dictionary) parameter.

handleDuplicateFiltering

protected void handleDuplicateFiltering(MeasurementService source,
                                        java.lang.Object timestamp,
                                        java.lang.Object newValue,
                                        java.lang.Object oldValue)
Parameters:
source - The source (MeasurementService) parameter.
timestamp - The timestamp (Object) parameter.
newValue - The new value (Object) parameter.
oldValue - The old value (Object) parameter.
See Also:
getDuplicateFiltering(), handleMethodDuplicateFiltering(int,Measurement,Object)

handleGpioProfileServiceAnalogInput

protected void handleGpioProfileServiceAnalogInput(java.lang.String externalKey,
                                                   java.util.Dictionary data)
Handle gpio profile service analog input with the specified external key and data parameters.

Parameters:
externalKey - The external key (String) parameter.
data - The data (Dictionary) parameter.

handleGpioProfileServiceInput

protected void handleGpioProfileServiceInput(java.lang.String externalKey,
                                             java.util.Dictionary data)
Parameters:
externalKey - The external key (String) parameter.
data - The data (Dictionary) parameter.

handleMethodAggregationMaskSetting

public java.lang.Object handleMethodAggregationMaskSetting(int code,
                                                           Measurement measurement,
                                                           java.lang.Object data)
Handle method aggregation mask setting with the specified code, measurement and data parameters and return the Object result.

Parameters:
code - The code (int) parameter.
measurement - The measurement (Measurement) parameter.
data - The data (Object) parameter.
Returns:
Results of the handle method aggregation mask setting (Object) value.

handleMethodDataExtensions

public java.lang.Object handleMethodDataExtensions(int code,
                                                   Measurement measurement,
                                                   java.lang.Object data)
Handle method data extensions with the specified code, measurement and data parameters and return the Object result.

Parameters:
code - The code (int) parameter.
measurement - The measurement (Measurement) parameter.
data - The data (Object) parameter.
Returns:
Results of the handle method data extensions (Object) value.

handleMethodDuplicateFiltering

public java.lang.Object handleMethodDuplicateFiltering(int code,
                                                       Measurement measurement,
                                                       java.lang.Object data)
Handle method duplicate filtering with the specified code, measurement and data parameters and return the Object result.

Parameters:
code - The code (int) parameter.
measurement - The measurement (Measurement) parameter.
data - The data (Object) parameter.
Returns:
Results of the handle method duplicate filtering (Object) value.

handleMethodDuplicateFilteringExpression

public java.lang.Object handleMethodDuplicateFilteringExpression(int code,
                                                                 Measurement measurement,
                                                                 java.lang.Object data)
Handle method duplicate filtering expression with the specified code, measurement and data parameters and return the Object result.

Parameters:
code - The code (int) parameter.
measurement - The measurement (Measurement) parameter.
data - The data (Object) parameter.
Returns:
Results of the handle method duplicate filtering expression (Object) value.

handleMethodTagAggregating

public java.lang.Object handleMethodTagAggregating(int code,
                                                   Measurement measurement,
                                                   java.lang.Object data)
Handle method tag aggregating with the specified code, measurement and data parameters and return the Object result.

Parameters:
code - The code (int) parameter.
measurement - The measurement (Measurement) parameter.
data - The data (Object) parameter.
Returns:
Results of the handle method tag aggregating (Object) value.

handleMethodTagAggregatingExpression

public java.lang.Object handleMethodTagAggregatingExpression(int code,
                                                             Measurement measurement,
                                                             java.lang.Object data)
Handle method tag aggregating expression with the specified code, measurement and data parameters and return the Object result.

Parameters:
code - The code (int) parameter.
measurement - The measurement (Measurement) parameter.
data - The data (Object) parameter.
Returns:
Results of the handle method tag aggregating expression (Object) value.

handleMethodTagMaskSetting

public java.lang.Object handleMethodTagMaskSetting(int code,
                                                   Measurement measurement,
                                                   java.lang.Object data)
Handle method tag mask setting with the specified code, measurement and data parameters and return the Object result.

Parameters:
code - The code (int) parameter.
measurement - The measurement (Measurement) parameter.
data - The data (Object) parameter.
Returns:
Results of the handle method tag mask setting (Object) value.

handleMethodTagReading

public java.lang.Object handleMethodTagReading(int code,
                                               Measurement measurement,
                                               java.lang.Object data)
Handle method tag reading with the specified code, measurement and data parameters and return the Object result.

Parameters:
code - The code (int) parameter.
measurement - The measurement (Measurement) parameter.
data - The data (Object) parameter.
Returns:
Results of the handle method tag reading (Object) value.

handleMethodTagReadingExpression

public java.lang.Object handleMethodTagReadingExpression(int code,
                                                         Measurement measurement,
                                                         java.lang.Object data)
Handle method tag reading expression with the specified code, measurement and data parameters and return the Object result.

Parameters:
code - The code (int) parameter.
measurement - The measurement (Measurement) parameter.
data - The data (Object) parameter.
Returns:
Results of the handle method tag reading expression (Object) value.

handleSetAggregationMaskSetting

protected void handleSetAggregationMaskSetting(Measurement measurement,
                                               java.lang.Object data)
Handle set aggregation mask setting with the specified measurement and data parameters.

Parameters:
measurement - The measurement (Measurement) parameter.
data - The data (Object) parameter.

handleSetDataExtensions

protected void handleSetDataExtensions(Measurement measurement,
                                       java.lang.Object newValue)
Handle set data extensions with the specified measurement and new value parameters.

Parameters:
measurement - The measurement (Measurement) parameter.
newValue - The new value (Object) parameter.

handleSetDuplicateFilteringExpression

protected void handleSetDuplicateFilteringExpression(Measurement measurement,
                                                     java.lang.Object data)
Handle set duplicate filtering expression with the specified measurement and data parameters.

Parameters:
measurement - The measurement (Measurement) parameter.
data - The data (Object) parameter.

handleSetTagAggregatingExpression

protected void handleSetTagAggregatingExpression(Measurement measurement,
                                                 java.lang.Object data)
Handle set tag aggregating expression with the specified measurement and data parameters.

Parameters:
measurement - The measurement (Measurement) parameter.
data - The data (Object) parameter.

handleSetTagMaskSetting

protected void handleSetTagMaskSetting(Measurement measurement,
                                       java.lang.Object data)
Handle set tag mask setting with the specified measurement and data parameters.

Parameters:
measurement - The measurement (Measurement) parameter.
data - The data (Object) parameter.

handleSetTagReading

protected void handleSetTagReading(Measurement measurement,
                                   java.lang.Object data)
Handle set tag reading with the specified measurement and data parameters.

Parameters:
measurement - The measurement (Measurement) parameter.
data - The data (Object) parameter.

handleSetTagReadingExpression

protected void handleSetTagReadingExpression(Measurement measurement,
                                             java.lang.Object data)
Handle set tag reading expression with the specified measurement and data parameters.

Parameters:
measurement - The measurement (Measurement) parameter.
data - The data (Object) parameter.

handleTagAggregating

protected void handleTagAggregating(MeasurementService source,
                                    java.lang.Object timestamp,
                                    java.lang.Object newValue,
                                    java.lang.Object oldValue)
Parameters:
source - The source (MeasurementService) parameter.
timestamp - The timestamp (Object) parameter.
newValue - The new value (Object) parameter.
oldValue - The old value (Object) parameter.
See Also:
getTagAggregating(), handleMethodTagAggregating(int,Measurement,Object)

isDuplicateTag

protected boolean isDuplicateTag(java.lang.String key)
Parameters:
key - The key (String) parameter.
Returns:
Results of the is duplicate tag (boolean) value.

mergeMapOverMap

protected java.util.Map mergeMapOverMap(java.util.Map additionalValues,
                                        java.util.Map existingValues)
Parameters:
additionalValues - The additional values (Map) parameter.
existingValues - The existing values (Map) parameter.
Returns:
Results of the merge map over map (Map) value.

notifyReadStop

protected void notifyReadStop()
Notify read stop.


notifyTagAggregation

public void notifyTagAggregation()
Notify tag aggregation.


notifyTagRead

public void notifyTagRead(java.lang.String key,
                          java.util.Map reads)
Parameters:
key - The key (String) parameter.
reads - The reads (Map) parameter.
See Also:
notifyTagRead(Map)

notifyTagRead

public void notifyTagRead(java.util.Map tags)
Notify tag read with the specified tags parameter.

Parameters:
tags - The tags (Map) parameter.
See Also:
notifyTagRead(String,Map)

setFilterDuplicatesLdapFilter

protected void setFilterDuplicatesLdapFilter(Filter filterDuplicatesLdapFilter)
Sets the filter duplicates ldap filter value. The filter duplicates ldap filter (Filter) parameter.

Parameters:
filterDuplicatesLdapFilter - The filter duplicates ldap filter (Filter) parameter.

setTagAggregatingLdapFilter

protected void setTagAggregatingLdapFilter(Filter tagAggregatingLdapFilter)
Sets the tag aggregating ldap filter value. The tag aggregating ldap filter (Filter) parameter.

Parameters:
tagAggregatingLdapFilter - The tag aggregating ldap filter (Filter) parameter.
See Also:
evaluateTagAggregatingLdapFilter()

setTagReadingLdapFilter

protected void setTagReadingLdapFilter(Filter tagReadingLdapFilter)
Sets the tag reading ldap filter value. The tag reading ldap filter (Filter) parameter.

Parameters:
tagReadingLdapFilter - The tag reading ldap filter (Filter) parameter.
See Also:
evaluateTagReadingLdapFilter()

updateTagInCache

protected void updateTagInCache(java.lang.String key,
                                java.util.Map reads,
                                java.util.Map cache)
Parameters:
key - The key (String) parameter.
reads - The reads (Map) parameter.
cache - The cache (Map) parameter.

2008-02-07 1.1.0

Copyright (c) 2008 IBM. See license in Legal section.