FilterCommand

Package: MachII.framework.commands
Inherits from: framework.Command
An Command for processing an EventFilter.

<!--- License: Copyright 2008 GreatBizTools, LLC Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. Copyright: GreatBizTools, LLC Author: Ben Edwards (ben@ben-edwards.com) $Id: FilterCommand.cfc 625 2008-01-29 21:45:06Z peterfarrell $ Created version: 1.0.0 Updated version: 1.5.0 Notes: --->

Method Summary
public FilterCommand init(EventFilter filter, [struct paramArgs="#StructNew()#"])

Used by the framework for initialization.

public boolean execute(Event event, EventContext eventContext)

Executes the command.

private EventFilter getFilter()
private struct getParamArgs()
private void setFilter(EventFilter filter)
private void setParamArgs(struct paramArgs)
Methods inherited from framework.Command:   setParameters , getParameter , setLog , setParameter , getLog
Method Detail
execute

public boolean execute( Event event, EventContext eventContext )

Executes the command.

Parameters:
Event event
EventContext eventContext

Code: 

	<cffunction name="execute" access="public" returntype="boolean"
		hint="Executes the command.">
		<cfargument name="event" type="MachII.framework.Event" required="true" />
		<cfargument name="eventContext" type="MachII.framework.EventContext" required="true" />
		
		<cfset var continue = false />
		<cfset var log = getFilter().getLog() />
		
		<cfif log.isDebugEnabled()>
			<cfset log.debug("Filter '#getFilter().getComponentNameForLogging()#' beginning execution.") />
		</cfif>
		
		<cfinvoke component="#getFilter()#" method="filterEvent" returnVariable="continue">
			<cfinvokeargument name="event" value="#arguments.event#" />
			<cfinvokeargument name="eventContext" value="#arguments.eventContext#" />
			<cfinvokeargument name="paramArgs" value="#getParamArgs()#" />
		</cfinvoke>

		<cfif log.isWarnEnabled() and NOT continue>
			<cfset log.warn("Filter '#getFilter().getComponentNameForLogging()# has changed the flow of this event.") />
		</cfif>
		
		<cfreturn continue />
	</cffunction>

getFilter

private EventFilter getFilter( )

Parameters:

Code: 

	<cffunction name="getFilter" access="private" returntype="MachII.framework.EventFilter" output="false">
		<cfreturn variables.filter />
	</cffunction>

getParamArgs

private struct getParamArgs( )

Parameters:

Code: 

	<cffunction name="getParamArgs" access="private" returntype="struct" output="false">
		<cfreturn variables.paramArgs />
	</cffunction>

init

public FilterCommand init( EventFilter filter, [struct paramArgs="#StructNew()#"] )

Used by the framework for initialization.

Parameters:
EventFilter filter
[struct paramArgs="#StructNew()#"]

Code: 

	<cffunction name="init" access="public" returntype="FilterCommand" output="false"
		hint="Used by the framework for initialization.">
		<cfargument name="filter" type="MachII.framework.EventFilter" required="true" />
		<cfargument name="paramArgs" type="struct" required="false" default="#StructNew()#" />
		
		<cfset setFilter(arguments.filter) />
		<cfset setParamArgs(arguments.paramArgs) />
		
		<cfreturn this />
	</cffunction>

setFilter

private void setFilter( EventFilter filter )

Parameters:
EventFilter filter

Code: 

	<cffunction name="setFilter" access="private" returntype="void" output="false">
		<cfargument name="filter" type="MachII.framework.EventFilter" required="true" />
		<cfset variables.filter = arguments.filter />
	</cffunction>

setParamArgs

private void setParamArgs( struct paramArgs )

Parameters:
struct paramArgs

Code: 

	<cffunction name="setParamArgs" access="private" returntype="void" output="false">
		<cfargument name="paramArgs" type="struct" required="true" />
		<cfset variables.paramArgs = arguments.paramArgs />
	</cffunction>