analytics/webcontent/qs/CFilterExpression.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 gsFEslash = '/';
var gsFEspace = ' ';
var gsFElt = '<';
var gsFEgt = '>';
var gsFEquote = '"';
var gsFEequal = '=';
var gsFEtrue = 'true';
var gsFEfalse = 'false';


var gsFE_NODE = "FE";
var gsFE_FROM_NODE = "From";
var gsFE_TO_NODE = "To";
var gsFE_VALUE_NODE = "Value";

var gsFE_ID_ATTR = "id";
var gsFE_USE_ATTR = "use";
var gsFE_DISPLAY_ATTR = "display";
var gsFE_EXCLUSIVE_ATTR = "exclusive";

var gsFE_CLASSNAME_ATTR = "className"; 
var gsFE_DATATYPE_ATTR = "dataType"; 
var gsFE_DEFAULT_ATTR = "default"; 
var gsFE_FILTERTYPE_ATTR = "filterType"; 
var gsFE_LABEL_ATTR = "label"; 
var gsFE_NULL_ATTR = "nullOption"; 
var gsFE_PROMPT_ATTR = "prompt"; 
var gsFE_REPLACEWITH_ATTR = "replaceWith"; 
var gsFE_STYLE_ATTR = "style"; 


var gsFE_FILTERTYPE_ENUM = "enum"; 
var gsFE_FILTERTYPE_RANGE = "range"; 
var gsFE_FILTERTYPE_SINGLE = "singleValue"; 
var gsFE_FILTERTYPE_STARTSWITH = "startsWith"; 
var gsFE_FILTERTYPE_ENDSWITH = "endsWith"; 
var gsFE_FILTERTYPE_CONTAINS = "contains"; 
var gsFE_FILTERTYPE_ISLIKE = "isLike"; 
var gsFE_FILTERTYPE_DAYS_BEFORE_TODAY = "daysBeforeToday"; 
var gsFE_FILTERTYPE_TYPEINRANGE = "typeInRange"; 
var gsFE_FILTERTYPE_EXACTLYMATCHES = "exactlyMatches";
var gsFE_FILTERTYPE_SEARCH = "search";

var gsFE_NULL_EMPTY = ""; 
var gsFE_NULL_INCLUDE = "include"; 
var gsFE_NULL_EXCLUDE = "exclude"; 
var gsFE_NULL_ONLY = "only"; 

var gsFE_REPLACEWITH_LABEL = "label"; 
var gsFE_REPLACEWITH_EXPR = "expression"; 
var gsFE_REPLACEWITH_NULL = "null"; 


var reFE_FILTERTYPE_VALID = new RegExp('^(|' + [gsFE_FILTERTYPE_ENUM, gsFE_FILTERTYPE_RANGE, gsFE_FILTERTYPE_SINGLE, gsFE_FILTERTYPE_STARTSWITH, gsFE_FILTERTYPE_ENDSWITH, gsFE_FILTERTYPE_CONTAINS, gsFE_FILTERTYPE_ISLIKE, gsFE_FILTERTYPE_DAYS_BEFORE_TODAY, gsFE_FILTERTYPE_TYPEINRANGE, gsFE_FILTERTYPE_EXACTLYMATCHES, gsFE_FILTERTYPE_SEARCH].join('|') + ')$', 'i');
var reFE_REPLACEWITH_VALID = new RegExp('^$(|' + [gsFE_REPLACEWITH_LABEL, gsFE_REPLACEWITH_EXPR, gsFE_REPLACEWITH_NULL].join('|') + ')$', 'i');
var reFE_NODENAME_VALID = new RegExp('^(' + [gsFE_FROM_NODE, gsFE_TO_NODE, gsFE_VALUE_NODE].join('|') + ')$', 'i');
var reFE_NULLOPTION_VALID = new RegExp('^(' + [gsFE_NULL_EMPTY, gsFE_NULL_INCLUDE, gsFE_NULL_EXCLUDE, gsFE_NULL_ONLY].join('|') + ')$', 'i');


function CFilterExpression(sId, aValues, bDefault, sFilterType, sDataType, sNullOption, sClassName, sStyle, sLabel, sReplaceWith, sPrompt, sDataItemName)
{
	if (sId && sId.nodeName)
	{
		
		this.m_nNode = sId;
	}
	else
	{
		this.init(sId, aValues, bDefault, sFilterType, sDataType, sNullOption, sClassName, sStyle, sLabel, sReplaceWith, sPrompt, sDataItemName);
	}

	return this;
};

function CFilterExpression_init(sId, aValues, bDefault, sFilterType, sDataType, sNullOption, sClassName, sStyle, sLabel, sReplaceWith, sPrompt, sDataItemName)
{
	var oDoc = getOrCreateMiniQueryDocument();
	var oMQMgr = goApplicationManager.getMiniQueryManager();
	this.m_nNode = XMLBuilderCreateElementNS("", "FE", getOrCreateMiniQueryDocument());

	if (typeof sId == "string")
	{
		this.m_nNode.setAttribute("id", sId);
	}

	if (aValues && typeof aValues == 'object' && aValues.length)
	{
		for (var idxValue = 0; idxValue < aValues.length; idxValue++)
		{
			var nValue = XMLBuilderCreateElementNS("", "Value", this.m_nNode.ownerDocument);
			nValue.setAttribute("use", aValues[idxValue].getUse());
			nValue.setAttribute("display", aValues[idxValue].getDisplay());
			this.m_nNode.appendChild(nValue);
		}
	}

	if (bDefault === true || bDefault == gsFEtrue)
	{
		this.m_nNode.setAttribute("default", "true");
	}
	if (reFE_FILTERTYPE_VALID.test(sFilterType))
	{
		this.m_nNode.setAttribute(gsFE_FILTERTYPE_ATTR, sFilterType);
	}
	if (typeof sDataType == "string")
	{
		this.m_nNode.setAttribute(gsFE_DATATYPE_ATTR, sDataType);
	}
	if (reFE_NULLOPTION_VALID.test(sNullOption))
	{
		this.m_nNode.setAttribute(gsFE_NULL_ATTR, sNullOption);
	}
	if (typeof sClassName == "string")
	{
		this.m_nNode.setAttribute(gsFE_CLASSNAME_ATTR, sClassName);
	}
	if (typeof sStyle == "string")
	{
		this.m_nNode.setAttribute(gsFE_STYLE_ATTR, sStyle);
	}
	if (typeof sLabel == "string")
	{
		this.m_nNode.setAttribute(gsFE_LABEL_ATTR, sLabel);
	}
	if (reFE_REPLACEWITH_VALID.test(sReplaceWith))
	{
		this.m_nNode.setAttribute(gsFE_REPLACEWITH_ATTR, sReplaceWith);
	}
	if (typeof sPrompt == "string")
	{
		this.m_nNode.setAttribute(gsFE_PROMPT_ATTR, sPrompt);
	}

	
	this.m_oFilter = null;

	
	if (typeof sDataItemName == "string")
	{
		this.m_nNode.setAttribute("ddataItemName", sDataItemName);
	}
};


function CFilterExpression_clone()
{
	return (new CFilterExpression(this.m_nNode.cloneNode(true)));
};

function CFilterExpression_equals(o)
{
	return (this.getXML() == o.getXML());
};

function CFilterExpression_addValue(sUse, sDisplay)
{
	this.removeAllNodes(gsFE_FROM_NODE);
	this.removeAllNodes(gsFE_TO_NODE);

	
	
	if (typeof sDisplay !== "string")
	{
		sDisplay = "";
	}

	var nValue = XMLBuilderCreateElementNS("", gsFE_VALUE_NODE, this.m_nNode.ownerDocument);
	if (sUse instanceof CFilterValue)
	{
		nValue.setAttribute(gsFE_USE_ATTR, sUse.getUse());
		nValue.setAttribute(gsFE_DISPLAY_ATTR, sUse.getDisplay());
	}
	else
	{
		nValue.setAttribute(gsFE_USE_ATTR, sUse);
		nValue.setAttribute(gsFE_DISPLAY_ATTR, sDisplay);
	}
	this.m_nNode.appendChild(nValue);
	
	
	var sPreviousFilterType = this.m_nNode.getAttribute("filterType");
	if (! sPreviousFilterType || sPreviousFilterType === "")
	{
		this.setFilterType(gsFE_FILTERTYPE_ENUM);
	}

	return (new CFilterValue(nValue));
};

function CFilterExpression_addValues(aValues)
{
	if (typeof aValues == 'object' && aValues.length)
	{
		for (var idxValue = 0; idxValue < aValues.length; idxValue++)
		{
			this.addValue(aValues[idxValue]);
		}
	}
};

function CFilterExpression_getFilter()
{
	var nFilter = this.m_nNode.parentNode;
	while (nFilter && !nFilter.nodeName.match(/^Filter$/i))
	{
		nFilter = nFilter.parentNode;
	}
	var oFilter = null;
	if (nFilter)
	{
		oFilter = new CFilter("", nFilter);
	}
	return oFilter;
};

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

	
	var oClone = this.clone();

	
	var aPV = getPromptPageParameterValues();
	var sPName = "p_" + this.m_sPrompt;
	var pv = "";
	if (aPV && aPV.length)
	{
		for (var idxPV = 0; idxPV < aPV.length; ++idxPV)
		{
			if (aPV[idxPV][0] == sPName)
			{
				pv = aPV[idxPV][1];
			}
		}
	}
	var xmlPV = (typeof XMLParser == 'function' ? XMLParser(pv) : null);
	if (xmlPV)
	{
		var start = xmlPV.findChildByName("start");
		var end = xmlPV.findChildByName("end");
		var values = xmlPV.getElementsByTagName("selectOption");

		if (start || end)
		{
			if (start)
			{
				oClone.setFrom(start.getAttribute("useValue"), start.getAttribute("displayValue"));
			}
			if (end)
			{
				oClone.setTo(end.getAttribute("useValue"), end.getAttribute("displayValue"));
			}
		}
		else if (values.length)
		{
			for (var idxValue = 0; idxValue < values.length; idxValue++)
			{
				oClone.addValue(values[idxValue].getAttribute("useValue"), values[idxValue].getAttribute("displayValue"));
			}
		}
	}

	
	oClone.setPrompt("");

	
	return sXmlDecode(oClone.getText());
};

function CFilterExpression_getText()
{
	var oFilter = this.getFilter();
	var sText = "";
	if (oFilter)
	{
		sText = oFilter.getText();
	}
	return sText;
};

function CFilterExpression_getXML()
{
	var sXML = "";

	
	
	
	
	if (this.m_nNode.hasChildNodes()
		|| this.m_nNode.getAttribute("prompt")
		|| this.isDefault()
		|| (this.getNullOption() && this.getNullOption().length != 0)
	)
	{
		sXML = XMLBuilderSerializeNode( this.m_nNode );
	}
	return sXML;
};

function CFilterExpression_removeAllNodes(sNodeName)
{
	var aNodes = XMLHelper_FindChildrenByTagName(this.m_nNode, sNodeName, false);
	for (var idxNode = 0; idxNode < aNodes.length; idxNode)
	{
		this.m_nNode.removeChild(aNodes[idxNode]);
	}
};

function CFilterExpression_setFrom(sUse, sDisplay, bExclude)
{
	this.removeAllNodes(gsFE_VALUE_NODE);

	if (!sUse)
	{
		return;
	}
	
	
	
	if (typeof sDisplay !== "string")
	{
		sDisplay = "";
	}

	var nValue = XMLBuilderCreateElementNS("", gsFE_FROM_NODE, this.m_nNode.ownerDocument);
	nValue.setAttribute(gsFE_USE_ATTR, sUse);
	nValue.setAttribute(gsFE_DISPLAY_ATTR, sDisplay);
	if (bExclude)
	{
		nValue.setAttribute(gsFE_EXCLUSIVE_ATTR, "true");
	}
	this.m_nNode.appendChild(nValue);
	this.setFilterType(gsFE_FILTERTYPE_RANGE);
};

function CFilterExpression_setTo(sUse, sDisplay, bExclude)
{
	this.removeAllNodes(gsFE_VALUE_NODE);

	if (!sUse)
	{
		return;
	}
	
	
	
	if (typeof sDisplay !== "string")
	{
		sDisplay = "";
	}

	var nValue = XMLBuilderCreateElementNS("", gsFE_TO_NODE, this.m_nNode.ownerDocument);
	nValue.setAttribute(gsFE_USE_ATTR, sUse);
	nValue.setAttribute(gsFE_DISPLAY_ATTR, sDisplay);
	if (bExclude)
	{
		nValue.setAttribute(gsFE_EXCLUSIVE_ATTR, "true");
	}
	this.m_nNode.appendChild(nValue);
	this.setFilterType(gsFE_FILTERTYPE_RANGE);
};


CFilterExpression.prototype.init = CFilterExpression_init;
CFilterExpression.prototype.clone = CFilterExpression_clone;
CFilterExpression.prototype.equals = CFilterExpression_equals;
CFilterExpression.prototype.addValue = CFilterExpression_addValue;
CFilterExpression.prototype.addValues = CFilterExpression_addValues;
CFilterExpression.prototype.getFilter = CFilterExpression_getFilter;
CFilterExpression.prototype.getPromptDisplayValues = CFilterExpression_getPromptDisplayValues;
CFilterExpression.prototype.getText = CFilterExpression_getText;
CFilterExpression.prototype.getXML = CFilterExpression_getXML;
CFilterExpression.prototype.removeAllNodes = CFilterExpression_removeAllNodes;
CFilterExpression.prototype.setFrom = CFilterExpression_setFrom;
CFilterExpression.prototype.setTo = CFilterExpression_setTo;


CFilterExpression.prototype.isDefault = function()
{
	return (this.m_nNode.getAttribute(gsFE_DEFAULT_ATTR)=="true");
};
CFilterExpression.prototype.isRange = function()
{
	return (this.getFilterType() == gsFE_FILTERTYPE_RANGE);
};
CFilterExpression.prototype.setDefault = function(b)
{
	if (b===true||b==gsFEtrue)
	{
		this.m_nNode.setAttribute(gsFE_DEFAULT_ATTR, "true");
	}
	else
	{
		this.m_nNode.removeAttribute(gsFE_DEFAULT_ATTR);
	}
};
CFilterExpression.prototype.getNullOption = function()
{
	return (this.m_nNode.getAttribute(gsFE_NULL_ATTR));
};
CFilterExpression.prototype.setNullOption = function(s)
{
	if (reFE_NULLOPTION_VALID.test(s))
	{
		this.m_nNode.setAttribute(gsFE_NULL_ATTR, s);
	}
	else
	{
		this.m_nNode.removeAttribute(gsFE_NULL_ATTR);
	}
};
CFilterExpression.prototype.getClassName = function()
{
	return (this.m_nNode.getAttribute(gsFE_CLASSNAME_ATTR));
};
CFilterExpression.prototype.setAttribute = function(sName, sValue)
{
	if (sValue)
	{
		this.m_nNode.setAttribute(sName, sValue);
	}
	else
	{
		this.m_nNode.removeAttribute(sName);
	}
};
CFilterExpression.prototype.setClassName = function(s)
{
	this.setAttribute(gsFE_CLASSNAME_ATTR, s);
};
CFilterExpression.prototype.getDataType = function()
{
	return (this.m_nNode.getAttribute(gsFE_DATATYPE_ATTR));
};
CFilterExpression.prototype.setDataType = function(s)
{
	this.setAttribute(gsFE_DATATYPE_ATTR, s);
};
CFilterExpression.prototype.getFilterType = function()
{
	return (this.m_nNode.getAttribute(gsFE_FILTERTYPE_ATTR));
};
CFilterExpression.prototype.setFilterType = function(s)
{
	if (reFE_FILTERTYPE_VALID.test(s))
	{
		this.m_nNode.setAttribute(gsFE_FILTERTYPE_ATTR, s);
	}
};
CFilterExpression.prototype.getId = function()
{
	return (this.m_nNode.getAttribute(gsFE_ID_ATTR));
};
CFilterExpression.prototype.setId = function(s)
{
	this.setAttribute(gsFE_ID_ATTR, s);
};
CFilterExpression.prototype.getLabel = function()
{
	return (this.m_nNode.getAttribute(gsFE_LABEL_ATTR));
};
CFilterExpression.prototype.setLabel = function(s)
{
	this.setAttribute(gsFE_LABEL_ATTR, s);
};
CFilterExpression.prototype.getPrompt = function()
{
	return (this.m_nNode.getAttribute(gsFE_PROMPT_ATTR));
};
CFilterExpression.prototype.setPrompt = function(s)
{
	this.setAttribute(gsFE_PROMPT_ATTR, s);
};
CFilterExpression.prototype.getReplaceWith = function()
{
	return (this.m_nNode.getAttribute(gsFE_REPLACEWITH_ATTR));
};
CFilterExpression.prototype.setReplaceWith = function(s)
{
	if (reFE_REPLACEWITH_VALID.test(s))
	{
		this.m_nNode.setAttribute(gsFE_REPLACEWITH_ATTR, s);
	}
};
CFilterExpression.prototype.getStyle = function()
{
	return (this.m_nNode.getAttribute(gsFE_STYLE_ATTR));
};
CFilterExpression.prototype.setStyle = function(s)
{
	this.setAttribute(gsFE_STYLE_ATTR, s);
};
CFilterExpression.prototype.getValues = function()
{
	return (this.m_aValues);
};
CFilterExpression.prototype.setValues = function(o)
{
	if (typeof o=='object'){this.m_aValues=o;}
};

CFilterExpression.prototype.getDataItemName = function()
{
	return (this.m_nNode.getAttribute("dataItemName"));
};
CFilterExpression.prototype.setDataItemName = function(s)
{
	this.setAttribute("dataItemName", s);
};



function CFilterValue(sUse, sDisplay, bExclude)
{
	this.m_nNode = null;
	if (sUse && sUse.nodeName)
	{
		this.m_nNode = sUse;
	}
	else
	{
		var oMQMgr = goApplicationManager.getMiniQueryManager();
		this.m_nNode = XMLBuilderCreateElementNS("", "Value", oMQMgr.getDoc());
		this.setUse(sUse);
		this.setDisplay(sDisplay);
		this.setExclusive(bExclude);
	}

	return this;
};

function CFilterValue_clone()
{
	return (new CFilterValue(this.n_nNode.cloneNode(true)));
};

function CFilterValue_equals(o)
{
	return (this.getXML() == o.getXML());
};

function CFilterValue_getXML(nodeName)
{
	return XMLBuilderSerializeNode( this.m_nNode );
};

CFilterValue.prototype.clone = CFilterValue_clone;
CFilterValue.prototype.equals = CFilterValue_equals;
CFilterValue.prototype.getXML = CFilterValue_getXML;

CFilterValue.prototype.getUse = function()
{
	return (this.m_nNode.getAttribute(gsFE_USE_ATTR));
};
CFilterValue.prototype.setUse = function(sUse)
{
	this.m_nNode.setAttribute(gsFE_USE_ATTR, (sUse ? sUse : ''));
};
CFilterValue.prototype.getDisplay = function()
{
	var sDisplay = this.m_nNode.getAttribute(gsFE_DISPLAY_ATTR);
	if (!sDisplay)
	{
		sDisplay = this.getUse();
	}
	return (sDisplay);
};
CFilterValue.prototype.setDisplay = function(sDisplay)
{
	if (sDisplay)
	{
		this.m_nNode.setAttribute(gsFE_DISPLAY_ATTR, sDisplay);
	}
	else
	{
		this.m_nNode.removeAttribute(gsFE_DISPLAY_ATTR);
	}
};
CFilterValue.prototype.getExclusive = function()
{
	return (this.m_nNode.getAttribute(gsFE_EXCLUSIVE_ATTR));
};
CFilterValue.prototype.setExclusive = function(bExclude)
{
	if (bExclude === true || bExclude == gsFEtrue)
	{
		this.m_nNode.setAttribute(gsFE_EXCLUSIVE_ATTR, "true");
	}
	else
	{
		this.m_nNode.removeAttribute(gsFE_EXCLUSIVE_ATTR);
	}
};