Class MVNSDP

MVNSDP provides info about a Non Spatial Data Provider for a theme based FOI layer. Such information is used to invoke a pre-registered Non-Spatial Data Provider by the FOI server, which will join the result attribute data with a theme's spatial data to produce a thematic rendering of the theme.

Class Summary
Constructor Attributes	Constructor Name and Description
	MVNSDP(nsdpId)

Method Summary
Method Attributes	Method Name and Description
	setKeyColumn(keyColumn) Sets the name of the key column of the theme's underlying table.
	setLabelStyle(labelStyleName) Sets the optional labeling style for the theme.
	setParameters(associativeArrayObj) Sets the properties to be consumed by the NS Data Provider implementation.
	setRenderStyle(renderStyleName) Sets the optional rendering style for the theme.
	setShowMatchedFeatureOnly(flag) Sets whether MapViewer should display only those theme features that have a match with the NS data set.
	setTheme(themeName) Sets the name of the theme for this NS Data Provider.
	setTimeout(timeout) Sets the time out, in seconds, on this NS Data Provider.

Class Detail

MVNSDP(nsdpId)

Parameters:
nsdpId: the ID of the Non Spatial Data Provider that has been registered with MapViewer

Method Detail

setKeyColumn(keyColumn)

Sets the name of the key column of the theme's underlying table. MapViewer server will match values from this key column to the key fields in the NS data set produced by the NS Data Provider.

Parameters:
{String} keyColumn: the name of the key column in the theme's base table.

setLabelStyle(labelStyleName)

Sets the optional labeling style for the theme. This style, if present, will override the theme's existing labeling style.

Parameters:
{String} labelStyleName: name of a MapViewer style

setParameters(associativeArrayObj)

Sets the properties to be consumed by the NS Data Provider implementation. These properties are key-value pairs that are understood only by the NS Data Provider.

You must collect all the properties into one associative array (Object), then pass this object as the argument when calling this method. Both the key and value of each property must be of String type.

Sample usage:

    var  params = new Object();
    params['url'] = 'http://www.my_corp.com:3456/bi';
    params['layers'] = 'sales_2005';
    params['regions'] = 'North_America';
    
    nsdp.setParameters(params);

Parameters:
{Array} associativeArrayObj: an associative array containing all the properties

setRenderStyle(renderStyleName)

Sets the optional rendering style for the theme. This style, if present, will override the theme's existing rendering style.

Parameters:
{String} renderStyleName: name of a MapViewer style

setShowMatchedFeatureOnly(flag)

Sets whether MapViewer should display only those theme features that have a match with the NS data set. Default is true. If set to false, then every feature produced by the theme for the current map request will be displayed. Note that in this case theme features may be displayed in different styles depending on whether they have the attribue data from the matching NS data rows.

Parameters:
{Boolean} flag: a boolean value (true | false).

setTheme(themeName)

Sets the name of the theme for this NS Data Provider. It should be the real name of the theme as known to MapViewer server, not the layerName (the first parameter) specified when creating a MVThemeBasedFOI. In other words, if the theme is pre-defined (definition is stored in the database) then you should use the theme's name as stored in the database. For a dynamic/JDBC theme, the name should be the one specified in the XML definition's <theme> element.

Parameters:
{String} themeName: the name of the MapViewer theme

setTimeout(timeout)

Sets the time out, in seconds, on this NS Data Provider. MapViewer will wait for this many seconds for a NS Data Provider to produce data before abandoning the effort.

Parameters:
{int} timeout: how long (in seconds) should MapViewer wait on the NS Data Provider invocation.

Global Variables

Classes

Class MVNSDP