1 /*
2 * Copyright 2006-2007 the original author or authors.
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17 package org.springframework.batch.item.file;
18
19 import org.springframework.batch.item.file.mapping.FieldSetMapper;
20 import org.springframework.batch.item.file.transform.LineTokenizer;
21
22
23 /**
24 * Interface for mapping lines (strings) to domain objects typically used to map lines read from a file to domain objects
25 * on a per line basis. Implementations of this interface perform the actual
26 * work of parsing a line without having to deal with how the line was
27 * obtained.
28 *
29 * @author Robert Kasanicky
30 * @param <T> type of the domain object
31 * @see FieldSetMapper
32 * @see LineTokenizer
33 * @since 2.0
34 */
35 public interface LineMapper<T> {
36
37 /**
38 * Implementations must implement this method to map the provided line to
39 * the parameter type T. The line number represents the number of lines
40 * into a file the current line resides.
41 *
42 * @param line to be mapped
43 * @param lineNumber of the current line
44 * @return mapped object of type T
45 * @throws Exception if error occured while parsing.
46 */
47 T mapLine(String line, int lineNumber) throws Exception;
48 }