analytics/webcontent/qs/CFilter.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.











var gsFILTER_MODEL = "model";
var gsFILTER_REFTYPE_MODEL = "modelFilter";
var gsFILTER_REFTYPE_COLUMN = "refColumn";
var gsFILTER_EMPTY = "none";

var greFILTER_REFTYPE_MODEL = new RegExp("^" + gsFILTER_REFTYPE_MODEL + "$", "i");
var greFILTER_REFTYPE_COLUMN = new RegExp("^" + gsFILTER_REFTYPE_COLUMN + "$", "i");
var greFILTER_EMPTY = new RegExp("^" + gsFILTER_EMPTY + "$", "i");



function CFilter(sId, nNode, sRefType, sType, sCondition, sSummary, sText, oParent, bNot)
{
	if (!nNode || !nNode.nodeName)
	{
		var sRefId = "";
		if (nNode)
		{
			sRefId = nNode;
		}
		var oMQMgr = goApplicationManager.getMiniQueryManager();
		nNode = XMLBuilderCreateElementNS("", "Filter", oMQMgr.getDoc());
		if (sCondition instanceof CFilterExpression)
		{
			nNode.appendChild(sCondition.m_nNode);
		}

		if (sRefType && sRefType.match(greFILTER_REFTYPE_MODEL))
		{
			nNode.setAttribute("modelFilter", sText);
			nNode.setAttribute("name", sText);
			nNode.appendChild(nNode.ownerDocument.createTextNode(sCondition));
		}
		else
		{
			if (typeof sCondition == "string")
			{
				var nDoc = oMQMgr.getDoc();
				var nFE = XMLBuilderCreateElementNS("", "FE", nDoc);
				nFE.appendChild(nDoc.createTextNode(sCondition));
				nNode.appendChild(nFE);
			}
			nNode.setAttribute("columnId", sRefId);
			nNode.setAttribute("type", sType);
		}

		if (sSummary)
		{
			nNode.setAttribute("summary", sSummary);
		}
		if (bNot)
		{
			nNode.setAttribute("negate", "true");
		}
	}

	
	
	var oFilterConverter = new CFilterConverter(nNode);
	if (oFilterConverter.needsConversion())
	{
		nNode = oFilterConverter.convert();
	}

	this.m_nNode = nNode;

	
	
	var sNodeId = "";
	if (this.m_nNode)
	{
		sNodeId = this.m_nNode.getAttribute("id");
	}
	if ((! sId || sId === "") && (! sNodeId || sNodeId.length === 0))
	{
		var oCC = getCombinedFilter();
		if (oCC)
		{
			sId = oCC.generateID("F");
		}
	}
	if (sId && sId.length > 0 && sNodeId != sId)
	{
		this.m_nNode.setAttribute("id", sId);
	}	
	
};


function CFilter_clone()
{
	return (new CFilter("", this.m_nNode.cloneNode(true)));
};

function CFilter_getColumnId()
{
	var sColumnId = this.m_nNode.getAttribute("columnId");
	if (!sColumnId && this.m_nNode.parentNode && this.m_nNode.parentNode.nodeName.match(/^Column$/i))
	{
		sColumnId = this.m_nNode.parentNode.getAttribute("id");
	}
	return sColumnId;
};


function CFilter_getCommand()
{
	var sFilterExpr = gsFILTER_EMPTY;
	var sType = this.m_nNode.getAttribute("type");

	if (this.isModelFilter())
	{
		sFilterExpr = XMLHelper_GetText( this.m_nNode, true );
		sType = gsFILTER_MODEL;
	}
	else
	{
		var nFE = XMLHelper_FindChildByTagName(this.m_nNode, "FE", true);
		if (nFE.childNodes.length == 1 && nFE.childNodes[0].nodeType == 3)
		{
			
			sFilterExpr = nFE.childNodes[0].nodeValue;
		}
		else
		{
			sFilterExpr = XMLBuilderSerializeNode( nFE );
		}
	}

	if(!sType)
	{
		sType = "picklist";
	}

	var sSummary = this.m_nNode.getAttribute("summary");

	return [
		this.getFilterType(),
		escapeParam(this.getReference()),
		(sType ? escapeParam(sType) : gsFILTER_EMPTY),
		(sFilterExpr ? escapeParam(sFilterExpr) : gsFILTER_EMPTY),
		(this.isNot() ? 'true' : gsFILTER_EMPTY),
		(sSummary ? escapeParam(sSummary) : gsFILTER_EMPTY) ];
};

function CFilter_getDisplayValue(nNode)
{
	if( !nNode )
		return "";

	return (nNode.getAttribute("display") ? nNode.getAttribute("display") : nNode.getAttribute("use"));
};

function CFilter_getFilterExpression()
{
	var nFE = XMLHelper_FindChildByTagName(this.m_nNode, "FE", true);
	if (!nFE)
	{
		var nFilterExpression = XMLHelper_FindChildByTagName(this.m_nNode, "FilterExpression", true);
		if (!nFilterExpression)
		{
			nFilterExpression = XMLBuilderCreateElementNS("", "FilterExpression", this.m_nNode.ownerDocument);
			this.m_nNode.appendChild(nFilterExpression);
		}
		nFE = XMLBuilderCreateElementNS("", "FE", nFilterExpression.ownerDocument);
		nFilterExpression.appendChild(nFE);
	}

	return (new CFilterExpression(nFE));
};

function CFilter_getFilterType()
{
	var sType = gsFILTER_REFTYPE_COLUMN;
	if (this.m_nNode.getAttribute("modelFilter"))
	{
		sType = gsFILTER_REFTYPE_MODEL;
	}
	else
	{
		var sName = this.m_nNode.getAttribute("name");
		var sColumnId = this.getColumnId();

		if (sName && !sColumnId)
		{
			var nParent = this.m_nNode.parentNode;
			if ( !(nParent && nParent.nodeName.match(/^Column$/i)) )
			{
				sType = gsFILTER_REFTYPE_MODEL;
			}
		}
	}
	return sType;
};

function CFilter_getId()
{
	return (this.m_nNode.getAttribute("id"));
};

function CFilter_getPromptDisplayValues()
{
	var cf = getConfigFrame();

	
	var oClone = this.clone();

	if ( !oClone.m_nNode.getAttribute("columnId") )
	{
		
		var sColumnId = this.getColumnId();
		oClone.m_nNode.setAttribute("columnId", sColumnId);
	}

	
	var aPV = getPromptPageParameterValues();
	var sPName = "p_" + this.getFilterExpression().getPrompt();
	var pv = "";
	if (aPV && aPV.length)
	{
		for (var idxPV = 0; idxPV < aPV.length; ++idxPV)
		{
			if (aPV[idxPV][0] == sPName)
			{
				pv = aPV[idxPV][1];
			}
		}
	}

	var oFE = oClone.getFilterExpression();
	var nSelectChoices = XMLBuilderLoadXMLFromString(pv);
	if (nSelectChoices)
	{
		var nStart = XMLHelper_FindChildByTagName(nSelectChoices, "start", true);
		var nEnd = XMLHelper_FindChildByTagName(nSelectChoices, "end", true);
		var aValues = XMLHelper_FindChildrenByTagName(nSelectChoices, "selectOption", true);

		if (nStart || nEnd)
		{
			if (nStart)
			{
				oFE.setFrom(nStart.getAttribute("useValue"), nStart.getAttribute("displayValue"));
			}
			if (nEnd)
			{
				oFE.setTo(nEnd.getAttribute("useValue"), nEnd.getAttribute("displayValue"));
			}
		}
		else if (aValues.length)
		{
			for (var idxValue = 0; idxValue < aValues.length; idxValue++)
			{
				oFE.addValue(aValues[idxValue].getAttribute("useValue"), aValues[idxValue].getAttribute("displayValue"));
			}
		}
	}

	oFE.setPrompt("");
	return sXmlDecode(oClone.getText());
};

function CFilter_getReference()
{
	var sRef = "";
	if (this.isModelFilter())
	{
		sRef = this.m_nNode.getAttribute("modelFilter");
		if (!sRef)
		{
			sRef = this.m_nNode.getAttribute("name");
		}
		if (!sRef)
		{
			sRef = XMLHelper_GetText( this.m_nNode, true );
		}
	}
	else
	{
		sRef = this.getColumnId();
	}
	return sRef;
};


function CFilter_getText()
{
	var sText = "";
	if (this.isModelFilter())
	{
		sText = this.m_nNode.getAttribute("modelFilter");
		if (!sText)
		{
			sText = this.m_nNode.getAttribute("name");
		}
	}
	else
	{
		var oMQMgr = goApplicationManager.getMiniQueryManager();
		var cf = getConfigFrame();
		var aParams = [];
		var msgID = "FILTER_SUBTITLE_BASIC";

		var nFE = XMLHelper_FindChildByTagName(this.m_nNode, "FE", true);
		var sColumnId = this.getColumnId();
		var iDataType = oMQMgr.getAttributeOnColumn(sColumnId, "type", "integer");

		var sColumnLabel = oMQMgr.getColumnLabel( sColumnId );
		if (sColumnLabel === MINI_QUERY_NO_COLUMN_FOUND)
		{
			sColumnLabel = sColumnId;
		}

		var tempFilterString = "";

		var sFEType = nFE.getAttribute("filterType");
		if (nFE.getAttribute("prompt"))
		{
			return this.getPromptDisplayValues();
		}
		else if ((/^enum$/i).test(sFEType) || (/^exactlyMatches$/i).test(sFEType) || (/^search$/i).test(sFEType))
		{
			
			var aValues = XMLHelper_FindChildrenByTagName(nFE, "Value", true);
			tempFilterString = this.generateArrayText(aValues);
		}
		else if ((/^(range|typeInRange)$/i).test(sFEType))
		{
			
			var f = XMLHelper_FindChildByTagName(nFE, "From", true);
			var t = XMLHelper_FindChildByTagName(nFE, "To", true);

			if (f)
			{
				aParams.push( this.getDisplayValue(f) );
			}
			if (t)
			{
				aParams.push( this.getDisplayValue(t) );
			}

			
			if (f && t)
			{
				msgID = (f.getAttribute("use") == t.getAttribute("use") ? "FILTER_EQUAL_" : "FILTER_BETWEEN_");
				if ( this.isExclusive(f) && this.isExclusive(t) )
				{
					msgID = "FILTER_GREATER_THAN_AND_LESS_THAN_";
				}
				else if ( this.isExclusive(f) )
				{
					msgID = "FILTER_GREATER_THAN_AND_LESS_THAN_EQUAL_TO_";
				}
				else if ( this.isExclusive(t) )
				{
					msgID = "FILTER_GREATER_THAN_EQUAL_TO_AND_LESS_THAN_";
				}
			}
			else if (t)
			{
				msgID = ( this.isExclusive(t) ? "FILTER_LESS_THAN_" : "FILTER_LESS_THAN_EQUAL_TO_" );
			}
			else if (f)
			{
				msgID = ( this.isExclusive(f) ? "FILTER_GREATER_THAN_" : "FILTER_GREATER_THAN_EQUAL_TO_" );
			}
			else
			{
				
				
				var aValues = XMLHelper_FindChildrenByTagName(nFE, "Value", true);
				tempFilterString = this.generateArrayText(aValues);				
			}
			
			switch(iDataType)
			{
				case 50:
					msgID += "DATE"; break;
				case 51:
					msgID += "TIME"; break;
				case 52:
					msgID += "DATETIME"; break;
				case 53:
					msgID += "INTERVAL"; break;
				default:
					msgID += "STRING";
			}
		}
		else if ((/^singleValue$/i).test(sFEType) && this.m_aValues && this.m_aValues.length && this.m_aValues[0])
		{
			var nValue = XMLHelper_FindChildByTagName(nFE, "Value", true);
			
			msgID = "FILTER_EQUAL_";
			switch(iDataType)
			{
				case 50:
					msgID += "DATE"; break;
				case 51:
					msgID += "TIME"; break;
				case 52:
					msgID += "DATETIME"; break;
				case 53:
					msgID += "INTERVAL"; break;
				default:
					msgID += "STRING";
			}
			aParams.push( this.getDisplayValue(nValue) );
		}
		else if ((/^startsWith$/i).test(sFEType))
		{
			var nValue = XMLHelper_FindChildByTagName(nFE, "Value", true);
			msgID = "FILTER_STARTS_WITH";
			aParams.push(sColumnLabel);
			aParams.push(this.getDisplayValue(nValue));
		}
		else if ((/^endsWith$/i).test(sFEType))
		{
			var nValue = XMLHelper_FindChildByTagName(nFE, "Value", true);
			msgID = "FILTER_ENDS_WITH";
			aParams.push(sColumnLabel);
			aParams.push(this.getDisplayValue(nValue));
		}
		else if ((/^contains$/i).test(sFEType))
		{
			var nValue = XMLHelper_FindChildByTagName(nFE, "Value", true);
			msgID = "FILTER_CONTAINS";
			aParams.push(sColumnLabel);
			aParams.push(this.getDisplayValue(nValue));
		}
		else if ((/^isLike$/i).test(sFEType))
		{
			var aValues = XMLHelper_FindChildrenByTagName(nFE, "Value", true);
			msgID = "FILTER_IS_LIKE";
			aParams.push(sColumnLabel);
			aParams.push(this.generateArrayText(aValues));
		}
		else if ((/^daysBeforeToday$/i).test(sFEType))
		{
			var nValue = XMLHelper_FindChildByTagName(nFE, "Value", true);
			msgID = "FILTER_DAYS_BEFORE_TODAY";
			aParams.push(sColumnLabel);
			aParams.push(this.getDisplayValue(nValue));
			aParams.push(getFormatDate(new Date()));
		}
		var filterString = "";
		if (aParams.length)
		{
			filterString = cf.filterMsgStrings[msgID];
			for (var idxParam = 0; idxParam < aParams.length; idxParam++)
			{
				var re = new RegExp("\\^"+idxParam,"gi");
				filterString = filterString.replace(re, aParams[idxParam]);
			}
		}
		else if (tempFilterString)
		{
			filterString = tempFilterString;
		}

		
		var nullOption = nFE.getAttribute("nullOption");
		if (nullOption == gsFE_NULL_INCLUDE && filterString)
		{
			if (filterString !== "")
			{
				tempFilterString = cf.filterMsgStrings["FILTER_SUBTITLE_OR_IS_MISSING"];
				filterString = tempFilterString.replace(/\^0/g, filterString);
			}
			else
			{
				tempFilterString = cf.filterMsgStrings["FILTER_SUBTITLE_IS_MISSING"];
				filterString = tempFilterString.replace(/\^0/g, sColumnLabel);
			}
		}
		else if (nullOption == gsFE_NULL_EXCLUDE)
		{
			if (filterString !== "")
			{
				tempFilterString = cf.filterMsgStrings["FILTER_SUBTITLE_AND_IS_NOT_MISSING"];
				filterString = tempFilterString.replace(/\^0/g, filterString);
			}
			else
			{
				tempFilterString = cf.filterMsgStrings["FILTER_SUBTITLE_IS_NOT_MISSING"];
				filterString = tempFilterString.replace(/\^0/g, sColumnLabel);
			}
		}
		else if (nullOption == gsFE_NULL_ONLY)
		{
			tempFilterString = cf.filterMsgStrings["FILTER_SUBTITLE_IS_MISSING_ONLY"];
			filterString = tempFilterString.replace(/\^0/g, sColumnLabel);
		}

		if ((/^startsWith$/i).test(sFEType) ||
			(/^endsWith$/i).test(sFEType) ||
			(/^contains$/i).test(sFEType) ||
			(/^isLike$/i).test(sFEType) ||
			(/^daysBeforeToday$/i).test(sFEType))
		{
			sText = filterString;
		}
		else
		{
			
			var sSummaryId = this.m_nNode.getAttribute("summary");
			var sSummaryLabel = "";
			if (typeof sSummaryId == "string" && sSummaryId !== "" && sSummaryId != "true" && sSummaryId != "none")
			{
				sSummaryLabel = oMQMgr.getColumnLabel(sSummaryId);
				if (sSummaryLabel === MINI_QUERY_NO_COLUMN_FOUND)
				{
					sSummaryLabel = "";
				}
			}

			if (sSummaryLabel)
			{
				sText = cf.filterMsgStrings["FILTER_SUBTITLE_SUMMARY"];
				sText = sText.replace(/\^0/g, sColumnLabel);
				sText = sText.replace(/\^1/g, sSummaryLabel);
				sText = sText.replace(/\^2/g, filterString);
			}
			else
			{
				sText = cf.filterMsgStrings["FILTER_SUBTITLE_BASIC"];
				sText = sText.replace(/\^0/g, sColumnLabel);
				sText = sText.replace(/\^1/g, filterString);
			}
		}
	}

	if (this.isNot())
	{
		sText = htmlencode(cf.filterMsgStrings["FILTER_COMBINE_NOT"].replace(/\^0/gi, sText));
	}

	return sText;
};

function CFilter_getType()
{
	var FENode = XMLHelper_FindChildByTagName(this.m_nNode, "FE", true);
	if (FENode !== null)
	{
		var feFilterType = FENode.getAttribute("filterType");
		var reFilterTypes = new RegExp( "^("+ [gsFE_FILTERTYPE_DAYS_BEFORE_TODAY, gsFE_FILTERTYPE_ISLIKE, gsFE_FILTERTYPE_CONTAINS, gsFE_FILTERTYPE_ENDSWITH, gsFE_FILTERTYPE_STARTSWITH, gsFE_FILTERTYPE_TYPEINRANGE, gsFE_FILTERTYPE_EXACTLYMATCHES, gsFE_FILTERTYPE_SEARCH].join("|") +")$" );
		if (reFilterTypes.test(feFilterType))
		{
			return feFilterType;
		}
	}
	return (this.m_nNode.getAttribute("type"));
};

function CFilter_initWithString(sExpr)
{

};


function CFilter_isDirty()
{
	return (this.m_nNode.getAttribute("dirty") == "true");
};

function CFilter_isExclusive(nNode)
{
	return (nNode.getAttribute(gsFE_EXCLUSIVE_ATTR) == "true");
};

function CFilter_isModelFilter()
{
	return (this.getFilterType() == gsFILTER_REFTYPE_MODEL);
};

function CFilter_isNot()
{
	return (this.m_nNode.getAttribute("negate") == "true");
};


function CFilter_removeSelf(bPreventRebalance)
{
	var nParent = this.m_nNode.parentNode;
	if (nParent)
	{
		nParent.removeChild(this.m_nNode);
	}
	if (!bPreventRebalance)
	{
		var oParent = new CFilterGroup("", nParent);
		oParent.rebalance();
	}
	return this;
};


function CFilter_render()
{
	var sId = this.m_nNode.getAttribute("id");
	var s = '<a fid="' + sId + '"';

	if (this.isDirty())
	{
		s += ' class="bold"';
	}
	
	if (document.all)
	{
		s += ' href="javascript:if(getDialogFrame().modifyFilter)getDialogFrame().modifyFilter(\'' + sId + '\');"';
		s += ' onmouseover="window.status=\'\';return true;"';
		s += ' onmouseout="window.status=\'\';return true;"';
	}
	else
	{
		s += ' href="javascript:void(0);"';
		s += ' onclick="getDialogFrame().modifyFilter(\'' + sId + '\');event.preventDefault();return true;"';
		s += ' onmouseover="window.status=\'\';event.preventDefault();return true;"';
		s += ' onmouseout="window.status=\'\';event.preventDefault();return true;"';
	}
	s += '>';

	s += htmlencode(this.getText());

	s += '</a>';

	return s;
};

function CFilter_setCondition(oCondition)
{
	if (oCondition && oCondition.m_nNode)
	{
		var nParent = XMLHelper_FindChildByTagName(this.m_nNode, "FilterExpression", true);
		if (!nParent)
		{
			nParent = this.m_nNode;
		}
		if (nParent)
		{
			while (nParent.hasChildNodes())
			{
				nParent.removeChild(nParent.firstChild);
			}
			nParent.appendChild(oCondition.m_nNode);
		}
	}
};


function CFilter_setDirty(bDirty)
{
	if (bDirty !== false)
	{
		this.m_nNode.setAttribute("dirty", "true");
	}
	else
	{
		this.m_nNode.removeAttribute("dirty");
	}
};


function CFilter_setNot(bNot)
{
	if (bNot === true || bNot == "true")
	{
		this.m_nNode.setAttribute("negate", "true");
	}
	else
	{
		this.m_nNode.removeAttribute("negate");
	}
	this.setDirty();
};

function CFilter_setSummary(sSummary)
{
	if (sSummary)
	{
		this.m_nNode.setAttribute("summary", sSummary);
	}
	else
	{
		this.m_nNode.removeAttribute("summary");
	}
	this.setDirty();
};

function CFilter_generateArrayText(aValues)
{
	var sTemp = "";
	var sConcatArray = filterMsgStrings["ARRAY_VALUES"];
	for (var idxValue = 0; idxValue < aValues.length; idxValue++)
	{
		var sDV = ( this.getDisplayValue(aValues[idxValue]) );
		if (idxValue === 0)
		{
			sTemp = sDV;
		}
		else
		{
			sTemp = sConcatArray.replace(/\^0/gi, sTemp).replace(/\^1/gi, sDV);
		}
	}
	return sTemp;
};


CFilter.prototype.clone = CFilter_clone;
CFilter.prototype.getColumnId = CFilter_getColumnId;
CFilter.prototype.getCommand = CFilter_getCommand;
CFilter.prototype.getDisplayValue = CFilter_getDisplayValue;
CFilter.prototype.getFilterExpression = CFilter_getFilterExpression;
CFilter.prototype.getFilterType = CFilter_getFilterType;
CFilter.prototype.getId = CFilter_getId;
CFilter.prototype.getPromptDisplayValues = CFilter_getPromptDisplayValues;
CFilter.prototype.getReference = CFilter_getReference;
CFilter.prototype.getText = CFilter_getText;
CFilter.prototype.getType = CFilter_getType;
CFilter.prototype.initWithString = CFilter_initWithString;
CFilter.prototype.isDirty = CFilter_isDirty;
CFilter.prototype.isExclusive = CFilter_isExclusive;
CFilter.prototype.isModelFilter = CFilter_isModelFilter;
CFilter.prototype.isNot = CFilter_isNot;
CFilter.prototype.removeSelf = CFilter_removeSelf;
CFilter.prototype.render = CFilter_render;
CFilter.prototype.setCondition = CFilter_setCondition;
CFilter.prototype.setDirty = CFilter_setDirty;
CFilter.prototype.setNot = CFilter_setNot;
CFilter.prototype.setSummary = CFilter_setSummary;
CFilter.prototype.generateArrayText = CFilter_generateArrayText;