analytics/webcontent/qs/classes/CSuppress.js

/****************************************************************
** Licensed Materials - Property of IBM
**
** BI and PM: qs
**
** (C) Copyright IBM Corp. 2001, 2015
**
** US Government Users Restricted Rights - Use, duplication or 
** disclosure restricted by GSA ADP Schedule Contract with IBM Corp.
*****************************************************************/

// Copyright (C) 2008 Cognos ULC, an IBM Company. All Rights Reserved.
// Cognos and the Cognos logo are trademarks of Cognos ULC (formerly Cognos Incorporated) in the United States and/or other countries.  IBM and the IBM logo are trademarks of International Business Machines Corporation in the United States, or other countries, or both.  Other company, product, or service names may be trademarks or service marks of others.





function CSuppress()
{
	this.m_bFeatureRequiresQualityOfService = true;
	this.m_aParams = new Array();
	this.m_aParams["m"] = "/" + qs_dir + "/suppress.xts";
	this.moMQManager = goApplicationManager.getMiniQueryManager();
	
	
	
	
	
	
	if (typeof goUserCapabilities !== "object")
	{
		this.setNullSuppressionAllowed("false");
		return;
	}
	this.setNullSuppressionAllowed(goUserCapabilities.get("isNullSuppressionAllowed"));
	this.setAccessToNullSuppressionOptionsAllowed(goUserCapabilities.get("isAccessToNullSuppressionOptionsAllowed"));
	this.setMultiEdgeNullSuppressionAllowed(goUserCapabilities.get("isMultiEdgeNullSuppressionAllowed"));
};

CSuppress.prototype = new AFeatureObject();



CSuppress.prototype.setup = function (aFeatureParams)
{
	if (! this.isNullSuppressionAllowed())
	{
		return;
	}
	
	
	this.m_bRequiresDialog = true;
	this.m_iErrorState = FEATURE_OBJECT_NO_ERROR;
	
	var sId = null;
	if (typeof aFeatureParams != "undefined" && aFeatureParams instanceof Array && aFeatureParams.length > 0)
	{
		sId = aFeatureParams[0];
	}
	this.moMQManager = goApplicationManager.getMiniQueryManager();	
	this.mbIsCrosstab = this.moMQManager.hasPivottedColumns();

	
	this.m_aParams["xxIsAccessToNullSuppressionOptionsAllowed"] = this.isAccessToNullSuppressionOptionsAllowed() ? 'true': 'false';

	
	this.m_aParams["xxIsMultiEdgeNullSuppressionAllowed"] = this.isMultiEdgeNullSuppressionAllowed() ? 'true': 'false';
	
	
	if (aFeatureParams instanceof Array && aFeatureParams.length > 0)
	{
		
		if (aFeatureParams[0].indexOf("CONTEXTDELETE") >= 0)
		{
			this.m_bRequiresDialog = false;
			this.m_aParams["xxSuppressionType"] = "SUPPRESS_OFF";
			
			return;
		}
		
		
		if (aFeatureParams[0].indexOf("SWAP_VALUE") >= 0)
		{
			this.m_bRequiresDialog = false;
			
			
			this.swapValue(aFeatureParams[1]);
			
			
			this.m_aParams["xxSuppressionType"] = this.getType();
			
			return;		
		}
		
		
		if (aFeatureParams[0].indexOf("SELECT_TYPE") >= 0)
		{
			this.m_bRequiresDialog = false;
			
			
			this.m_aParams["xxSuppressionType"] = aFeatureParams[1];
			
			return;		
		}
	}
	
	this.showDialog();
};


CSuppress.prototype.showDialog = function ()
{
	cfgSet("LAST_DIALOG", "suppress");
	this.m_aParams["xxCurrentView"] = "DIALOG_LIST";
	if (this.mbIsCrosstab)
	{
		this.m_aParams["xxCurrentView"] = "DIALOG_CROSSTAB";
	}

	this.m_aParams["xxSuppressionType"] = this.getType();

	var aSuppressValues = this.getValues();
	this.m_aParams["xxSuppressionValuesZero"] = aSuppressValues[0];
	this.m_aParams["xxSuppressionValuesDivideByZero"] = aSuppressValues[1];
	this.m_aParams["xxSuppressionValuesMissing"] = aSuppressValues[2];
	this.m_aParams["xxSuppressionValuesOverflow"] = aSuppressValues[3];
};

CSuppress.prototype.proceedWithoutDialog = function ()
{
	return this.execute(this.m_aParams);
};







CSuppress.prototype.getType = function ()
{	
	var sSuppress;
	if (this.isNullSuppressionAllowed())
	{
		sSuppress = this.moMQManager.getCRQReportNode().getAttribute("suppress");
	}
	var sSuppressType = "";
	if (sSuppress && sSuppress.length)
	{
		switch (sSuppress)
		{
			case "rows":
				sSuppressType = "SUPPRESS_ROWS";
				break;
			case "columns":
				sSuppressType = "SUPPRESS_COLUMNS";
				break;
			case "rowsAndColumns":
				sSuppressType = "SUPPRESS_ROWS_AND_COLUMNS";
				break;
			default:
				sSuppressType = "SUPPRESS_OFF";
				break;
		}

		
		if (! this.moMQManager.hasPivottedColumns() && sSuppressType !== "SUPPRESS_OFF") 
		{
			sSuppressType = "SUPPRESS_ROWS";
		}		
	}
	else
	{
		sSuppressType = "SUPPRESS_OFF";
	}
	
	return sSuppressType;
};















CSuppress.prototype.execute = function (aParameters)
{
	if (! this.isNullSuppressionAllowed())
	{
		return;
	}	
	try
	{		
		
		var sSuppressionCommand = "";
		var aCommandArray = new Array();
		
		
		if (aParameters && aParameters["xxSuppressionType"] && aParameters["xxSuppressionType"].length)
		{
			sSuppressionCommand = this.getCommand(aParameters["xxSuppressionType"]); 
			
			aCommandArray = this.getValues();
		}
		
		
		
		else if (aParameters && aParameters["xxSwapSuppressionValue"] && aParameters["xxSwapSuppressionValue"].length)
		{
			
			sSuppressionCommand = this.getCommand(this.getType());
			
			
			
			this.swapValue(aParameters["xxSwapSuppressionValue"]);
			
			
			aCommandArray = this.getValues();
		}
		else
		{
			
			
			sSuppressionCommand = this.getTypeCommandFromDialog(aParameters);
			aCommandArray = this.getValuesFromDialog(aParameters);
		}
		
		
		if (sSuppressionCommand != "N" && this._commandArrayIsEmpty(aCommandArray))
		{
			alert (goApplicationManager.getApplicationFrame().cfgGet("suppressionUncheckedError")); 
			return false;
		}
	
		var sCommand = createCommand("R", sSuppressionCommand, aCommandArray);
		if (sCommand.length > 0)
		{
			sendCmd(sCommand, "", true);
		}		
		goApplicationManager.getWindowManager().hideDialogFrame();
	}
	catch (e)
	{
	}
};


CSuppress.prototype.getValueTypes = function ()
{
	return (Array(
		'suppressZeroValues',
		'suppressDivideByZero',
		'suppressMissingValues',
		'suppressOverflowValues'
	));
};





CSuppress.prototype.getValues = function ()
{
	var aSuppressValues = new Array();
	
	var aSuppressValueTypes = this.getValueTypes();
	
	for (var iIndex = 0; iIndex < aSuppressValueTypes.length; iIndex++)
	{
		var sValueType = aSuppressValueTypes[iIndex];
		var sSuppressionValue = this.getValue(sValueType);
		if (! sSuppressionValue)
		{
			
			sSuppressionValue = "true";
		}
		aSuppressValues[iIndex] = sSuppressionValue;
	}

	return (aSuppressValues);
};



CSuppress.prototype.getValue = function (sValueType)
{
	if (! this.isValidValue(sValueType) || ! this.isNullSuppressionAllowed())
	{
		return;
	}
	
	
	var sValue = this.moMQManager.getCRQReportNode().getAttribute(sValueType);
	if (!sValue)
	{
		sValue = "true";
	}
	return sValue;
};



CSuppress.prototype.setValue = function (sValueType, sValue)
{
	if (! this.isValidValue(sValueType) || ! this.isNullSuppressionAllowed())
	{
		return;
	}
	if (sValue !== "true" && sValue !== "false")
	{
		return;
	}	
	this.moMQManager.getCRQReportNode().setAttribute(sValueType, sValue);
};


CSuppress.prototype.swapValue = function (sValue)
{
	
	if (! this.isValidValue(sValue) || ! this.isNullSuppressionAllowed())
	{
		return;
	}
	var sCurrentValue = this.getValue(sValue);
	var sNewValue;
	switch (sCurrentValue)
	{
		case "false":		
			sNewValue = "true";
			break;
		case "true":	
		default:
			
			sNewValue = "false";
			break;			
	}
	this.setValue(sValue, sNewValue);
};



CSuppress.prototype.isValidValue = function (sValue)
{
	var aValues = this.getValueTypes();
	for (var iIndex = 0; iIndex < aValues.length; iIndex++)
	{
		if (aValues[iIndex] === sValue)
		{
			return true;
		}
	}
	return false;
};







CSuppress.prototype.getTypeCommandFromDialog = function (aParameters)
{
	
	if (typeof aParameters === "undefined" || ! aParameters["f"])
	{
		
		return this.getCommand("");	
	}
		
	
	var iSuppressionTypeIndex = 0;
	var sSuppressionType = "";
	
	
	for (iSuppressionTypeIndex = 0; iSuppressionTypeIndex < aParameters["f"].suppressionType.length; iSuppressionTypeIndex++)
	{
		if (aParameters["f"].suppressionType[iSuppressionTypeIndex].checked)
		{
			sSuppressionType = aParameters["f"].suppressionType[iSuppressionTypeIndex].value;
		}
	}	
	
	
	var sReturn = this.getCommand(sSuppressionType);
	return sReturn;
};


CSuppress.prototype.getCommand = function (sSuppressionType)
{
	var sReturn = "";
	switch (sSuppressionType)
	{
		case "SUPPRESS_ROWS":
			
			sReturn = "R";
			break;
		case "SUPPRESS_COLUMNS":
			
			sReturn = "C";
			break;
		case "SUPPRESS_ROWS_AND_COLUMNS":
			
			sReturn = "B";
			break;
		case "SUPPRESS_OFF":
		default:
			
			sReturn = "N";
	}
	return sReturn;
};




CSuppress.prototype.getValuesFromDialog = function (aParameters)
{
	var aCommandArray = new Array();
	
	
	if (typeof aParameters === "undefined" || ! aParameters["f"])
	{
		return aCommandArray;
	}
	
	var aOptionsChecked = new Array (aParameters["f"].suppressZeroValues, 
		aParameters["f"].suppressDivideByZero,
		aParameters["f"].suppressMissingValues,
		aParameters["f"].suppressOverflowValues
		);
	
	
	
	for (var iOptionIndex = 0; iOptionIndex < aOptionsChecked.length; iOptionIndex++)
	{	
		if (aOptionsChecked[iOptionIndex].checked === false)
		{
			aCommandArray.push("false");
		}
		else
		{
			aCommandArray.push("true");
		}
	}

	return aCommandArray;
};






CSuppress.prototype.isNullSuppressionAllowed = function()
{
	
	if (! this.moMQManager || typeof this.moMQManager.getCRQReportNode() !== "object")
	{
		return false;
	}
	return this.m_bIsNullSuppressionAllowed;
};
CSuppress.prototype.setNullSuppressionAllowed = function(bAccessAllowed)
{
	this.m_bIsNullSuppressionAllowed = this.validateBoolean(bAccessAllowed);
};



CSuppress.prototype.isAccessToNullSuppressionOptionsAllowed = function()
{
	return this.m_bIsAccessToNullSuppressionOptionsAllowed;
};
CSuppress.prototype.setAccessToNullSuppressionOptionsAllowed = function(bAccessAllowed)
{
	this.m_bIsAccessToNullSuppressionOptionsAllowed = this.validateBoolean(bAccessAllowed);
};



CSuppress.prototype.isMultiEdgeNullSuppressionAllowed = function()
{
	return this.m_bIsMultiEdgeNullSuppressionAllowed;
};
CSuppress.prototype.setMultiEdgeNullSuppressionAllowed = function(bAccessAllowed)
{
	this.m_bIsMultiEdgeNullSuppressionAllowed = this.validateBoolean(bAccessAllowed);
};




CSuppress.prototype._commandArrayIsEmpty = function (aCommandArray)
{
	var sKey;
	var bReturn = true;
	
	for (sKey in aCommandArray)
	{
		if (aCommandArray[sKey] == "true")
		{
			bReturn = false;
			break;
		}
	}
	return bReturn;
};



CSuppress.prototype.validateBoolean = function(bValue)
{
	if (! bValue || bValue === "" || bValue === "false" || bValue === false)
	{
		bValue = false;
	}
	else
	{
		bValue = true;
	}
	return bValue;
};