aboutsummaryrefslogtreecommitdiff
path: root/project/JavaCommon/src/com/modulus/dataread/expressions/StatementFormatter.java
blob: 80700345d9ce7b5a7b4d7d77b292e4e9fd3c619f (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
package com.modulus.dataread.expressions;

import java.io.Serializable;

/**
 * Classes that implement this interface are used
 * to format string before they become a part of
 * a statement.
 * 
 * These classes are the classes responsible for making
 * sure the headers are formatted in such a way that they might
 * be easy to parse.
 * 
 * @author jrahm
 */
public interface StatementFormatter extends Serializable{
	/**
	 * Given the String <code>header</code> as a header of a statement,
	 * format it so it can easily be parsed by custom parsing
	 * techniques.
	 * 
	 * @param header the header to parse
	 * @return a formatted version of the header.
	 */
	String formatHeader(String header);
}