? character.= character.& character.= character.| Parameter | Possible Values | *
| imageSetRootUrl | *
* OPTIONAL This must be a standard http url, with a trailing slash.
* The value is optionally used to
* set to tell the ImageUrlCalulator what value to use in order
* to create the complete urls that point to the images needed for display
* by the application. If not set, the
* configuration will default to a pre-set value. Note that a trailing
* forward-slash is required for this value.
* |
| imageSetDescriptionFileName | *OPTIONAL The value is optionally used to set the name of the image set xml description file. * If not set, the configuration will default to a pre-set value. * |
| imageSetDescriptionUrl | *OPTIONAL The value is optionally used to set the url of the image set description xml file.
* If it is set, the set value overrides this parameter's default value. That default value is the concatenation
* of the values of the imageSetRootUrl and imageSetDescriptionFileName parameters
* (concatenated in that order).
* |
*
| numImagesPerSide | *OPTIONAL The value is optionally used to set the number of image tiles per side on the plate
* dom object.
* |
*
| turnOnImageTileDebuggingFlags | *OPTIONAL This is optionally used turn the debugging flags for * image tiles on and off. Debugging flags are turned on by setting this parameter * to 'true' (using no quotes). * | *
STR_PARAM_NAME_. These identifiers are documented in this JavaScriptdoc. http://localhost/gigapan/?imageSetRootUrl=http://localhost/gigapan/gov/nasa/centers/ames/gigapan_test/test/panorama_images/jaga.gc.cs.cmu.edu/explorer/salttown/&imageSetDescriptionFileName=description.xml&numImagesPerSide=10
* http://localhost/gigapan/gov/nasa/centers/ames/gigapan_test/test/panorama_images/jaga.gc.cs.cmu.edu/explorer/salttown/
* description.xml
* plate dom object so that it has 10 image
* tiles per side. Note that this parameter will only need to be set for the purpose of research into
* optimizing the performance of the Gigapan application.
* http://localhost/gigapan/?imageSetRootUrl=http://jaga.gc.cs.cmu.edu/explorer/salttown/&imageSetDescriptionUrl=http://localhost/gigapan/gov/nasa/centers/ames/gigapan_test/test/panorama_images/jaga.gc.cs.cmu.edu/explorer/salttown/description.xml
* jaga.gc.cs.cmu.edu, and its xml image set to the location specified at localhost
* string STR_PARAM_NAME_IMAGE_SET_ROOT_URL This is a constant set to
* 'imageSetRootUrl' (no quotes). This value is the name of the query
* string parameter that is optionally
* set to tell the ImageUrlCalulator what value to use in order
* to create the complete urls that
* point to the images needed for display by the application. If not set, the
* configuration will default to a pre-set value. Note that a trailing
* forward-slash is required for this value.
* @class-prop string STR_PARAM_NAME_IMAGE_SET_DESCRIPTION_FILE_NAME This is a constant
* set to 'imageSetDescriptionFileName' (no quotes). This value is
* the name of the query string parameter that is optionally used to set the image
* set xml description file location, via a web address (url)
* http-standard query param. If not set, the configuration will default to a
* pre-set value.
* @class-prop string STR_PARAM_NAME_IMAGE_SET_DESCRIPTION_URL is a constant
* set to 'imageSetDescriptionUrl' (no quotes). This value is the name of
* the query string parameter that is optionally used to set the url
* of the image set description xml file. (It ignores any values set for
* STR_PARAM_NAME_IMAGE_SET_ROOT_URL and
* STR_PARAM_NAME_IMAGE_SET_DESCRIPTION_FILE_NAME). Ordinarily, it
* will not be necessary to set this configuration value, as the image set is
* and image set description xml file are usually located in the same relative
* file directories. Thus, unless this parameter is set explicitly in the
* query string as described above, its value will be
* automatically constructed from the value of the
* STR_PARAM_NAME_IMAGE_SET_ROOT_URL parameter
* concatenated with the value of the
* STR_PARAM_NAME_IMAGE_SET_DESCRIPTION_FILE_NAME parameter.
* @class-prop number STR_PARAM_NAME_NUMBER_IMAGES_PER_SIDE is a constant set to
* 'numImagesPerSide' (no quotes). This value is the name of the query string
* parameter that is optionally
* used to set the number of image tiles per side on the plate
* dom object, via a web address (url) http-standard query param.
* Note that this parameter will only need to be set for the purpose of research into
* optimizing the performance of the Gigapan application.
* @class-prop string STR_PARAM_NAME_DEBUGGING_FLAGS_FOR_IMAGE_TILES_ON is a constant
* set to 'turnOnImageTileDebuggingFlags' (no quotes). This value is the name of
* the query string parameter that is optionally used turn the debugging flags for
* image tiles on and off. Debugging flags are turned on by setting this parameter
* to 'true' (using no quotes).
* @class-prop string STR_DEFAULT_IMAGE_SET_ROOT_URL is a constant value representing
* the root url (url minus filename) of the images needed for display by
* the application (the 'image set').
* This value may be overridden by
* the corresponding http-standard url query string parameter described above.
* @class-prop string STR_DEFAULT_IMAGE_SET_DESCRIPTION_FILE_NAME is a constant value
* representing the file name of the xml description of the image set.
* This value may be overridden by
* the corresponding http-standard url query string parameter described above.
* @class-prop number INT_DEFAULT_NUMBER_IMAGES_PER_SIDE is a constant value representing
* the pre-set default number of
* image tiles on the plate dom object. This value may be overridden by
* the corresponding http-standard url query string parameter described above.
* @class-prop boolean BOO_DEFAULT_IMAGE_TILE_DEBUGGING_FLAGS_ON is a constant value representing
* the default setting for whether or not the image tile debugging flags should be turned on.
* @object-prop Object priHshParams The private hash of name-value pairs that
* constitute the parameters of the application.
* @object-prop Object objParent The parent of this object, the Controller object.
* Configuration object.
* @param pObjParent Object The parent of this object, the Controller object.
*/
function Configuration(pObjParent) {
this.strId = "Configuration";
this.objParent = pObjParent;
this.priHshParams = {};
// Methods:
this.init = Configuration_init;
this.getParameter = Configuration_getParameter;
this.init();
}
/**
* This method sets any parameters specified in the url so that they are
* accessible from the Configuration object.
*/
function Configuration_init() {
var intI=0, intL, arrNameValuePairs, arrSplit, strName, anyValue,
intCountParamsToMakeDescriptionFileUrl = 0;
/**
* This inner method performs initialization and setting of the default values
* of the parameters that may be
* specified in the url query string used to browse to the Gigapan
* Explorer application.
* @param objMe object The current this context for the Configuration
* object. This is needed by JavaScript inner methods.
*/
function _init_setDefaults(objMe) {
objMe.priHshParams[ Configuration.STR_PARAM_NAME_IMAGE_SET_ROOT_URL ] = Configuration.STR_DEFAULT_IMAGE_SET_ROOT_URL;
objMe.priHshParams[ Configuration.STR_PARAM_NAME_IMAGE_SET_DESCRIPTION_FILE_NAME ] =
Configuration.STR_DEFAULT_IMAGE_SET_DESCRIPTION_FILE_NAME;
// The value below is composed later, at the end of the 'init' method.
objMe.priHshParams[ Configuration.STR_PARAM_NAME_IMAGE_SET_DESCRIPTION_URL ] = "";
objMe.priHshParams[ Configuration.STR_PARAM_NAME_NUMBER_IMAGES_PER_SIDE ] =
Configuration.INT_DEFAULT_NUMBER_IMAGES_PER_SIDE;
objMe.priHshParams[ Configuration.STR_PARAM_NAME_DEBUGGING_FLAGS_FOR_IMAGE_TILES_ON ] =
Configuration.BOO_DEFAULT_IMAGE_TILE_DEBUGGING_FLAGS_ON
}
/**
* This inner method performs error checking of the parameters that may be
* specified in the url query string used to browse to the Gigapan
* Explorer application. It also notifies the user if there are any errors found and
* provides a suggested remedy.
* @param objMe object The current this context for the
* Configuration
* object. This is needed by JavaScript inner methods.
*/
function _init_performErrorChecking(objMe) {
var strCurrentCompleteDomain = self.gloScope.getWholeDomain(window.location.href),
strXmlDescriptionCompleteDomain =
self.gloScope.getWholeDomain(objMe.priHshParams[ Configuration.STR_PARAM_NAME_IMAGE_SET_DESCRIPTION_URL ]),
intNumImagesPerSide = objMe.priHshParams[ Configuration.STR_PARAM_NAME_NUMBER_IMAGES_PER_SIDE ];
/*-
* Note: We do not use 'document.domain' here since it could have been reset (downgraded to a root by
* domain) by the JavaScript code, and xml-http does not respect downgraded domains.
*/
if (strCurrentCompleteDomain != strXmlDescriptionCompleteDomain) {
alert("Error: Security restrictions on xml-http requests prohibit requests for" +
" xml description files that are not located under the same exact complete " +
" domain as the Gigapan Explorer application itself. " +
"\n\n Your current complete domain is: " + strCurrentCompleteDomain +
"\n and the application is currently set to load the xml description file " +
"from this domain: " + objMe.priHshParams[ Configuration.STR_PARAM_NAME_IMAGE_SET_DESCRIPTION_URL ] + "." +
objMe.objParent.strConfigErrorRemedy
);
}
if (!intNumImagesPerSide || intNumImagesPerSide < 1) {
alert("Error: The number of image tiles to show is not a natural number." + objMe.objParent.strConfigErrorRemedy);
}
}
_init_setDefaults(this);
arrNameValuePairs = window.location.href.replace(/^[^\?]*\?/, "").split(/&/);
intL = arrNameValuePairs.length;
for (; intI < intL; intI++) {
arrSplit = arrNameValuePairs[intI].split(/=/);
strName = arrSplit[0];
anyValue = arrSplit[1];
this.priHshParams[ strName ] = anyValue;
}
if (this.priHshParams[ Configuration.STR_PARAM_NAME_IMAGE_SET_DESCRIPTION_URL ] == "") {
this.priHshParams[ Configuration.STR_PARAM_NAME_IMAGE_SET_DESCRIPTION_URL ] =
this.priHshParams[Configuration.STR_PARAM_NAME_IMAGE_SET_ROOT_URL] +
this.priHshParams[Configuration.STR_PARAM_NAME_IMAGE_SET_DESCRIPTION_FILE_NAME];
}
if (this.priHshParams[ Configuration.STR_PARAM_NAME_DEBUGGING_FLAGS_FOR_IMAGE_TILES_ON ]) {
this.priHshParams[ Configuration.STR_PARAM_NAME_DEBUGGING_FLAGS_FOR_IMAGE_TILES_ON ] =
(new Boolean(this.priHshParams[ Configuration.STR_PARAM_NAME_DEBUGGING_FLAGS_FOR_IMAGE_TILES_ON ].match("true"))).valueOf();
}
/*-
* Clean off any anchor "#" values from the end of the url (the browser attaches them when the user navigates
* on the Gigapan Explorer application).
*/
this.priHshParams[ Configuration.STR_PARAM_NAME_NUMBER_IMAGES_PER_SIDE ] =
parseInt(this.priHshParams[ Configuration.STR_PARAM_NAME_NUMBER_IMAGES_PER_SIDE ]);
_init_performErrorChecking(this);
}
/**
* This method returns the value of the parameter specified by pStrParameterName.
* @param pStrParameterName The name of the parameter.
* @return any The value of the configuration property specified.
*/
function Configuration_getParameter(pStrParameterName) {
var undUndefined;
if (typeof this.priHshParams[pStrParameterName] != "undefined") {
return this.priHshParams[pStrParameterName];
}
alert("Gigapan Error: The configuration property '" + pStrParameterName + "' is not defined." );
return undUndefined;
}