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 import java.util.ArrayList;
50 import java.util.List;
51
52 /***
53 * Record implementation providing the std error handling.
54 * Just a convenience class.
55 *
56 * @author Pete McKinstry
57 * @copyright 2002, Robert Half Int'l., Inc. All rights reserved.
58 *
59 * @since 1.0
60 */
61 public abstract class AbstractRecord implements Record {
62
63 /***
64 * the default separator used between fields
65 */
66 public static final String DEFAULT_SEPARATOR = "|";
67
68 private ArrayList errors = new ArrayList();
69
70 /***
71 * default constructor
72 */
73 public AbstractRecord() {
74 super();
75 }
76
77 /***
78 * Is the Record valid. What isValid() really means, is up to
79 * the concrete record class. Normally, isValid() & isErrored()
80 * should return opposite values.
81 *
82 * @return boolean True/False
83 *
84 * @since 1.0
85 */
86 public boolean isValid() {
87 return errors.size() == 0;
88 }
89
90 /***
91 * Is the Record in an errored state. What isErrored()
92 * really means is up to the concrete record class. Normally
93 * isValid() and isErrored() should return opposite boolean
94 * values.
95 * <br/>
96 * If isErrored() returns true, the getErrors() method should
97 * return a List w/ size() > 1. If the error list is empty,
98 * isErrored should be false.
99 *
100 * @return boolean True/False
101 *
102 * @since 1.0
103 */
104 public boolean isErrored() {
105 return errors.size() > 0;
106 }
107
108 /***
109 * Return the list of errors attached to this record.
110 * Allows a cummulative process for attaching errors
111 * to the record where the first error in the list is
112 * the first error found during processing.
113 *
114 * @return List - the list of errors attached to this
115 * record.
116 *
117 * @since 1.0
118 */
119 public List getErrors() {
120 return this.errors;
121 }
122
123 /***
124 * Add error to this record.
125 *
126 * @param error msg
127 *
128 * @since 1.0
129 */
130 public void addError(Error error) {
131 errors.add(error);
132 }
133
134 }
This page was automatically generated by Maven