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;
48
49 /***
50 * The InputAdapter is responsible for selecting a set of
51 * work for processing and pushing it into the Channel for
52 * processing..
53 *
54 * @author Pete McKinstry
55 * @copyright 2002, Robert Half Int'l., Inc. All rights reserved.
56 *
57 * @since 1.0
58 */
59 public interface InputAdapter extends Adapter {
60
61 /***
62 * Send a set of records requiring processing to the
63 * pipeline. The collection should contain objects of
64 * type Record.
65 *
66 * @param ch where input records should be sent.
67 * @return int
68 * @exception ProcessingException error occured selecting
69 * records.
70 *
71 * @since 1.0
72 */
73 public int push(Channel ch) throws ProcessingException;
74
75 /***
76 * set the error channel.
77 * <p/>
78 * This method can be used by input adapters in cases where they
79 * have parsing errors or other non-fatal record level errors
80 * when loading a batch of records.
81 * @param errorChannel
82 *
83 * @since 1.0
84 */
85 public void setErrorChannel(Channel errorChannel);
86
87 /***
88 * The concrete input adapter can use this method to add
89 * error records to the error channel while maintaining
90 * the correct audit entries for valid (returned from
91 * loadBatch() & pushed into the normal pipeline channel)
92 * & errors (added by calling addError() & pushed into
93 * the error channel.
94 * @param record
95 *
96 * @since 1.0
97 */
98 public void addToErrorChannel(Record record);
99
100 }
This page was automatically generated by Maven