1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19
20
21 package org.apache.commons.pipeline.stage;
22
23 import org.apache.commons.pipeline.StageException;
24 import org.apache.commons.pipeline.event.KeyAvailableEvent;
25 import org.apache.commons.pipeline.util.KeyFactory;
26
27 /**
28 *
29 *
30 */
31 public class RaiseKeyAvailableEventStage extends BaseStage {
32
33 /** Creates a new instance of RaiseKeyAvailableEventStage */
34 public RaiseKeyAvailableEventStage() {
35 }
36
37 /**
38 * This implementation of process() simply generates a key for the
39 * processed object and raises a KeyAvailableEvent with the generated
40 * key, then emits the processed object unchanged.
41 */
42 public void process(Object obj) throws StageException {
43 this.context.raise(new KeyAvailableEvent<Object>(this, keyFactory.generateKey(obj)));
44 this.emit(obj);
45 }
46
47 /**
48 * Holds value of property keyFactory.
49 */
50 private KeyFactory<Object,Object> keyFactory;
51
52 /**
53 * Returns the KeyFactory used to create keys for the objects processed
54 * by this stage.
55 */
56 public KeyFactory<Object,Object> getKeyFactory() {
57 return keyFactory;
58 }
59
60 /**
61 * Sets the KeyFactory used to create keys for the objects processed
62 * by this stage.
63 */
64 public void setKeyFactory(KeyFactory<Object,Object> keyFactory) {
65 this.keyFactory = keyFactory;
66 }
67 }