public void addFilter( string filterName, EventFilter filter )

Registers an EventFilter by name.

Parameters:

string filterName

EventFilter filter

Code:

	<cffunction name="addFilter" access="public" returntype="void" output="false"
		hint="Registers an EventFilter by name.">
		<cfargument name="filterName" type="string" required="true" />
		<cfargument name="filter" type="MachII.framework.EventFilter" required="true" />
		
		<cfif isFilterDefined(arguments.filterName)>
			<cfthrow type="MachII.framework.FilterAlreadyDefined"
				message="An EventFilter with name '#arguments.filterName#' is already registered." />
		<cfelse>
			<cfset variables.filters[arguments.filterName] = arguments.filter />
		</cfif>
	</cffunction> 

public void configure( )

Configures each of the registered EventFilters.

Parameters:

Code:

	<cffunction name="configure" access="public" returntype="void"
		hint="Configures each of the registered EventFilters.">
		<cfset var key = "" />
		<cfloop collection="#variables.filters#" item="key">
			<cfset getFilter(key).configure() />
		</cfloop>
	</cffunction> 

public AppManager getAppManager( )

Parameters:

Code:

	<cffunction name="getAppManager" access="public" returntype="MachII.framework.AppManager" output="false">
		<cfreturn variables.appManager />
	</cffunction> 

public EventFilter getFilter( string filterName )

Parameters:

string filterName

Code:

	<cffunction name="getFilter" access="public" returntype="MachII.framework.EventFilter" output="false">
		<cfargument name="filterName" type="string" required="true" />
		
		<cfif isFilterDefined(arguments.filterName)>
			<cfreturn variables.filters[arguments.filterName] />
		<cfelse>
			<cfthrow type="MachII.framework.FilterNotDefined" 
				message="Filter with name '#arguments.filterName#' is not defined." />
		</cfif>
	</cffunction> 

public array getFilterNames( )

Returns an array of filter names.

Parameters:

Code:

	<cffunction name="getFilterNames" access="public" returntype="array" output="false"
		hint="Returns an array of filter names.">
		<cfreturn StructKeyArray(variables.filters) />
	</cffunction> 

public void init( string configXML, AppManager appManager )

Initialization function called by the framework.

Parameters:

string configXML

AppManager appManager

Code:

	<cffunction name="init" access="public" returntype="void" output="false"
		hint="Initialization function called by the framework.">
		<cfargument name="configXML" type="string" required="true" />
		<cfargument name="appManager" type="MachII.framework.AppManager" required="true" />
		
		<cfset var filterNodes = "" />
		<cfset var filterParams = "" />
		<cfset var name = "" />
		<cfset var type = "" />
		<cfset var paramNodes = "" />
		<cfset var paramName = "" />
		<cfset var paramValue = "" />
		<cfset var filter = "" />
		<cfset var i = 0 />
		<cfset var j = 0 />
		
		<cfset setAppManager(arguments.appManager) />

		
		<cfset filterNodes = XMLSearch(configXML,"//event-filters/event-filter") />
		<cfloop from="1" to="#ArrayLen(filterNodes)#" index="i">
			<cfset name = filterNodes[i].xmlAttributes['name'] />
			<cfset type = filterNodes[i].xmlAttributes['type'] />
		
			
			<cfset filterParams = StructNew() />
			<cfset paramNodes = XMLSearch(filterNodes[i], "./parameters/parameter") />
			<cfloop from="1" to="#ArrayLen(paramNodes)#" index="j">
				<cfset paramName = paramNodes[j].xmlAttributes['name'] />
				<cfset paramValue = paramNodes[j].xmlAttributes['value'] />
				<cfset filterParams[paramName] = paramValue />
			</cfloop>
			
			<cfset filter = CreateObject('component', type) />
			<cfset filter.init(arguments.appManager, filterParams) />
			
			<cfset addFilter(name, filter) />
		</cfloop> 
	</cffunction> 

public boolean isFilterDefined( string filterName )

Parameters:

string filterName

Code:

	<cffunction name="isFilterDefined" access="public" returntype="boolean" output="false">
		<cfargument name="filterName" type="string" required="true" />
		<cfreturn StructKeyExists(variables.filters, arguments.filterName) />
	</cffunction> 

public void setAppManager( AppManager appManager )

Parameters:

AppManager appManager

Code:

	<cffunction name="setAppManager" access="public" returntype="void" output="false">
		<cfargument name="appManager" type="MachII.framework.AppManager" required="true" />
		<cfset variables.appManager = arguments.appManager />
	</cffunction>