Appboard/old/advanced data adapter - Revision history

imported>Jason.nicholls: moved AppBoard Advanced Data Adapter to appboard/old/advanced data adapter

2014-07-17T11:08:42Z

moved AppBoard Advanced Data Adapter to appboard/old/advanced data adapter

← Older revision	Revision as of 11:08, 17 July 2014
(No difference)

imported>Jason.nicholls at 11:08, 17 July 2014

2014-07-17T11:08:22Z

← Older revision		Revision as of 11:08, 17 July 2014
Line 1:		Line 1:
			{{DISPLAYTITLE:AppBoard Advanced Data Adapter}}
			[[Category:AppBoard old]]
	== Prerequisites ==		== Prerequisites ==

imported>Jason.nicholls: /* Custom Query Implementation / findByQuery() */

2014-07-17T11:07:48Z

Custom Query Implementation / findByQuery()

← Older revision		Revision as of 11:07, 17 July 2014
Line 343:		Line 343:
	To invoke <tt>findByQuery()</tt>, the <tt>Sine Wave</tt> data collection must be edited to apply a filter. The best way to do this is to first preview the <tt>Sine Wave</tt> Entity, and copy one of the key values by first selecting it and then clicking <tt>Copy to Clipboard</tt>. This value can then be modified and used in the filter expression. Alternately, just use values like 1000 and 2000 for the Key, and the data will be calculated for times in 1970.		To invoke <tt>findByQuery()</tt>, the <tt>Sine Wave</tt> data collection must be edited to apply a filter. The best way to do this is to first preview the <tt>Sine Wave</tt> Entity, and copy one of the key values by first selecting it and then clicking <tt>Copy to Clipboard</tt>. This value can then be modified and used in the filter expression. Alternately, just use values like 1000 and 2000 for the Key, and the data will be calculated for times in 1970.

	[[File:~~ada~~-findByQuery-filter.png\|center\|503px]]		[[File:Ada-findByQuery-filter.png\|center\|503px]]

	Once the filters are created and only have Key <= or Key >= expressions, the custom query will be executed. This can be verified by looking at the preview, where the description will now by "Set in findByQuery()".		Once the filters are created and only have Key <= or Key >= expressions, the custom query will be executed. This can be verified by looking at the preview, where the description will now by "Set in findByQuery()".

	[[File:~~ada~~-findByQuery-preview.png\|center\|503px]]		[[File:Ada-findByQuery-preview.png\|center\|503px]]

	The Tomcat console will also provide confirmation in the form of log message, as below:		The Tomcat console will also provide confirmation in the form of log message, as below:

imported>Jason.nicholls: /* Incomplete Records / findById() */

2014-07-17T11:07:14Z

Incomplete Records / findById()

← Older revision		Revision as of 11:07, 17 July 2014
Line 166:		Line 166:
	The new behavior can be verified through a couple changes. First, a preview of the <tt>Sine Wave</tt> Entity will show "Set in findById()" for the description, and careful observation will show that the descriptions fill in after the other attributes, since that is the field left incomplete in the <tt>getSineRecord()</tt> helper method.		The new behavior can be verified through a couple changes. First, a preview of the <tt>Sine Wave</tt> Entity will show "Set in findById()" for the description, and careful observation will show that the descriptions fill in after the other attributes, since that is the field left incomplete in the <tt>getSineRecord()</tt> helper method.

	[[File:~~ada~~-findById.png\|center\|503px]]		[[File:Ada-findById.png\|center\|503px]]

	The other way is through the logger. If the following code is added to the adapter class:		The other way is through the logger. If the following code is added to the adapter class:

imported>Jason.nicholls: /* Refactoring fetchRecords() */

2014-07-17T11:06:48Z

Refactoring fetchRecords()

← Older revision		Revision as of 11:06, 17 July 2014
Line 101:		Line 101:

	To verify the refactoring works, preview the <tt>Sine Wave</tt> Data Source. The preview should look similar to:		To verify the refactoring works, preview the <tt>Sine Wave</tt> Data Source. The preview should look similar to:
	[[File:~~ada~~-fetchRecords.png\|center\|503px]]		[[File:Ada-fetchRecords.png\|center\|503px]]
	Note that the description field shows "Set in fetchRecords()". This will change after the next step.		Note that the description field shows "Set in fetchRecords()". This will change after the next step.

imported>Jason.nicholls: /* Prerequisites */

2014-07-17T11:06:13Z

Prerequisites

← Older revision		Revision as of 11:06, 17 July 2014
Line 1:		Line 1:
	== Prerequisites ==		== Prerequisites ==

	These examples use the same system configuration as the [[~~Creating_An_AppBoard_Data_Adapter~~\|Creating An AppBoard Data Adapter]] examples. Review the required environment and verify it using the steps on that page before continuing.		These examples use the same system configuration as the [[appboard/old/custom_data_adapter\|Creating An AppBoard Data Adapter]] examples. Review the required environment and verify it using the steps on that page before continuing.

	== Advanced Data Adapter Concepts ==		== Advanced Data Adapter Concepts ==

imported>Jay.barr: /* Custom Query Implementation / findByQuery() */

2011-09-02T02:04:07Z

Custom Query Implementation / findByQuery()

← Older revision		Revision as of 02:04, 2 September 2011
Line 306:		Line 306:
	The previous section of code parses a specific range of filters, namely those in the form of 'Key' >= something or 'Key' <= something, and updates the variables defining the range for the sine wave calculation. If any filters are encountered that do not match the narrow range defined, the method resorts to calling <tt>super.findByQuery()</tt> and returning.		The previous section of code parses a specific range of filters, namely those in the form of 'Key' >= something or 'Key' <= something, and updates the variables defining the range for the sine wave calculation. If any filters are encountered that do not match the narrow range defined, the method resorts to calling <tt>super.findByQuery()</tt> and returning.
	<code>[java,n]		<code>[java,n]

			logger.debug("findByQuery(): queryString = " + queryString);

	List<GenericRecord> recordList = new ArrayList<GenericRecord>();		List<GenericRecord> recordList = new ArrayList<GenericRecord>();

imported>Jay.barr: /* Custom Query Implementation / findByQuery() */

2011-09-02T02:02:46Z

Custom Query Implementation / findByQuery()

← Older revision		Revision as of 02:02, 2 September 2011
Line 354:		Line 354:
	16257 [http-8081-exec-4] DEBUG com.demo.DemoDataAdapter - findByQuery('dev.demo.Sine Wave') completed		16257 [http-8081-exec-4] DEBUG com.demo.DemoDataAdapter - findByQuery('dev.demo.Sine Wave') completed
	</small>		</small>

			A couple notes:
			* The associations will be blank if the time range is not in last 10 minutes, because the <tt>Associated Data</tt> Entity only fills the last 10 minutes by default (as determined by the settings for the Data Source).
			* If the filter does not match the allowed pattern, <tt>findByQuery()</tt> will use the super implementation, which will in turn fetch the data using <tt>fetchRecords()</tt>. Because <tt>fetchRecords()</tt> will use the same time range as described above, a filter of "Key >= 1000 and Key <= 2000" (and therefore handled by the custom method) will show data from 1970, while a filter of "Key > 1000 and Key < 2000" (and handled by the <tt>super.findByQuery()</tt>) will return no records, since <tt>fetchRecords()</tt> would have returned no records for that time range.

imported>Jay.barr: /* Custom Query Implementation / findByQuery() */

2011-09-02T01:54:53Z

Custom Query Implementation / findByQuery()

← Older revision		Revision as of 01:54, 2 September 2011
Line 338:		Line 338:
	</code>		</code>
	The method finishes with some logging and a default execution of <tt>super.findByQuery()</tt> if not handled by the above code.		The method finishes with some logging and a default execution of <tt>super.findByQuery()</tt> if not handled by the above code.

			To invoke <tt>findByQuery()</tt>, the <tt>Sine Wave</tt> data collection must be edited to apply a filter. The best way to do this is to first preview the <tt>Sine Wave</tt> Entity, and copy one of the key values by first selecting it and then clicking <tt>Copy to Clipboard</tt>. This value can then be modified and used in the filter expression. Alternately, just use values like 1000 and 2000 for the Key, and the data will be calculated for times in 1970.

			[[File:ada-findByQuery-filter.png\|center\|503px]]

			Once the filters are created and only have Key <= or Key >= expressions, the custom query will be executed. This can be verified by looking at the preview, where the description will now by "Set in findByQuery()".

			[[File:ada-findByQuery-preview.png\|center\|503px]]

			The Tomcat console will also provide confirmation in the form of log message, as below:
			<small>
			16243 [http-8081-exec-4] DEBUG com.demo.DemoDataAdapter - findByQuery('dev.demo.Sine Wave') starting
			16245 [http-8081-exec-4] DEBUG com.demo.DemoDataAdapter - findByQuery: request.getEntity() = Sine Wave
			16249 [http-8081-exec-4] DEBUG com.demo.DemoDataAdapter - findByQuery(): queryString = SELECT * WHERE `Key` >= 1000 AND `Key` <= 2000
			16257 [http-8081-exec-4] DEBUG com.demo.DemoDataAdapter - findByQuery('dev.demo.Sine Wave') completed
			</small>

imported>Jay.barr: /* Custom Query Implementation / findByQuery() */

2011-09-02T01:35:32Z

Custom Query Implementation / findByQuery()

← Older revision		Revision as of 01:35, 2 September 2011
Line 255:		Line 255:
	Up to this point is boilerplate code that will extract the queryString from the request, if any. If there is none, the code will call the super implementation of <tt>findByQuery()</tt>. This may be because the query is one that specifies a group by or pivot operation, not a filter operation.		Up to this point is boilerplate code that will extract the queryString from the request, if any. If there is none, the code will call the super implementation of <tt>findByQuery()</tt>. This may be because the query is one that specifies a group by or pivot operation, not a filter operation.
	<code>[java,n]		<code>[java,n]

	int duration = getSettingAsInt(SETTING_DURATION, 600);		int duration = getSettingAsInt(SETTING_DURATION, 600);
	int dataInterval = getSettingAsInt(SETTING_DATA_INTERVAL, 10);		int dataInterval = getSettingAsInt(SETTING_DATA_INTERVAL, 10);
Line 268:		Line 269:
	The above code section sets up some defaults that will be used for the sine wave calculations, and is completely specific to this contrived example.		The above code section sets up some defaults that will be used for the sine wave calculations, and is completely specific to this contrived example.
	<code>[java,n]		<code>[java,n]

	// For "efficient" examples, filter must be in the form of		// For "efficient" examples, filter must be in the form of
	// WHERE `Key` <OPERATOR> <VALUE> [AND `Key` <OPERATOR> <VALUE>]		// WHERE `Key` <OPERATOR> <VALUE> [AND `Key` <OPERATOR> <VALUE>]
Line 304:		Line 306:
	The previous section of code parses a specific range of filters, namely those in the form of 'Key' >= something or 'Key' <= something, and updates the variables defining the range for the sine wave calculation. If any filters are encountered that do not match the narrow range defined, the method resorts to calling <tt>super.findByQuery()</tt> and returning.		The previous section of code parses a specific range of filters, namely those in the form of 'Key' >= something or 'Key' <= something, and updates the variables defining the range for the sine wave calculation. If any filters are encountered that do not match the narrow range defined, the method resorts to calling <tt>super.findByQuery()</tt> and returning.
	<code>[java,n]		<code>[java,n]

	List<GenericRecord> recordList = new ArrayList<GenericRecord>();		List<GenericRecord> recordList = new ArrayList<GenericRecord>();

Line 322:		Line 325:
	The above section is almost identical to that from <tt>fetchRecords()</tt>, with the exception that these records are returned complete, while the new <tt>fetchRecords()</tt> did not fill the description returned incomplete records. This is just for illustrative purposes. <tt>findByQuery()</tt> can return complete or incomplete records, as dictacted by the type and size of data being returned.		The above section is almost identical to that from <tt>fetchRecords()</tt>, with the exception that these records are returned complete, while the new <tt>fetchRecords()</tt> did not fill the description returned incomplete records. This is just for illustrative purposes. <tt>findByQuery()</tt> can return complete or incomplete records, as dictacted by the type and size of data being returned.
	<code>[java,n]		<code>[java,n]

	Query query = request.getQuery();		Query query = request.getQuery();
	if (query!= null && !query.isEmpty()) { // only intercept non-empty queries		if (query!= null && !query.isEmpty()) { // only intercept non-empty queries