AbstractFilter

Package: MachII.logging.filters
A logging filter. This is abstract and must be extend by a concrete filter implementation.

<!--- 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: Peter J. Farrell (peter@mach-ii.com) $Id: AbstractFilter.cfc 625 2008-01-29 21:45:06Z peterfarrell $ Created version: 1.6.0 Updated version: 1.6.0 Notes: --->

Method Summary
public AbstractFilter init()

Initalizes the filter.

public boolean decide(struct logMessageElements)

Decides whether or not the log message elements meet the filter criteria and should be logged.

private void loadFilterCriteria()

Loads filter criteria.

Method Detail
decide

public boolean decide( struct logMessageElements )

Decides whether or not the log message elements meet the filter criteria and should be logged.

Parameters:
struct logMessageElements

Code: 

	<cffunction name="decide" access="public" returntype="boolean" output="false"
		hint="Decides whether or not the log message elements meet the filter criteria and should be logged.">
		<cfargument name="logMessageElements" type="struct" required="true" />
		<cfabort showerror="This method is abstract and must be overrided." />
	</cffunction>

init

public AbstractFilter init( )

Initalizes the filter.

Parameters:

Code: 

	<cffunction name="init" access="public" returntype="AbstractFilter" output="false"
		hint="Initalizes the filter.">
		<cfabort showerror="This method is abstract and must be overrided." />
	</cffunction>

loadFilterCriteria

private void loadFilterCriteria( )

Loads filter criteria.

Parameters:

Code: 

	<cffunction name="loadFilterCriteria" access="private" returntype="void" output="false"
		hint="Loads filter criteria.">
		<cfabort showerror="This method is abstract and must be overrided." />
	</cffunction>