View Javadoc
1 /* ====================================================================
2 * License:
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
6 * are met:
7 *
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 *
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in
13 * the documentation and/or other materials provided with the
14 * distribution.
15 *
16 * 3. The end-user documentation included with the redistribution,
17 * if any, must include the following acknowledgment:
18 * "This product includes software developed by
19 * Robert Half International (http://www.rhi.com/)."
20 * Alternately, this acknowledgment may appear in the software itself,
21 * if and wherever such third-party acknowledgments normally appear.
22 *
23 * 4. The names "Parc", "RHI", and "Robert Half International" must
24 * not be used to endorse or promote products derived from this
25 * software without prior written permission. For written
26 * permission, please contact pete.mckinstry@rhi.com.
27 *
28 * 5. Products derived from this software may not be called "PARC",
29 * nor may "PARC" appear in their name, without prior written
30 * permission of Robert Half International.
31 *
32 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
33 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
34 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
35 * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
36 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
37 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
38 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
39 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
40 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
41 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
42 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
43 * SUCH DAMAGE.
44 * ====================================================================
45 *
46 */
47 package com.rhi.architecture.parc.filter;
48
49 import com.rhi.architecture.parc.Event;
50 import com.rhi.architecture.parc.Monitor;
51 import com.rhi.architecture.parc.ProcessingException;
52
53 import java.util.Collection;
54
55 /***
56 * NotificationFilter.java
57 *
58 * @author <a href="mailto:pete.mckinstry@rhi.com">Pete McKinstry</a>
59 * @copyright 2002, Robert Half International. All rights reserved.
60 *
61 * @version 1.0
62 */
63 public abstract class NotificationFilter
64 extends AbstractFilter
65 implements Monitor {
66
67 /***
68 * Constructor for NotificationFilter.
69 */
70 public NotificationFilter() {
71 super();
72 }
73
74 /***
75 * @see java.lang.Runnable#run()
76 */
77 public void run() {
78 log().debug("TestFilter.run()");
79 getInbound().registerMonitor(this);
80 super.run();
81 }
82
83 /***
84 * Push a collection of records through the filter.
85 * <br />
86 * Details: The NotificationFilter processes records w/in
87 * a dependent loop. The exit criteria for the loop
88 * is the markForDeath() flag which should be set by
89 * the pipeline, _and_ an empty processing cycle. This
90 * allows the Strategy to flush the Pipeline w/o knowing
91 * much about the inner workings of the Filter. While
92 * this criteria is false, the Filter does this:
93 * (pseudo-code)
94 * <code>
95 * InboundChannel.pull();
96 * doWork() <abstract>
97 * OutboundChannel.push();
98 * </code>
99 * <p/>
100 * This method must be threadsafe as it is the
101 * fundamental multi-processing hook in the framework.
102 * @throws ProcessingException
103 * @since 1.0
104 */
105 public void process() throws ProcessingException {
106 int recordCount = 0;
107 long processingTime = 0;
108 while (true) {
109 Collection in = getInbound().pull(getMaxRecords());
110 int size = in.size();
111 if (size > 0) {
112 if (log().isDebugEnabled()) {
113 log().debug(
114 "filer::process() cycle detected for "
115 + "Filter: <"
116 + getName()
117 + ">, "
118 + "thread = "
119 + Thread.currentThread().getName());
120 }
121 recordCount += in.size();
122 long startTime = System.currentTimeMillis();
123 Collection out = doWork(in);
124 getOutbound().push(out);
125 long endTime = System.currentTimeMillis();
126 processingTime += (endTime - startTime);
127 }
128 else {
129 log().debug(
130 "filter::process() idle cycle for "
131 + "Filter: <"
132 + getName()
133 + ">, "
134 + "thread="
135 + Thread.currentThread().getName());
136 // Marked for death _&_ hit an idle cycle, quit.
137 if (isShutdown() == true) {
138 break;
139 }
140 // If not marked for death, wait for notification from the
141 // suppler that new records are available for processing.
142 try {
143 synchronized (this) {
144 wait();
145 }
146 }
147 catch (InterruptedException e) {
148 // ignore
149 }
150 } // else
151 } // while loop
152
153 if (stats().isInfoEnabled()) {
154 stats().info(
155 "Filter <"
156 + getName()
157 + "> processed "
158 + recordCount
159 + " records in "
160 + processingTime
161 + " milliseconds");
162 }
163 return;
164 }
165
166 /***
167 * Simple implementation of Monitor interface based on Thread
168 * wait/notify mechanism.
169 * @param e
170 * @see com.rhi.architecture.parc.Monitor#notify(Event)
171 */
172 public void notify(Event e) {
173 synchronized (this) {
174 notifyAll();
175 }
176 }
177
178 }
This page was automatically generated by Maven