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

java.lang.Object
  Profile
      org.eclipse.soda.dk.rfid.base.profile.RfidBaseProfile
          org.eclipse.soda.dk.rfid.inventory.profile.RfidInventoryProfile

All Implemented Interfaces:

RfidInventoryProfileService

Direct Known Subclasses:

RfidInventoryProfileTester

public abstract class RfidInventoryProfile
extends RfidBaseProfile
implements RfidInventoryProfileService

The RFID Inventory Profile controls Radio Frequency Identification (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 meta data called data extensions. The RfidInventoryProfile can be configured to trigger reading, filtering, and aggregating behavior based on events published by the GpioProfile and ControlProfile. While the main focus of this profile is RFID related devices, this profile can also be implemented by other kinds of devices with "tag"s. For example, Bar Code Readers can implement this profile. The RfidInventoryProfile class implements the RfidInventoryProfileService and provides the controls for the profile.

The list of exported services:

Since:

1.0

Version:

1.2.0

See Also:

RfidInventoryProfileService, See the following specification(s) for more details:

Title:	EPCglobal Low Level Reader Protocol (LLRP)
URL:	http://www.epcglobalinc.org/standards/llrp
Version:	1.0.1
Date:	August 13, 2007
Vendor:	EPCglobal
Comment:	Ratified

Title:	EPCglobal Application Level Events (ALE) Specification
URL:	http://www.epcglobalinc.org/standards/ale/
Version:	1.1
Date:	February 27, 2008
Vendor:	EPCglobal
Comment:	Ratified

Title:	EPCglobal Low Level Reader Protocol (LLRP)
URL:	http://www.epcglobalinc.org/standards/llrp
Version:	1.0.1
Date:	August 13, 2007
Vendor:	EPCglobal
Comment:	Ratified

Title:	EPCglobal Application Level Events (ALE) Specification
URL:	http://www.epcglobalinc.org/standards/ale/
Version:	1.1
Date:	February 27, 2008
Vendor:	EPCglobal
Comment:	Ratified

Field Summary

protected MethodMeasurement	aggregationFilterExpression The optional AggregationFilterExpression specifies the definition of tags that should be published on the "TagAggregationReport" signal.
protected MethodMeasurement	aggregationFinalFilterExpression The optional AggregationFinalFilterExpression specifies the definition of tags that should be published on the "TagAggregationReport" signal.
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.
protected MethodMeasurement	antennaCount The "AntennaCount" is maximum number of antennas supported by this reader.
static java.lang.String	CLASS_NAME Defines the full class name.
protected MethodMeasurement	confidenceScript The "ConfidenceScript" is script to compute the "confidence" value.
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 meta data 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.
static java.lang.String	POSITION_PROFILE_PREFIX Define the position profile prefix configuration key.
protected java.lang.String	positionProfileServiceCoordinateExternalKey Define position profile service coordinate external key.
protected java.lang.String	positionProfileServiceCoordinateGetExternalKey Define position profile service coordinate get external key.
protected MethodMeasurement	readOperations The ReadOperations specifies the definition of read operations block against the tag(s).
protected MethodMeasurement	readOperationsCount The ReadOperationsCount measurement defines the number of read operations supported by this profile.
protected MethodMeasurement	superCacheMaximumSize The "SuperCacheMaximumSize" is maximum number of tags supported by the super cache size.
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 The "TagAggregationReport" is a signal containing a collection of tag data in a map structure.
protected MethodMeasurement	tagAntennaReportLevel The TagAntennaReportLevel measurement specifies the level of tag antenna reporting.
protected MethodMeasurement	tagFilterExpression The optional TagFilterExpression specifies the definition of tags that should be published on the "TagReport" signal.
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	tagPosition The "TagPosition" measurement is a map of meta data to be associated with tag data.
protected MethodMeasurement	tagReading The "TagReading" measurement specifies the state of reading behavior.
protected MethodMeasurement	tagReadingExpression The "TagReadingExpression" is an Lightweight Directory Access Protocol (LDAP) expression to trigger the state of tag reading based on input pin and control values.
protected Signal	tagReport The "TagReport" is a signal containing tag data in a map structure.

Fields inherited from class org.eclipse.soda.dk.rfid.base.profile.RfidBaseProfile

cachedTags, confidenceScriptService, EPC_RAW, ldapMap, LEVEL_ANTENNA, LEVEL_READER, LEVEL_REPORT, LEVEL_TOP, REPORT_LEVEL_ANTENNAS, REPORT_LEVEL_DEFAULT, REPORT_LEVEL_LOW, REPORT_LEVEL_MAXIMUM, REPORT_LEVEL_MINIMUM, REPORT_LEVEL_NORMAL, REPORT_LEVEL_READERS, REPORT_LEVEL_REPORTS, REPORT_LEVEL_SUMMARY, reportLevelValue, StandardScoreDefault, superCache

Fields inherited from interface org.eclipse.soda.dk.rfid.inventory.profile.service.RfidInventoryProfileService

ACCESS_PWD_DATA_KEY, AFI_DATA_KEY, AGGREGATION_FILTER_EXPRESSION_ERROR_EXTERNAL_KEY, AGGREGATION_FILTER_EXPRESSION_EXTERNAL_KEY, AGGREGATION_FILTER_EXPRESSION_GET_EXTERNAL_KEY, AGGREGATION_FILTER_EXPRESSION_KEY, AGGREGATION_FILTER_EXPRESSION_READ_EXTERNAL_KEY, AGGREGATION_FILTER_EXPRESSION_WRITE_EXTERNAL_KEY, AGGREGATION_FINAL_FILTER_EXPRESSION_ERROR_EXTERNAL_KEY, AGGREGATION_FINAL_FILTER_EXPRESSION_EXTERNAL_KEY, AGGREGATION_FINAL_FILTER_EXPRESSION_GET_EXTERNAL_KEY, AGGREGATION_FINAL_FILTER_EXPRESSION_KEY, AGGREGATION_FINAL_FILTER_EXPRESSION_READ_EXTERNAL_KEY, AGGREGATION_FINAL_FILTER_EXPRESSION_WRITE_EXTERNAL_KEY, 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, AggregationFilterExpression, AggregationFinalFilterExpression, AggregationMaskSetting, ALL_COMMANDS, ALL_MEASUREMENTS, ALL_SIGNALS, ANTENNA_COUNT_ERROR_EXTERNAL_KEY, ANTENNA_COUNT_EXTERNAL_KEY, ANTENNA_COUNT_GET_EXTERNAL_KEY, ANTENNA_COUNT_KEY, ANTENNA_COUNT_READ_EXTERNAL_KEY, ANTENNA_COUNT_WRITE_EXTERNAL_KEY, ANTENNA_DATA_KEY, ANTENNA_REPORT_COUNT_DATA_KEY, ANTENNA1_DATA_KEY, ANTENNA2_DATA_KEY, ANTENNA3_DATA_KEY, ANTENNA4_DATA_KEY, AntennaCount, ANTENNAS_MAP_DATA_KEY, BATTERY_CHARGE_LEVEL_DATA_KEY, BATTERY_DATA_KEY, BATTERY_REMAINING_CAPACITY_DATA_KEY, BATTERY_REMAINING_TIME_DATA_KEY, C1G2CRC_DATA_KEY, C1G2PC_DATA_KEY, Capabilities, CAPABILITIES_ERROR_EXTERNAL_KEY, CAPABILITIES_EXTERNAL_KEY, CAPABILITIES_GET_EXTERNAL_KEY, CHANNEL_INDEX_DATA_KEY, CONFIDENCE_DATA_KEY, CONFIDENCE_SCRIPT_ERROR_EXTERNAL_KEY, CONFIDENCE_SCRIPT_EXTERNAL_KEY, CONFIDENCE_SCRIPT_GET_EXTERNAL_KEY, CONFIDENCE_SCRIPT_KEY, CONFIDENCE_SCRIPT_READ_EXTERNAL_KEY, CONFIDENCE_SCRIPT_WRITE_EXTERNAL_KEY, ConfidenceScript, Configuration, CONFIGURATION_ERROR_EXTERNAL_KEY, CONFIGURATION_EXTERNAL_KEY, CONFIGURATION_GET_EXTERNAL_KEY, COUNT_AVERAGE_DATA_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, 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, DuplicateFilteringExpression, DURATION_DATA_KEY, EPC_BANK_DATA_KEY, EPC_URI_DATA_KEY, KEY_DATA_KEY, KILL_PWD_DATA_KEY, LLRP_ACCESS_SPEC_ID_DATA_KEY, LLRP_AIR_PROTOCOL_TAG_DATA_DATA_KEY, LLRP_INVENTORY_PARAMETER_SPEC_ID_DATA_KEY, LLRP_OP_SPEC_NUM_WORDS_WRITTEN_DATA_KEY, LLRP_OP_SPEC_READ_DATA_DATA_KEY, LLRP_OP_SPEC_RESULT_CODE_DATA_KEY, LLRP_OP_SPEC_RESULT_DATA_KEY, LLRP_RO_SPEC_ID_DATA_KEY, LLRP_SPEC_INDEX_DATA_KEY, Metrics, METRICS_ERROR_EXTERNAL_KEY, METRICS_EXTERNAL_KEY, METRICS_GET_EXTERNAL_KEY, NSI_DATA_KEY, PARAMETER_SUBTYPE_DATA_KEY, PEAK_RSSI_AVERAGE_DATA_KEY, PEAK_RSSI_DATA_KEY, PEAK_RSSI_MAXIMUM_AVERAGE_DATA_KEY, PEAK_RSSI_MAXIMUM_DATA_KEY, PEAK_RSSI_MAXIMUM_MEDIAN_DATA_KEY, PEAK_RSSI_MAXIMUM_STANDARD_DEVIATION_DATA_KEY, PEAK_RSSI_MAXIMUM_STANDARD_SCORE_DATA_KEY, PEAK_RSSI_MINIMUM_AVERAGE_DATA_KEY, PEAK_RSSI_MINIMUM_DATA_KEY, PEAK_RSSI_MINIMUM_MEDIAN_DATA_KEY, PEAK_RSSI_MINIMUM_STANDARD_DEVIATION_DATA_KEY, PEAK_RSSI_MINIMUM_STANDARD_SCORE_DATA_KEY, PEAK_RSSI_RANGE_DATA_KEY, PEAK_RSSI_TOTAL_DATA_KEY, POSITION_DATA_KEY, READ_OPERATIONS_COUNT_ERROR_EXTERNAL_KEY, READ_OPERATIONS_COUNT_EXTERNAL_KEY, READ_OPERATIONS_COUNT_GET_EXTERNAL_KEY, READ_OPERATIONS_COUNT_KEY, READ_OPERATIONS_COUNT_READ_EXTERNAL_KEY, READ_OPERATIONS_COUNT_WRITE_EXTERNAL_KEY, READ_OPERATIONS_ERROR_EXTERNAL_KEY, READ_OPERATIONS_EXTERNAL_KEY, READ_OPERATIONS_GET_EXTERNAL_KEY, READ_OPERATIONS_KEY, READ_OPERATIONS_READ_EXTERNAL_KEY, READ_OPERATIONS_WRITE_EXTERNAL_KEY, READ_STOP_TIMEOUT, READ_STOP_TIMEOUT_DEFAULT, READ_STOP_TIMEOUT_PROPERTY, READER_DATA_KEY, READERS_MAP_DATA_KEY, ReadOperations, ReadOperationsCount, REPORTS_MAP_DATA_KEY, RfidInventoryProfile, SERVICE_DESCRIPTION, SERVICE_NAME, Status, STATUS_ERROR_EXTERNAL_KEY, STATUS_EXTERNAL_KEY, STATUS_GET_EXTERNAL_KEY, SUB_CYCLE_NUM_DATA_KEY, SUMMARY_DATA_KEY, SUPER_CACHE_MAXIMUM_SIZE_ERROR_EXTERNAL_KEY, SUPER_CACHE_MAXIMUM_SIZE_EXTERNAL_KEY, SUPER_CACHE_MAXIMUM_SIZE_GET_EXTERNAL_KEY, SUPER_CACHE_MAXIMUM_SIZE_KEY, SUPER_CACHE_MAXIMUM_SIZE_READ_EXTERNAL_KEY, SUPER_CACHE_MAXIMUM_SIZE_WRITE_EXTERNAL_KEY, SuperCacheMaximumSize, 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_ANTENNA_REPORT_LEVEL_ERROR_EXTERNAL_KEY, TAG_ANTENNA_REPORT_LEVEL_EXTERNAL_KEY, TAG_ANTENNA_REPORT_LEVEL_GET_EXTERNAL_KEY, TAG_ANTENNA_REPORT_LEVEL_READ_EXTERNAL_KEY, TAG_ANTENNA_REPORT_LEVEL_WRITE_EXTERNAL_KEY, TAG_COUNT_DATA_KEY, TAG_FILTER_EXPRESSION_ERROR_EXTERNAL_KEY, TAG_FILTER_EXPRESSION_EXTERNAL_KEY, TAG_FILTER_EXPRESSION_GET_EXTERNAL_KEY, TAG_FILTER_EXPRESSION_KEY, TAG_FILTER_EXPRESSION_READ_EXTERNAL_KEY, TAG_FILTER_EXPRESSION_WRITE_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_POSITION_ERROR_EXTERNAL_KEY, TAG_POSITION_EXTERNAL_KEY, TAG_POSITION_GET_EXTERNAL_KEY, TAG_POSITION_READ_EXTERNAL_KEY, TAG_POSITION_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_SUB_CYCLE_DELTA, TAG_READING_SUB_CYCLE_DELTA_DEFAULT, TAG_READING_SUB_CYCLE_DELTA_PROPERTY, TAG_READING_SUB_CYCLE_INTERVAL, TAG_READING_SUB_CYCLE_INTERVAL_DEFAULT, TAG_READING_SUB_CYCLE_INTERVAL_PROPERTY, TAG_READING_SUB_CYCLE_LENGTH, TAG_READING_SUB_CYCLE_LENGTH_DEFAULT, TAG_READING_SUB_CYCLE_LENGTH_PROPERTY, TAG_READING_SUB_CYCLE_MODE, TAG_READING_SUB_CYCLE_MODE_AUTO, TAG_READING_SUB_CYCLE_MODE_DEFAULT, TAG_READING_SUB_CYCLE_MODE_PERIOD, TAG_READING_SUB_CYCLE_MODE_PROPERTY, TAG_READING_SUB_CYCLE_NUM, TAG_READING_SUB_CYCLE_NUM_DEFAULT, TAG_READING_SUB_CYCLE_NUM_PROPERTY, TAG_READING_WRITE_EXTERNAL_KEY, TAG_REPORT_ERROR_EXTERNAL_KEY, TAG_REPORT_EXTERNAL_KEY, TAG_REPORT_TRIGGER_EXTERNAL_KEY, TAG_TYPE_DATA_KEY, TagAggregating, TagAggregatingExpression, TagAggregationReport, TagAntennaReportLevel, TagFilterExpression, TagMaskSetting, TagPosition, TagReading, TAGREADING_SUBCYCLE_MODE_AUTO, TAGREADING_SUBCYCLE_MODE_NULL, TAGREADING_SUBCYCLE_MODE_PERIOD, TagReadingExpression, TagReport, TAGS_DATA_KEY, TID_BANK_DATA_KEY, TID_DATA_KEY, TIMESTAMP_FIRST_DATA_KEY, TIMESTAMP_FIRST_UPTIME_DATA_KEY, TIMESTAMP_LAST_DATA_KEY, TIMESTAMP_LAST_UPTIME_DATA_KEY, TOTAL_SUB_CYCLES_DATA_KEY, USER_BANK_DATA_KEY, USERDATA_DATA_KEY, VENDOR_EXTENSIONS_DATA_KEY, VENDOR_IDENTIFIER_DATA_KEY, VENDOR_PARAMETER_VALUE_DATA_KEY

Constructor Summary

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

Method Summary

void	activate() Activate.
protected void	applyDataExtensions(java.util.Map rfidData) Apply data extensions with the specified RFID data parameter.
protected void	applyDataExtensionsSingleTag(java.util.Map rfidData) Apply data extensions single tag with the specified RFID data parameter.
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) Build outer tag message with the specified tags parameter and return the Map result.
protected java.util.Map	buildOuterTagMessageForSubCycles(java.util.Map tags) Build outer tag message for sub cycles with the specified tags parameter and return the Map result.
protected java.util.Map	buildTagMessage(java.lang.String key, java.util.Map reads) Build tag message with the specified key and reads parameters and return the Map result.
protected void	consumeReadStopCommands() Consume read stop commands.
void	deactivate() Deactivate.
boolean	evaluateAggregationLdapFilter(java.util.Dictionary tagLdapMap) Evaluate aggregation LDAP filter with the specified tag LDAP map parameter and return the boolean result.
void	evaluateDuplicateFilteringLdapFilter() Evaluate duplicate filtering LDAP filter.
void	evaluateDuplicateFilteringLdapFilter(boolean duplicateFilteringResult) Evaluate duplicate filtering LDAP filter.
protected void	evaluateLdapFilters(ExpressionFilterResults expressionFilterResults) Evaluate LDAP filters.
void	evaluateTagAggregatingLdapFilter() Evaluate tag aggregating LDAP filter.
void	evaluateTagAggregatingLdapFilter(boolean tagAggregatingResult) Evaluate tag aggregating LDAP filter.
boolean	evaluateTagLdapFilter(java.util.Dictionary tagLdapMap) Evaluate tag LDAP filter with the specified tag LDAP map parameter and return the boolean result.
void	evaluateTagReadingLdapFilter() Evaluate tag reading LDAP filter.
void	evaluateTagReadingLdapFilter(boolean tagReadingResult) Evaluate tag reading LDAP filter.
void	exit() Exit.
java.util.Map	filterMap(java.util.Map map, Filter filter) Filter map with the specified map and filter parameters and return the Map result.
void	flushAggregationCache() Flush aggregation cache.
MeasurementService	getAggregationFilterExpression() The optional AggregationFilterExpression specifies the definition of tags that should be published on the "TagAggregationReport" signal.
MeasurementService	getAggregationFinalFilterExpression() The optional AggregationFinalFilterExpression specifies the definition of tags that should be published on the "TagAggregationReport" signal.
Filter	getAggregationFinalLdapFilter() Gets the aggregation final ldap filter (Filter) value.
Filter	getAggregationLdapFilter() Gets the aggregation ldap filter (Filter) value.
MeasurementService	getAggregationMaskSetting() The AggregationMaskSetting specifies the definition of tags that should be published on the TagAggregationReport signal.
MeasurementService	getAntennaCount() The "AntennaCount" is maximum number of antennas supported by this reader.
MeasurementService	getConfidenceScript() The "ConfidenceScript" is script to compute the "confidence" value.
int	getControlCapacity() Gets the control capacity (int) value.
java.lang.String	getControlProfilePrefix() Get the control profile prefix value.
MeasurementService	getDataExtensions() The DataExtensions measurement is a map of meta data to be associated with tag data.
DeviceService	getDefaultDevice() Gets the default device (DeviceService) value.
java.lang.String	getDefaultKey() Gets the default key (String) value.
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.
Filter	getDuplicateFilteringLdapFilter() Gets the duplicate filtering ldap filter (Filter) value.
java.lang.String	getGpioProfilePrefix() Get the GPIO profile prefix value.
int	getMessageCapacity() Gets the message capacity (int) value.
java.lang.String	getPositionProfilePrefix() Get the position profile prefix value.
MeasurementService	getReadOperations() The ReadOperations specifies the definition of read operations block against the tag(s).
MeasurementService	getReadOperationsCount() The ReadOperationsCount measurement defines the number of read operations supported by this profile.
int	getReadStopTimeout() readStopTimeout is a configuration parameter to specify the timeout period in milliseconds that the profile will wait to receive an acknowledgment from the reader after commanding the reader to stop reading.
MeasurementService	getReportLevel() Gets the report level (MeasurementService) value.
MeasurementService	getSuperCacheMaximumSize() The "SuperCacheMaximumSize" is maximum number of tags supported by the super cache size.
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() The "TagAggregationReport" is a signal containing a collection of tag data in a map structure.
MeasurementService	getTagAntennaReportLevel() The TagAntennaReportLevel measurement specifies the level of tag antenna reporting.
MeasurementService	getTagFilterExpression() The optional TagFilterExpression specifies the definition of tags that should be published on the "TagReport" signal.
Filter	getTagLdapFilter() Gets the tag ldap filter (Filter) value.
MeasurementService	getTagMaskSetting() The "TagMaskSetting" specifies the definition of tags that should be published on the "TagReport" signal.
MeasurementService	getTagPosition() The "TagPosition" measurement is a map of meta data to be associated with tag data.
MeasurementService	getTagReading() The "TagReading" measurement specifies the state of reading behavior.
MeasurementService	getTagReadingExpression() The "TagReadingExpression" is an Lightweight Directory Access Protocol (LDAP) expression to trigger the state of tag reading based on input pin and control values.
long	getTagReadingSubCycleDelta() tagReadingSubCycleDelta specifies that if the time between the two reports of any tag exceeds this parameter, the sub cycle will be stopped.
long	getTagReadingSubCycleInterval() tagReadingSubCycleInterval specifies the period length of the interval between sub cycles, no interval if the value is less than or equal to 0.
long	getTagReadingSubCycleLength() tagReadingSubCycleLength is a configuration parameter to specify the period length in milliseconds for each sub cycle, for "auto" mode, it is the timeout value.
java.lang.String	getTagReadingSubCycleMode() tagReadingSubCycleMode is a configuration parameter to specify that if one tag reading cycle should contain sub cycles.
int	getTagReadingSubCycleNum() tagReadingSubCycleNum is a configuration parameter to specify the number of the sub cycles in each reading cycle, it is only applicable when "tagReadingSubCycleMode" is not "null".
protected boolean	getTagReadingValue() Gets the tag reading value (boolean) value.
SignalService	getTagReport() The "TagReport" is a signal containing tag data in a map structure.
protected void	handleControlProfileServiceBits(java.lang.String externalKey, java.util.Dictionary data) Handle control profile service bits with the specified external key and data parameters.
protected void	handleControlProfileServiceLongs(java.lang.String externalKey, java.util.Dictionary data) Handle control profile service longs with the specified external key and data parameters.
protected void	handleDuplicateFiltering(MeasurementService source, java.lang.Object timestamp, java.lang.Object newValue, java.lang.Object oldValue) Handle duplicate filtering with the specified source, timestamp, new value and old value parameters.
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) Handle GPIO profile service input with the specified external key and data parameters.
java.lang.Object	handleMethodAggregationFilterExpression(int code, Measurement measurement, java.lang.Object data) Handle method aggregation filter expression with the specified code, measurement and data parameters and return the Object result.
java.lang.Object	handleMethodAggregationFinalFilterExpression(int code, Measurement measurement, java.lang.Object data) Handle method aggregation final filter expression with the specified code, measurement and data parameters and return the Object result.
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	handleMethodAntennaCount(int code, Measurement measurement, java.lang.Object data) Handle method antenna count with the specified code, measurement and data parameters and return the Object result.
java.lang.Object	handleMethodConfidenceScript(int code, Measurement measurement, java.lang.Object data) Handle method confidence script 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	handleMethodReadOperations(int code, Measurement measurement, java.lang.Object data) Handle method read operations with the specified code, measurement and data parameters and return the Object result.
java.lang.Object	handleMethodReadOperationsCount(int code, Measurement measurement, java.lang.Object data) Handle method read operations count with the specified code, measurement and data parameters and return the Object result.
java.lang.Object	handleMethodSuperCacheMaximumSize(int code, Measurement measurement, java.lang.Object data) Handle method super cache maximum size 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	handleMethodTagAntennaReportLevel(int code, Measurement measurement, java.lang.Object data) Handle method tag antenna report level with the specified code, measurement and data parameters and return the Object result.
java.lang.Object	handleMethodTagFilterExpression(int code, Measurement measurement, java.lang.Object data) Handle method tag filter 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	handleMethodTagPosition(int code, Measurement measurement, java.lang.Object data) Handle method tag position 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	handlePositionProfileServiceCoordinate(java.lang.String externalKey, java.util.Dictionary data) Handle position profile service coordinate with the specified external key and data parameters.
protected void	handleSetAggregationFilterExpression(Measurement measurement, java.lang.Object data) Handle set aggregation filter expression with the specified measurement and data parameters.
protected void	handleSetAggregationFinalFilterExpression(Measurement measurement, java.lang.Object data) Handle set aggregation final filter expression with the specified measurement and data parameters.
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	handleSetReadOperations(Measurement measurement, java.lang.Object data) Handle set read operations 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	handleSetTagFilterExpression(Measurement measurement, java.lang.Object data) Handle set tag filter 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) Handle tag aggregating with the specified source, timestamp, new value and old value parameters.
void	improveReportMap(java.lang.String key, java.util.Map reads, java.lang.Object timestamp, int tagAntennaReportLevelValue) Improve reads map with the specified reads and timestamp parameters.
boolean	isDeviceNeeded() Is device needed.
protected boolean	isDuplicateTag(java.lang.String key) Is duplicate tag with the specified key parameter and return the boolean result.
void	measurementChanged(MeasurementService source, java.lang.Object timestamp, java.lang.Object newValue, java.lang.Object oldValue) Measurement changed.
long	mergeAntennaInfo(java.util.Map targetMap, java.util.Map sourceMap, int antenna) Merge antenna info with the specified cache read data and reads parameters.
java.util.Map	mergeMapOverMap(java.util.Map additionalValues, java.util.Map existingValues) Merge map over map with the specified additional values and existing values parameters and return the Map result.
void	notificationReceived(java.lang.String externalKey, java.util.Dictionary data) Notification received.
protected void	notifyReadStop() Notify read stop.
void	notifyTagAggregation() Notify tag aggregation.
void	notifyTagAggregation(ChannelService channel, java.lang.Object timestamp) Notify tag aggregation with the specified channel and time stamp parameters.
void	notifyTagRead(java.util.Map tags) Notify tag read with the specified tags parameter.
void	notifyTagRead(java.util.Map tags, java.lang.Object timestamp) Notify tag read with the specified tags and timestamp parameters.
void	notifyTagRead(java.lang.String key, java.util.Map reads) Notify tag read with the specified key and reads parameters.
void	notifyTagRead(java.lang.String key, java.util.Map reads, java.lang.Object timestamp) Notify tag read with the specified key, reads and timestamp parameters.
protected void	performSubCycles() Perform sub cycles.
void	setAggregationFinalLdapFilter(Filter aggregationFinalLdapFilter) Sets the aggregation final ldap filter value.
void	setAggregationLdapFilter(Filter aggregationLdapFilter) Sets the aggregation ldap filter value.
void	setDuplicateFilteringLdapFilter(Filter duplicateFilteringLdapFilter) Sets the duplicate filtering ldap filter value.
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 acknowledgment from the reader after commanding the reader to stop reading.
void	setTagAggregatingLdapFilter(Filter tagAggregatingLdapFilter) Sets the tag aggregating ldap filter value.
void	setTagLdapFilter(Filter tagLdapFilter) Sets the tag ldap filter value.
void	setTagReadingLdapFilter(Filter tagReadingLdapFilter) Sets the tag reading ldap filter value.
void	setTagReadingSubCycleDelta(long tagReadingSubCycleDelta) tagReadingSubCycleDelta specifies that if the time between the two reports of any tag exceeds this parameter, the sub cycle will be stopped.
void	setTagReadingSubCycleInterval(long tagReadingSubCycleInterval) tagReadingSubCycleInterval specifies the period length of the interval between sub cycles, no interval if the value is less than or equal to 0.
void	setTagReadingSubCycleLength(long tagReadingSubCycleLength) tagReadingSubCycleLength is a configuration parameter to specify the period length in milliseconds for each sub cycle, for "auto" mode, it is the timeout value.
void	setTagReadingSubCycleMode(java.lang.String tagReadingSubCycleMode) tagReadingSubCycleMode is a configuration parameter to specify that if one tag reading cycle should contain sub cycles.
void	setTagReadingSubCycleNum(int tagReadingSubCycleNum) tagReadingSubCycleNum is a configuration parameter to specify the number of the sub cycles in each reading cycle, it is only applicable when "tagReadingSubCycleMode" is not "null".
void	setup()
void	setupNotification() Setup notification.
protected void	startSubCycleController() Start sub cycle controller.
protected byte[]	strToBytes(java.lang.String str) Str to bytes with the specified str parameter and return the byte[] result.
protected void	triggerTagAggregationReport(ChannelService channel, java.util.Map tagMap, java.lang.Object timestamp) Trigger tag aggregation report with the specified channel, tag map and time stamp parameters.
protected void	triggerTagAggregationReport(java.util.Map tagMap, boolean withError) Trigger tag aggregation report with the specified tag map and with error parameters.
protected void	triggerTagAggregationReportError(ChannelService channel, java.util.Map tagMap, java.lang.Object timestamp) Trigger tag aggregation report error with the specified channel, tag map and time stamp parameters.
protected void	triggerTagReport(ChannelService channel, java.util.Map tagMap, java.lang.Object timestamp) Trigger tag report with the specified channel, tag map and time stamp parameters.
protected void	triggerTagReport(java.util.Map tagMap, boolean withError) Trigger tag report with the specified tag map and with error parameters.
protected void	triggerTagReport(java.util.Map tagMap, boolean withError, java.lang.Object timestamp) Trigger tag report with the specified tag map, with error and timestamp parameters.
protected void	updateSubCycleCache(java.lang.String tagId, java.lang.Object timestamp) Update sub cycle cache with the specified tag ID and time stamp parameters.

Methods inherited from class org.eclipse.soda.dk.rfid.base.profile.RfidBaseProfile

addTagToCache, buildSummary, checkSuperCache, computeAntennaFactor, computeAverageRssi, computeMedianRssi, computeStandardDeviationRssi, createLdapFilter, flushTagCache, getConfidenceScriptService, getReaderId, getReportLevelValue, getStandardScoreDefault, getSuperCache, getSuperCacheMaximumSizeValue, improveReportMapConstaints, parseDelimitedByToken, parseHexSpaceDelimited, parseInterestMasks, setConfidenceScriptService, setReportLevelValue, setSuperCache, toBytes, updateFieldTotal, updateMap, updateSuperCache, updateTagInCache

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.

Since:

1.0

See Also:

Constant Field Values

GPIO_PROFILE_PREFIX

public static final java.lang.String GPIO_PROFILE_PREFIX

Define the GPIO profile prefix configuration key.

Since:

1.0

See Also:

Constant Field Values

CONTROL_PROFILE_PREFIX

public static final java.lang.String CONTROL_PROFILE_PREFIX

Define the control profile prefix configuration key.

Since:

1.0

See Also:

Constant Field Values

POSITION_PROFILE_PREFIX

public static final java.lang.String POSITION_PROFILE_PREFIX

Define the position profile prefix configuration key.

Since:

1.1

See Also:

Constant Field Values

gpioProfileServiceInputExternalKey

protected java.lang.String gpioProfileServiceInputExternalKey

Define GPIO profile service input external key.

Since:

1.0

gpioProfileServiceInputGetExternalKey

protected java.lang.String gpioProfileServiceInputGetExternalKey

Define GPIO profile service input get external key.

Since:

1.0

gpioProfileServiceAnalogInputExternalKey

protected java.lang.String gpioProfileServiceAnalogInputExternalKey

Define GPIO profile service analog input external key.

Since:

1.1

gpioProfileServiceAnalogInputGetExternalKey

protected java.lang.String gpioProfileServiceAnalogInputGetExternalKey

Define GPIO profile service analog input get external key.

Since:

1.1

controlProfileServiceBitsExternalKey

protected java.lang.String controlProfileServiceBitsExternalKey

Define control profile service bits external key.

Since:

1.0

controlProfileServiceBitsGetExternalKey

protected java.lang.String controlProfileServiceBitsGetExternalKey

Define control profile service bits get external key.

Since:

1.0

controlProfileServiceLongsExternalKey

protected java.lang.String controlProfileServiceLongsExternalKey

Define control profile service longs external key.

Since:

1.0

controlProfileServiceLongsGetExternalKey

protected java.lang.String controlProfileServiceLongsGetExternalKey

Define control profile service longs get external key.

Since:

1.0

positionProfileServiceCoordinateExternalKey

protected java.lang.String positionProfileServiceCoordinateExternalKey

Define position profile service coordinate external key.

Since:

1.1

positionProfileServiceCoordinateGetExternalKey

protected java.lang.String positionProfileServiceCoordinateGetExternalKey

Define position profile service coordinate get external key.

Since:

1.1

tagReadingExpression

protected final MethodMeasurement tagReadingExpression

The "TagReadingExpression" is an Lightweight Directory Access Protocol (LDAP) expression to trigger the state of tag reading based on input pin and control values.

Since:

1.0

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.

Since:

1.0

tagAggregatingExpression

protected final MethodMeasurement tagAggregatingExpression

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

Since:

1.0

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.

Since:

1.0

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 place holder 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 specified as a hex string with each byte (two characters) separated by a blank. 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 semicolon.

Since:

1.0

tagFilterExpression

protected final MethodMeasurement tagFilterExpression

The optional TagFilterExpression specifies the definition of tags that should be published on the "TagReport" signal. The filter expression is an LDAP expression. The keys in the LDAP expression are the keys defined in the "TagReport". If the tag passes the "TagMaskSetting" and the results of the LDAP expression is true, then the tag will be reported in the "TagReport".

Since:

1.1

aggregationFilterExpression

protected final MethodMeasurement aggregationFilterExpression

The optional AggregationFilterExpression specifies the definition of tags that should be published on the "TagAggregationReport" signal. The filter expression is an LDAP expression. The keys in the LDAP expression are the keys defined in the "TagReport". If the tag passes the "AggregationMaskSetting" and the result of the LDAP expression is true, then the tag will be reported in the "TagAggregationReport". If the filtering can be done by the "AggregationMaskSetting", then this would be better than using this LDAP filter.

Since:

1.1

aggregationFinalFilterExpression

protected final MethodMeasurement aggregationFinalFilterExpression

The optional AggregationFinalFilterExpression specifies the definition of tags that should be published on the "TagAggregationReport" signal. The filter expression is an LDAP expression. The keys in the LDAP expression are the keys defined in the "TagReport". Before the "TagAggregationReport" is published, this LDAP filter will be applied to all tags in the current tag aggregation. If the result of the LDAP filter is true, then the tag will be included in the report. If the filtering can be done by the "AggregationMaskSetting", then this would be better than using this LDAP filter.

Since:

1.1

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.

Since:

1.0

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.

Since:

1.0

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 place holder 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 specified as a hex string with each byte (two characters) separated by a blank. 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 semicolon.

Since:

1.0

dataExtensions

protected final MethodMeasurement dataExtensions

The DataExtensions measurement is a map of meta data 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.

Since:

1.0

tagPosition

protected final MethodMeasurement tagPosition

The "TagPosition" measurement is a map of meta data to be associated with tag data. "TagPosition" extensions are applied to "TagReport" data as the signal is published. "TagPosition" 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 "TagPosition" value. Setting the value of the measurement to an empty map clears the value.

Since:

1.1

tagAntennaReportLevel

protected final MethodMeasurement tagAntennaReportLevel

The TagAntennaReportLevel measurement specifies the level of tag antenna reporting. The higher the value, the more tag antenna information is reported in tag data on the "TagReport" and "TagAggregationReport" signals but the extra processing is required which may effect performance.

Since:

1.1

readOperations

protected final MethodMeasurement readOperations

The ReadOperations specifies the definition of read operations block against the tag(s). A read operation block can contain multiple read operations separated by the character ",". A read operation is specified by parameters based on the operation, the parameters are separated by the character ";". The first parameter specifies the kind of read operation. <ul > </li> <li>Operation Read: Defines the read operation on the specified memory bank on the tags. Format: Read;MemoryBank;Pointer;WordCount;Password;OpCount;Timeout[;OperationId] <ol> <li> Read: Reserved name for the read operation. </li> <li> MemoryBank: An integer to specify the memory bank to read from. </li> <li> Pointer: The first location (zero based) in the memory bank to start the read operation. </li> <li> Password: The password for the read operation. </li> <li> OpCount: An integer to specify the times this read operation will be executed, it will be unlimited if the value is 0. </li> <li> Timeout: The timeout value (milliseconds) for the read operation, no timeout if the value is 0. </li> <li> OperationId: The optional parameter to assign an id to the read operation. </li> </ol> </li> </ul>

Since:

1.1

readOperationsCount

protected final MethodMeasurement readOperationsCount

The ReadOperationsCount measurement defines the number of read operations supported by this profile.

Since:

1.1

antennaCount

protected final MethodMeasurement antennaCount

The "AntennaCount" is maximum number of antennas supported by this reader.

Since:

1.1

superCacheMaximumSize

protected final MethodMeasurement superCacheMaximumSize

The "SuperCacheMaximumSize" is maximum number of tags supported by the super cache size. A zero value means that the super cache will not be used.

Since:

1.1

confidenceScript

protected final MethodMeasurement confidenceScript

The "ConfidenceScript" is script to compute the "confidence" value.

Since:

1.1

tagReport

protected final Signal tagReport

The "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 meta data stored at the "dataExtensions" key. See the tags and dataExtensions descriptions for details.

Since:

1.0

tagAggregationReport

protected final Signal tagAggregationReport

The "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 meta data stored at the "dataExtensions" key. See the tags and dataExtensions descriptions for details.

Since:

1.0

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.

Since:

1.0

Method Detail

activate

public void activate()

Activate.

applyDataExtensions

protected void applyDataExtensions(java.util.Map rfidData)

Apply data extensions with the specified RFID data parameter.

Parameters:

rfidData - The RFID data (Map) parameter.

See Also:

getDataExtensions(), handleMethodDataExtensions(int,Measurement,Object), handleSetDataExtensions(Measurement,Object)

applyDataExtensionsSingleTag

protected void applyDataExtensionsSingleTag(java.util.Map rfidData)

Apply data extensions single tag with the specified RFID data parameter.

Parameters:

rfidData - The RFID data (Map) parameter.

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)

Build outer tag message with the specified tags parameter and return the Map result.

Parameters:

tags - The tags (Map) parameter.

Returns:

Results of the build outer tag message (Map) value.

buildOuterTagMessageForSubCycles

protected java.util.Map buildOuterTagMessageForSubCycles(java.util.Map tags)

Build outer tag message for sub cycles with the specified tags parameter and return the Map result.

Parameters:

tags - The tags (Map) parameter.

Returns:

Results of the build outer tag message for sub cycles (Map) value.

Since:

1.2

buildTagMessage

protected java.util.Map buildTagMessage(java.lang.String key,
                                        java.util.Map reads)

Build tag message with the specified key and reads parameters and return the Map result.

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.

deactivate

public void deactivate()

Deactivate.

evaluateAggregationLdapFilter

public boolean evaluateAggregationLdapFilter(java.util.Dictionary tagLdapMap)

Evaluate aggregation LDAP filter with the specified tag LDAP map parameter and return the boolean result.

Parameters:

tagLdapMap - The tag ldap map (Dictionary) parameter.

Returns:

Results of the evaluate aggregation LDAP filter (boolean) value.

See Also:

getAggregationLdapFilter(), setAggregationLdapFilter(Filter)

evaluateDuplicateFilteringLdapFilter

public void evaluateDuplicateFilteringLdapFilter()

Evaluate duplicate filtering LDAP filter.

See Also:

evaluateDuplicateFilteringLdapFilter(boolean), getDuplicateFilteringLdapFilter(), setDuplicateFilteringLdapFilter(Filter)

evaluateDuplicateFilteringLdapFilter

public void evaluateDuplicateFilteringLdapFilter(boolean duplicateFilteringResult)

Evaluate duplicate filtering LDAP filter.

Parameters:

duplicateFilteringResult - The duplicate filtering result (boolean) parameter.

See Also:

evaluateDuplicateFilteringLdapFilter(), getDuplicateFilteringLdapFilter(), setDuplicateFilteringLdapFilter(Filter)

evaluateLdapFilters

protected void evaluateLdapFilters(ExpressionFilterResults expressionFilterResults)
                            throws java.lang.InterruptedException

Evaluate LDAP filters.

Parameters:

expressionFilterResults - The expression filter results (ExpressionFilterResults) parameter.

Throws:

java.lang.InterruptedException - Interrupted Exception.

evaluateTagAggregatingLdapFilter

public void evaluateTagAggregatingLdapFilter()

Evaluate tag aggregating LDAP filter.

See Also:

evaluateTagAggregatingLdapFilter(boolean), setTagAggregatingLdapFilter(Filter)

evaluateTagAggregatingLdapFilter

public void evaluateTagAggregatingLdapFilter(boolean tagAggregatingResult)

Evaluate tag aggregating LDAP filter.

Parameters:

tagAggregatingResult - The tag aggregating result (boolean) parameter.

See Also:

evaluateTagAggregatingLdapFilter(), setTagAggregatingLdapFilter(Filter)

evaluateTagLdapFilter

public boolean evaluateTagLdapFilter(java.util.Dictionary tagLdapMap)

Evaluate tag LDAP filter with the specified tag LDAP map parameter and return the boolean result.

Parameters:

tagLdapMap - The tag ldap map (Dictionary) parameter.

Returns:

Results of the evaluate tag LDAP filter (boolean) value.

See Also:

getTagLdapFilter(), setTagLdapFilter(Filter)

evaluateTagReadingLdapFilter

public void evaluateTagReadingLdapFilter()

Evaluate tag reading LDAP filter.

See Also:

evaluateTagReadingLdapFilter(boolean), setTagReadingLdapFilter(Filter)

evaluateTagReadingLdapFilter

public void evaluateTagReadingLdapFilter(boolean tagReadingResult)

Evaluate tag reading LDAP filter.

Parameters:

tagReadingResult - The tag reading result (boolean) parameter.

See Also:

evaluateTagReadingLdapFilter(), setTagReadingLdapFilter(Filter)

exit

public void exit()

Exit.

filterMap

public java.util.Map filterMap(java.util.Map map,
                               Filter filter)

Filter map with the specified map and filter parameters and return the Map result.

Parameters:

map - The map (Map) parameter.

filter - The filter (Filter) parameter.

Returns:

Results of the filter map (Map) value.

See Also:

improveReportMap(String,Map,Object,int), mergeMapOverMap(Map,Map)

flushAggregationCache

public void flushAggregationCache()

Flush aggregation cache.

getAggregationFilterExpression

public MeasurementService getAggregationFilterExpression()

The optional AggregationFilterExpression specifies the definition of tags that should be published on the "TagAggregationReport" signal. The filter expression is an LDAP expression. The keys in the LDAP expression are the keys defined in the "TagReport". If the tag passes the "AggregationMaskSetting" and the result of the LDAP expression is true, then the tag will be reported in the "TagAggregationReport". If the filtering can be done by the "AggregationMaskSetting", then this would be better than using this LDAP filter.

Returns:

The aggregation filter expression value.

Since:

1.1

See Also:

handleMethodAggregationFilterExpression(int,Measurement,Object), handleSetAggregationFilterExpression(Measurement,Object)

getAggregationFinalFilterExpression

public MeasurementService getAggregationFinalFilterExpression()

The optional AggregationFinalFilterExpression specifies the definition of tags that should be published on the "TagAggregationReport" signal. The filter expression is an LDAP expression. The keys in the LDAP expression are the keys defined in the "TagReport". Before the "TagAggregationReport" is published, this LDAP filter will be applied to all tags in the current tag aggregation. If the result of the LDAP filter is true, then the tag will be included in the report. If the filtering can be done by the "AggregationMaskSetting", then this would be better than using this LDAP filter.

Returns:

The aggregation final filter expression value.

Since:

1.1

See Also:

handleMethodAggregationFinalFilterExpression(int,Measurement,Object), handleSetAggregationFinalFilterExpression(Measurement,Object)

getAggregationFinalLdapFilter

public Filter getAggregationFinalLdapFilter()

Gets the aggregation final ldap filter (Filter) value.

Returns:

The aggregation final LDAP filter (Filter) value.

See Also:

setAggregationFinalLdapFilter(Filter)

getAggregationLdapFilter

public Filter getAggregationLdapFilter()

Gets the aggregation ldap filter (Filter) value.

Returns:

The aggregation LDAP filter (Filter) value.

See Also:

evaluateAggregationLdapFilter(Dictionary), setAggregationLdapFilter(Filter)

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 place holder 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 specified as a hex string with each byte (two characters) separated by a blank. 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 semicolon.

Returns:

The aggregation mask setting value.

Since:

1.0

See Also:

handleMethodAggregationMaskSetting(int,Measurement,Object), handleSetAggregationMaskSetting(Measurement,Object)

getAntennaCount

public MeasurementService getAntennaCount()

The "AntennaCount" is maximum number of antennas supported by this reader.

Returns:

The antenna count value.

Since:

1.1

See Also:

handleMethodAntennaCount(int,Measurement,Object)

getConfidenceScript

public MeasurementService getConfidenceScript()

The "ConfidenceScript" is script to compute the "confidence" value.

Returns:

The confidence script value.

Since:

1.1

See Also:

handleMethodConfidenceScript(int,Measurement,Object)

getControlCapacity

public int getControlCapacity()

Gets the control capacity (int) value.

Returns:

The control capacity value.

Since:

1.0

getControlProfilePrefix

public java.lang.String getControlProfilePrefix()

Get the control profile prefix value.

Returns:

The control profile prefix value.

Since:

1.0

getDataExtensions

public MeasurementService getDataExtensions()

The DataExtensions measurement is a map of meta data 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.

Since:

1.0

See Also:

applyDataExtensions(Map), handleMethodDataExtensions(int,Measurement,Object), handleSetDataExtensions(Measurement,Object)

getDefaultDevice

public DeviceService getDefaultDevice()

Gets the default device (DeviceService) value.

Returns:

DeviceService The default DeviceService.

Since:

1.0

getDefaultKey

public java.lang.String getDefaultKey()

Gets the default key (String) value.

Returns:

String The default key

Since:

1.0

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.

Since:

1.0

See Also:

handleDuplicateFiltering(MeasurementService,Object,Object,Object), handleMethodDuplicateFiltering(int,Measurement,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.

Since:

1.0

See Also:

handleMethodDuplicateFilteringExpression(int,Measurement,Object), handleSetDuplicateFilteringExpression(Measurement,Object)

getDuplicateFilteringLdapFilter

public Filter getDuplicateFilteringLdapFilter()

Gets the duplicate filtering ldap filter (Filter) value.

Returns:

The duplicate filtering LDAP filter (Filter) value.

See Also:

evaluateDuplicateFilteringLdapFilter(), evaluateDuplicateFilteringLdapFilter(boolean), setDuplicateFilteringLdapFilter(Filter)

getGpioProfilePrefix

public java.lang.String getGpioProfilePrefix()

Get the GPIO profile prefix value.

Returns:

The GPIO profile prefix value.

Since:

1.0

getMessageCapacity

public int getMessageCapacity()

Gets the message capacity (int) value.

Returns:

int The message capacity.

Since:

1.0

getPositionProfilePrefix

public java.lang.String getPositionProfilePrefix()

Get the position profile prefix value.

Returns:

The position profile prefix value.

Since:

1.1

getReadOperations

public MeasurementService getReadOperations()

The ReadOperations specifies the definition of read operations block against the tag(s). A read operation block can contain multiple read operations separated by the character ",". A read operation is specified by parameters based on the operation, the parameters are separated by the character ";". The first parameter specifies the kind of read operation. <ul > </li> <li>Operation Read: Defines the read operation on the specified memory bank on the tags. Format: Read;MemoryBank;Pointer;WordCount;Password;OpCount;Timeout[;OperationId] <ol> <li> Read: Reserved name for the read operation. </li> <li> MemoryBank: An integer to specify the memory bank to read from. </li> <li> Pointer: The first location (zero based) in the memory bank to start the read operation. </li> <li> Password: The password for the read operation. </li> <li> OpCount: An integer to specify the times this read operation will be executed, it will be unlimited if the value is 0. </li> <li> Timeout: The timeout value (milliseconds) for the read operation, no timeout if the value is 0. </li> <li> OperationId: The optional parameter to assign an id to the read operation. </li> </ol> </li> </ul>

Returns:

The read operations value.

Since:

1.1

See Also:

handleMethodReadOperations(int,Measurement,Object), handleSetReadOperations(Measurement,Object)

getReadOperationsCount

public MeasurementService getReadOperationsCount()

The ReadOperationsCount measurement defines the number of read operations supported by this profile.

Returns:

The read operations count value.

Since:

1.1

See Also:

handleMethodReadOperationsCount(int,Measurement,Object)

getReadStopTimeout

public int getReadStopTimeout()

readStopTimeout is a configuration parameter to specify the timeout period in milliseconds that the profile will wait to receive an acknowledgment 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.

Since:

1.0

See Also:

setReadStopTimeout(int)

getReportLevel

public MeasurementService getReportLevel()

Gets the report level (MeasurementService) value.

Specified by:

getReportLevel in class RfidBaseProfile

Returns:

The report level (MeasurementService) value.

See Also:

getTagAntennaReportLevel(), handleMethodTagAntennaReportLevel(int,Measurement,Object)

getSuperCacheMaximumSize

public MeasurementService getSuperCacheMaximumSize()

The "SuperCacheMaximumSize" is maximum number of tags supported by the super cache size. A zero value means that the super cache will not be used.

Specified by:

getSuperCacheMaximumSize in class RfidBaseProfile

Returns:

The super cache maximum size value.

Since:

1.1

See Also:

handleMethodSuperCacheMaximumSize(int,Measurement,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.

Since:

1.0

See Also:

handleMethodTagAggregating(int,Measurement,Object), handleTagAggregating(MeasurementService,Object,Object,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.

Since:

1.0

See Also:

handleMethodTagAggregatingExpression(int,Measurement,Object), handleSetTagAggregatingExpression(Measurement,Object)

getTagAggregationReport

public SignalService getTagAggregationReport()

The "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 meta data stored at the "dataExtensions" key. See the tags and dataExtensions descriptions for details.

Returns:

The tag aggregation report value.

Since:

1.0

See Also:

triggerTagAggregationReport(ChannelService,Map,Object), triggerTagAggregationReport(Map,boolean)

getTagAntennaReportLevel

public MeasurementService getTagAntennaReportLevel()

The TagAntennaReportLevel measurement specifies the level of tag antenna reporting. The higher the value, the more tag antenna information is reported in tag data on the "TagReport" and "TagAggregationReport" signals but the extra processing is required which may effect performance.

Returns:

The tag antenna report level value.

Since:

1.1

See Also:

handleMethodTagAntennaReportLevel(int,Measurement,Object)

getTagFilterExpression

public MeasurementService getTagFilterExpression()

The optional TagFilterExpression specifies the definition of tags that should be published on the "TagReport" signal. The filter expression is an LDAP expression. The keys in the LDAP expression are the keys defined in the "TagReport". If the tag passes the "TagMaskSetting" and the results of the LDAP expression is true, then the tag will be reported in the "TagReport".

Returns:

The tag filter expression value.

Since:

1.1

See Also:

handleMethodTagFilterExpression(int,Measurement,Object), handleSetTagFilterExpression(Measurement,Object)

getTagLdapFilter

public Filter getTagLdapFilter()

Gets the tag ldap filter (Filter) value.

Returns:

The tag LDAP filter (Filter) value.

See Also:

evaluateTagLdapFilter(Dictionary), setTagLdapFilter(Filter)

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 place holder 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 specified as a hex string with each byte (two characters) separated by a blank. 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 semicolon.

Returns:

The tag mask setting value.

Since:

1.0

See Also:

handleMethodTagMaskSetting(int,Measurement,Object), handleSetTagMaskSetting(Measurement,Object)

getTagPosition

public MeasurementService getTagPosition()

The "TagPosition" measurement is a map of meta data to be associated with tag data. "TagPosition" extensions are applied to "TagReport" data as the signal is published. "TagPosition" 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 "TagPosition" value. Setting the value of the measurement to an empty map clears the value.

Returns:

The tag position value.

Since:

1.1

See Also:

handleMethodTagPosition(int,Measurement,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.

Since:

1.0

See Also:

handleMethodTagReading(int,Measurement,Object), handleSetTagReading(Measurement,Object)

getTagReadingExpression

public MeasurementService getTagReadingExpression()

The "TagReadingExpression" is an Lightweight Directory Access Protocol (LDAP) expression to trigger the state of tag reading based on input pin and control values.

Returns:

The tag reading expression value.

Since:

1.0

See Also:

handleMethodTagReadingExpression(int,Measurement,Object), handleSetTagReadingExpression(Measurement,Object)

getTagReadingSubCycleDelta

public long getTagReadingSubCycleDelta()

tagReadingSubCycleDelta specifies that if the time between the two reports of any tag exceeds this parameter, the sub cycle will be stopped. .

Returns:

tag reading sub cycle delta custom parameter.

Since:

1.2

See Also:

setTagReadingSubCycleDelta(long)

getTagReadingSubCycleInterval

public long getTagReadingSubCycleInterval()

tagReadingSubCycleInterval specifies the period length of the interval between sub cycles, no interval if the value is less than or equal to 0. .

Returns:

tag reading sub cycle interval custom parameter.

Since:

1.2

See Also:

setTagReadingSubCycleInterval(long)

getTagReadingSubCycleLength

public long getTagReadingSubCycleLength()

tagReadingSubCycleLength is a configuration parameter to specify the period length in milliseconds for each sub cycle, for "auto" mode, it is the timeout value. .

Returns:

tag reading sub cycle length custom parameter.

Since:

1.2

See Also:

setTagReadingSubCycleLength(long)

getTagReadingSubCycleMode

public java.lang.String getTagReadingSubCycleMode()

tagReadingSubCycleMode is a configuration parameter to specify that if one tag reading cycle should contain sub cycles. The value options: "null", "auto", "period". null: the feature is disabled. auto: the sub cycles are turned on and off based on the repeated tag reports. period: each sub cycle is turned on for a fixed period of time. .

Returns:

tag reading sub cycle mode custom parameter.

Since:

1.2

See Also:

setTagReadingSubCycleMode(String)

getTagReadingSubCycleNum

public int getTagReadingSubCycleNum()

tagReadingSubCycleNum is a configuration parameter to specify the number of the sub cycles in each reading cycle, it is only applicable when "tagReadingSubCycleMode" is not "null". There will be unlimited cycles if the number is less than or equal to 0. .

Returns:

tag reading sub cycle num custom parameter.

Since:

1.2

See Also:

setTagReadingSubCycleNum(int)

getTagReadingValue

protected boolean getTagReadingValue()

Gets the tag reading value (boolean) value.

Returns:

The tag reading value (boolean) value.

getTagReport

public SignalService getTagReport()

The "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 meta data stored at the "dataExtensions" key. See the tags and dataExtensions descriptions for details.

Returns:

The tag report value.

Since:

1.0

See Also:

triggerTagReport(ChannelService,Map,Object), triggerTagReport(Map,boolean), triggerTagReport(Map,boolean,Object)

handleControlProfileServiceBits

protected void handleControlProfileServiceBits(java.lang.String externalKey,
                                               java.util.Dictionary data)

Handle control profile service bits with the specified external key and data parameters.

Parameters:

externalKey - The external key (String) parameter.

data - The data (Dictionary) parameter.

handleControlProfileServiceLongs

protected void handleControlProfileServiceLongs(java.lang.String externalKey,
                                                java.util.Dictionary data)

Handle control profile service longs with the specified external key and data parameters.

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)

Handle duplicate filtering with the specified source, timestamp, new value and old value parameters.

Parameters:

source - The source (MeasurementService) parameter.

timestamp - The time stamp (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)

Handle GPIO profile service input with the specified external key and data parameters.

Parameters:

externalKey - The external key (String) parameter.

data - The data (Dictionary) parameter.

handleMethodAggregationFilterExpression

public java.lang.Object handleMethodAggregationFilterExpression(int code,
                                                                Measurement measurement,
                                                                java.lang.Object data)

Handle method aggregation filter 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 aggregation filter expression (Object) value.

handleMethodAggregationFinalFilterExpression

public java.lang.Object handleMethodAggregationFinalFilterExpression(int code,
                                                                     Measurement measurement,
                                                                     java.lang.Object data)

Handle method aggregation final filter 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 aggregation final filter expression (Object) value.

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.

handleMethodAntennaCount

public java.lang.Object handleMethodAntennaCount(int code,
                                                 Measurement measurement,
                                                 java.lang.Object data)

Handle method antenna count 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 antenna count (Object) value.

handleMethodConfidenceScript

public java.lang.Object handleMethodConfidenceScript(int code,
                                                     Measurement measurement,
                                                     java.lang.Object data)

Handle method confidence script 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 confidence script (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.

handleMethodReadOperations

public java.lang.Object handleMethodReadOperations(int code,
                                                   Measurement measurement,
                                                   java.lang.Object data)

Handle method read operations 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 read operations (Object) value.

handleMethodReadOperationsCount

public java.lang.Object handleMethodReadOperationsCount(int code,
                                                        Measurement measurement,
                                                        java.lang.Object data)

Handle method read operations count 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 read operations count (Object) value.

handleMethodSuperCacheMaximumSize

public java.lang.Object handleMethodSuperCacheMaximumSize(int code,
                                                          Measurement measurement,
                                                          java.lang.Object data)

Handle method super cache maximum size 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 super cache maximum size (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.

handleMethodTagAntennaReportLevel

public java.lang.Object handleMethodTagAntennaReportLevel(int code,
                                                          Measurement measurement,
                                                          java.lang.Object data)

Handle method tag antenna report level 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 antenna report level (Object) value.

handleMethodTagFilterExpression

public java.lang.Object handleMethodTagFilterExpression(int code,
                                                        Measurement measurement,
                                                        java.lang.Object data)

Handle method tag filter 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 filter 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.

handleMethodTagPosition

public java.lang.Object handleMethodTagPosition(int code,
                                                Measurement measurement,
                                                java.lang.Object data)

Handle method tag position 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 position (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.

handlePositionProfileServiceCoordinate

protected void handlePositionProfileServiceCoordinate(java.lang.String externalKey,
                                                      java.util.Dictionary data)

Handle position profile service coordinate with the specified external key and data parameters.

Parameters:

externalKey - The external key (String) parameter.

data - The data (Dictionary) parameter.

handleSetAggregationFilterExpression

protected void handleSetAggregationFilterExpression(Measurement measurement,
                                                    java.lang.Object data)

Handle set aggregation filter expression with the specified measurement and data parameters.

Parameters:

measurement - The measurement (Measurement) parameter.

data - The data (Object) parameter.

handleSetAggregationFinalFilterExpression

protected void handleSetAggregationFinalFilterExpression(Measurement measurement,
                                                         java.lang.Object data)

Handle set aggregation final filter expression with the specified measurement and data parameters.

Parameters:

measurement - The measurement (Measurement) parameter.

data - The data (Object) parameter.

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.

handleSetReadOperations

protected void handleSetReadOperations(Measurement measurement,
                                       java.lang.Object data)

Handle set read operations with the specified measurement and data parameters.

Parameters:

measurement - The measurement (Measurement) parameter.

data - The data (Object) parameter.

Since:

1.2

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.

handleSetTagFilterExpression

protected void handleSetTagFilterExpression(Measurement measurement,
                                            java.lang.Object data)

Handle set tag filter 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)

Handle tag aggregating with the specified source, timestamp, new value and old value parameters.

Parameters:

source - The source (MeasurementService) parameter.

timestamp - The time stamp (Object) parameter.

newValue - The new value (Object) parameter.

oldValue - The old value (Object) parameter.

See Also:

getTagAggregating(), handleMethodTagAggregating(int,Measurement,Object)

improveReportMap

public void improveReportMap(java.lang.String key,
                             java.util.Map reads,
                             java.lang.Object timestamp,
                             int tagAntennaReportLevelValue)

Improve reads map with the specified reads and timestamp parameters.

Parameters:

key - The key (String) parameter.

reads - The reads (Map) parameter.

timestamp - The time stamp (Object) parameter.

tagAntennaReportLevelValue - The tag antenna report level value (int) parameter.

isDeviceNeeded

public boolean isDeviceNeeded()

Is device needed.

Returns:

The results of this method.

Since:

1.0

isDuplicateTag

protected boolean isDuplicateTag(java.lang.String key)

Is duplicate tag with the specified key parameter and return the boolean result.

Parameters:

key - The key (String) parameter.

Returns:

Results of the is duplicate tag (boolean) value.

measurementChanged

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

Measurement changed.

Parameters:

source - source.

timestamp - time stamp.

newValue - new value.

oldValue - old value.

Since:

1.0

mergeAntennaInfo

public long mergeAntennaInfo(java.util.Map targetMap,
                             java.util.Map sourceMap,
                             int antenna)

Merge antenna info with the specified cache read data and reads parameters.

Parameters:

targetMap - The target map (Map) parameter.

sourceMap - The source map (Map) parameter.

antenna - The antenna (int) parameter.

Returns:

Results of the merge antenna info (long) value.

mergeMapOverMap

public java.util.Map mergeMapOverMap(java.util.Map additionalValues,
                                     java.util.Map existingValues)

Merge map over map with the specified additional values and existing values parameters and return the Map result.

Parameters:

additionalValues - The additional values (Map) parameter.

existingValues - The existing values (Map) parameter.

Returns:

Results of the merge map over map (Map) value.

notificationReceived

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

Notification received.

Parameters:

externalKey - external key.

data - data.

Since:

1.0

notifyReadStop

protected void notifyReadStop()

Notify read stop.

notifyTagAggregation

public void notifyTagAggregation()

Notify tag aggregation.

See Also:

notifyTagAggregation(ChannelService,Object)

notifyTagAggregation

public void notifyTagAggregation(ChannelService channel,
                                 java.lang.Object timestamp)

Notify tag aggregation with the specified channel and time stamp parameters.

Parameters:

channel - The channel (ChannelService) parameter.

timestamp - The time stamp (Object) parameter.

Since:

1.2

See Also:

notifyTagAggregation()

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(Map,Object), notifyTagRead(String,Map), notifyTagRead(String,Map,Object)

notifyTagRead

public void notifyTagRead(java.util.Map tags,
                          java.lang.Object timestamp)

Notify tag read with the specified tags and timestamp parameters.

Parameters:

tags - The tags (Map) parameter.

timestamp - The time stamp (Object) parameter.

See Also:

notifyTagRead(Map), notifyTagRead(String,Map), notifyTagRead(String,Map,Object)

notifyTagRead

public void notifyTagRead(java.lang.String key,
                          java.util.Map reads)

Notify tag read with the specified key and reads parameters.

Parameters:

key - The key (String) parameter.

reads - The reads (Map) parameter.

See Also:

notifyTagRead(Map), notifyTagRead(Map,Object), notifyTagRead(String,Map,Object)

notifyTagRead

public void notifyTagRead(java.lang.String key,
                          java.util.Map reads,
                          java.lang.Object timestamp)

Notify tag read with the specified key, reads and timestamp parameters.

Parameters:

key - The key (String) parameter.

reads - The reads (Map) parameter.

timestamp - The time stamp (Object) parameter.

See Also:

notifyTagRead(Map), notifyTagRead(Map,Object), notifyTagRead(String,Map)

performSubCycles

protected void performSubCycles()
                         throws java.lang.InterruptedException

Perform sub cycles.

Throws:

java.lang.InterruptedException - Interrupted Exception.

Since:

1.2

See Also:

buildOuterTagMessageForSubCycles(Map)

setAggregationFinalLdapFilter

public void setAggregationFinalLdapFilter(Filter aggregationFinalLdapFilter)

Sets the aggregation final ldap filter value.

Parameters:

aggregationFinalLdapFilter - The aggregation final ldap filter (Filter) parameter.

See Also:

getAggregationFinalLdapFilter()

setAggregationLdapFilter

public void setAggregationLdapFilter(Filter aggregationLdapFilter)

Sets the aggregation ldap filter value.

Parameters:

aggregationLdapFilter - The aggregation ldap filter (Filter) parameter.

See Also:

evaluateAggregationLdapFilter(Dictionary), getAggregationLdapFilter()

setDuplicateFilteringLdapFilter

public void setDuplicateFilteringLdapFilter(Filter duplicateFilteringLdapFilter)

Sets the duplicate filtering ldap filter value.

Parameters:

duplicateFilteringLdapFilter - The duplicate filtering ldap filter (Filter) parameter.

See Also:

evaluateDuplicateFilteringLdapFilter(), evaluateDuplicateFilteringLdapFilter(boolean), getDuplicateFilteringLdapFilter()

setFilterDuplicatesLdapFilter

public void setFilterDuplicatesLdapFilter(Filter filterDuplicatesLdapFilter)

Sets the filter duplicates ldap filter value.

Parameters:

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

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 acknowledgment 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.

Since:

1.0

See Also:

getReadStopTimeout()

setTagAggregatingLdapFilter

public void setTagAggregatingLdapFilter(Filter tagAggregatingLdapFilter)

Sets the tag aggregating ldap filter value.

Parameters:

tagAggregatingLdapFilter - The tag aggregating ldap filter (Filter) parameter.

See Also:

evaluateTagAggregatingLdapFilter(), evaluateTagAggregatingLdapFilter(boolean)

setTagLdapFilter

public void setTagLdapFilter(Filter tagLdapFilter)

Sets the tag ldap filter value.

Parameters:

tagLdapFilter - The tag ldap filter (Filter) parameter.

See Also:

evaluateTagLdapFilter(Dictionary), getTagLdapFilter()

setTagReadingLdapFilter

public void setTagReadingLdapFilter(Filter tagReadingLdapFilter)

Sets the tag reading ldap filter value.

Parameters:

tagReadingLdapFilter - The tag reading ldap filter (Filter) parameter.

See Also:

evaluateTagReadingLdapFilter(), evaluateTagReadingLdapFilter(boolean)

setTagReadingSubCycleDelta

public void setTagReadingSubCycleDelta(long tagReadingSubCycleDelta)

tagReadingSubCycleDelta specifies that if the time between the two reports of any tag exceeds this parameter, the sub cycle will be stopped. .

Parameters:

tagReadingSubCycleDelta - The tag reading sub cycle delta custom parameter.

Since:

1.2

See Also:

getTagReadingSubCycleDelta()

setTagReadingSubCycleInterval

public void setTagReadingSubCycleInterval(long tagReadingSubCycleInterval)

tagReadingSubCycleInterval specifies the period length of the interval between sub cycles, no interval if the value is less than or equal to 0. .

Parameters:

tagReadingSubCycleInterval - The tag reading sub cycle interval custom parameter.

Since:

1.2

See Also:

getTagReadingSubCycleInterval()

setTagReadingSubCycleLength

public void setTagReadingSubCycleLength(long tagReadingSubCycleLength)

tagReadingSubCycleLength is a configuration parameter to specify the period length in milliseconds for each sub cycle, for "auto" mode, it is the timeout value. .

Parameters:

tagReadingSubCycleLength - The tag reading sub cycle length custom parameter.

Since:

1.2

See Also:

getTagReadingSubCycleLength()

setTagReadingSubCycleMode

public void setTagReadingSubCycleMode(java.lang.String tagReadingSubCycleMode)

tagReadingSubCycleMode is a configuration parameter to specify that if one tag reading cycle should contain sub cycles. The value options: "null", "auto", "period". null: the feature is disabled. auto: the sub cycles are turned on and off based on the repeated tag reports. period: each sub cycle is turned on for a fixed period of time. .

Parameters:

tagReadingSubCycleMode - The tag reading sub cycle mode custom parameter.

Since:

1.2

See Also:

getTagReadingSubCycleMode()

setTagReadingSubCycleNum

public void setTagReadingSubCycleNum(int tagReadingSubCycleNum)

tagReadingSubCycleNum is a configuration parameter to specify the number of the sub cycles in each reading cycle, it is only applicable when "tagReadingSubCycleMode" is not "null". There will be unlimited cycles if the number is less than or equal to 0. .

Parameters:

tagReadingSubCycleNum - The tag reading sub cycle num custom parameter.

Since:

1.2

See Also:

getTagReadingSubCycleNum()

setup

public void setup()

Since:

1.0

See Also:

org.eclipse.soda.dk.device.Container#setup()

setupNotification

public void setupNotification()

Setup notification.

Since:

1.0

startSubCycleController

protected void startSubCycleController()

Start sub cycle controller.

Since:

1.2

strToBytes

protected byte[] strToBytes(java.lang.String str)

Str to bytes with the specified str parameter and return the byte[] result.

Parameters:

str - The str (String) parameter.

Returns:

Results of the str to bytes (byte[]) value.

Since:

1.2

triggerTagAggregationReport

protected void triggerTagAggregationReport(ChannelService channel,
                                           java.util.Map tagMap,
                                           java.lang.Object timestamp)

Trigger tag aggregation report with the specified channel, tag map and time stamp parameters.

Parameters:

channel - The channel (ChannelService) parameter.

tagMap - The tag map (Map) parameter.

timestamp - The time stamp (Object) parameter.

Since:

1.2

See Also:

getTagAggregationReport(), triggerTagAggregationReport(Map,boolean)

triggerTagAggregationReport

protected void triggerTagAggregationReport(java.util.Map tagMap,
                                           boolean withError)

Trigger tag aggregation report with the specified tag map and with error parameters.

Parameters:

tagMap - The tag map (Map) parameter.

withError - The with error (boolean) parameter.

See Also:

getTagAggregationReport(), triggerTagAggregationReport(ChannelService,Map,Object)

triggerTagAggregationReportError

protected void triggerTagAggregationReportError(ChannelService channel,
                                                java.util.Map tagMap,
                                                java.lang.Object timestamp)

Trigger tag aggregation report error with the specified channel, tag map and time stamp parameters.

Parameters:

channel - The channel (ChannelService) parameter.

tagMap - The tag map (Map) parameter.

timestamp - The time stamp (Object) parameter.

Since:

1.2

triggerTagReport

protected void triggerTagReport(ChannelService channel,
                                java.util.Map tagMap,
                                java.lang.Object timestamp)

Trigger tag report with the specified channel, tag map and time stamp parameters.

Parameters:

channel - The channel (ChannelService) parameter.

tagMap - The tag map (Map) parameter.

timestamp - The time stamp (Object) parameter.

Since:

1.2

See Also:

getTagReport(), triggerTagReport(Map,boolean), triggerTagReport(Map,boolean,Object)

triggerTagReport

protected void triggerTagReport(java.util.Map tagMap,
                                boolean withError)

Trigger tag report with the specified tag map and with error parameters.

Parameters:

tagMap - The tag map (Map) parameter.

withError - The with error (boolean) parameter.

See Also:

getTagReport(), triggerTagReport(ChannelService,Map,Object), triggerTagReport(Map,boolean,Object)

triggerTagReport

protected void triggerTagReport(java.util.Map tagMap,
                                boolean withError,
                                java.lang.Object timestamp)

Trigger tag report with the specified tag map, with error and timestamp parameters.

Parameters:

tagMap - The tag map (Map) parameter.

withError - The with error (boolean) parameter.

timestamp - The time stamp (Object) parameter.

See Also:

getTagReport(), triggerTagReport(ChannelService,Map,Object), triggerTagReport(Map,boolean)

updateSubCycleCache

protected void updateSubCycleCache(java.lang.String tagId,
                                   java.lang.Object timestamp)

Update sub cycle cache with the specified tag ID and time stamp parameters.

Parameters:

tagId - The tag ID (String) parameter.

timestamp - The time stamp (Object) parameter.

Since:

1.2