summaryrefslogtreecommitdiff
path: root/base/src/main/java/bjc/utils/parserutils/splitter/ConfigurableTokenSplitter.java
blob: 1ca0fc1d1df44f906ef1050a484b9f9a8d20f84a (plain)
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
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
package bjc.utils.parserutils.splitter;

import static bjc.utils.misc.PropertyDB.applyFormat;

import java.util.LinkedHashSet;
import java.util.Set;
import java.util.regex.Pattern;

import bjc.utils.funcdata.IList;

/**
 * Split a string into pieces around a regular expression, and offer an easy way
 * to configure the regular expression.
 *
 * @author EVE
 *
 */
public class ConfigurableTokenSplitter extends SimpleTokenSplitter {
	private final Set<String>	simpleDelimiters;
	private final Set<String>	multipleDelimiters;
	private final Set<String>	rRawDelimiters;

	/**
	 * Create a new token splitter with blank configuration.
	 *
	 * @param keepDelims
	 *                Whether or not to keep delimiters.
	 */
	public ConfigurableTokenSplitter(final boolean keepDelims) {
		super(null, keepDelims);

		/* Use linked hash-sets to keep items in insertion order. */
		simpleDelimiters = new LinkedHashSet<>();
		multipleDelimiters = new LinkedHashSet<>();
		rRawDelimiters = new LinkedHashSet<>();
	}

	private ConfigurableTokenSplitter(boolean keepDelims, Set<String> simpleDelimiters,
			Set<String> multipleDelimiters, Set<String> rRawDelimiters) {
		super(null, keepDelims);

		this.simpleDelimiters = simpleDelimiters;
		this.multipleDelimiters = multipleDelimiters;
		this.rRawDelimiters = rRawDelimiters;
	}

	/**
	 * Add a set of simple delimiters to this splitter.
	 *
	 * Simple delimiters match one occurrence of themselves as literals.
	 *
	 * @param simpleDelims
	 *                The simple delimiters to add.
	 */
	public void addSimpleDelimiters(final String... simpleDelims) {
		for (final String simpleDelim : simpleDelims) {
			simpleDelimiters.add(simpleDelim);
		}
	}

	/**
	 * Add a set of multiple delimiters to this splitter.
	 *
	 * Multiple delimiters match one or more occurrences of themselves as
	 * literals.
	 *
	 * @param multiDelims
	 *                The multiple delimiters to add.
	 */
	public void addMultiDelimiters(final String... multiDelims) {
		for (final String multiDelim : multiDelims) {
			multipleDelimiters.add(multiDelim);
		}
	}

	/**
	 * Add a set of raw delimiters to this splitter.
	 *
	 * Raw delimiters match one occurrence of themselves as regular
	 * expressions.
	 *
	 * @param rRawDelims
	 *                The raw delimiters to add.
	 */
	public void addRawDelimiters(final String... rRawDelims) {
		for (final String rRawDelim : rRawDelims) {
			rRawDelimiters.add(rRawDelim);
		}
	}

	/**
	 * Take the configuration and compile it into a regular expression to
	 * use when splitting.
	 */
	public void compile() {
		final StringBuilder rPattern = new StringBuilder();

		for (final String rRawDelimiter : rRawDelimiters) {
			rPattern.append(applyFormat("rawDelim", rRawDelimiter));
		}

		for (final String multipleDelimiter : multipleDelimiters) {
			rPattern.append(applyFormat("multipleDelim", multipleDelimiter));
		}

		for (final String simpleDelimiter : simpleDelimiters) {
			rPattern.append(applyFormat("simpleDelim", simpleDelimiter));
		}

		rPattern.deleteCharAt(rPattern.length() - 1);

		spliter = Pattern.compile(rPattern.toString());
	}

	@Override
	public IList<String> split(final String input) {
		if (spliter == null) throw new IllegalStateException("Must compile splitter before use");

		return super.split(input);
	}

	@Override
	public String toString() {
		final String fmt = "ConfigurableTokenSplitter [simpleDelimiters=%s, multipleDelimiters=%s,"
				+ " rRawDelimiters=%s, spliter=%s]";

		return String.format(fmt, simpleDelimiters, multipleDelimiters, rRawDelimiters, spliter);
	}

	/**
	 * Builder class for the configurable token splitter.
	 * 
	 * @author bjculkin
	 *
	 */
	public static class Builder {
		private ConfigurableTokenSplitter cts;

		/**
		 * Create a new splitter builder.
		 * 
		 * @param keepDelims
		 *                Whether or not to keep the delimited splitter.
		 */
		public Builder(boolean keepDelims) {
			cts = new ConfigurableTokenSplitter(keepDelims);
		}

		/**
		 * Add a set of simple delimiters.
		 * 
		 * @param strings
		 *                The simple delimiters to use.
		 * @return The builder, for chaining.
		 */
		public Builder simple(String... strings) {
			cts.addSimpleDelimiters(strings);

			return this;
		}

		/**
		 * Add a set of multiple delimiters.
		 * 
		 * @param strings
		 *                The multiple delimiters to use.
		 * @return The builder, for chaining.
		 */
		public Builder multiple(String... strings) {
			cts.addMultiDelimiters(strings);

			return this;
		}

		/**
		 * Add a set of raw delimiters.
		 * 
		 * @param strings
		 *                The raw delimiters to use.
		 * @return The builder, for chaining.
		 */
		public Builder raw(String... strings) {
			cts.addRawDelimiters(strings);

			return this;
		}

		/**
		 * Build the splitter.
		 * 
		 * @return The built splitter.
		 */
		public ConfigurableTokenSplitter build() {
			ConfigurableTokenSplitter ret = new ConfigurableTokenSplitter(cts.keepDelim,
					cts.simpleDelimiters, cts.multipleDelimiters, cts.rRawDelimiters);
			ret.compile();
			
			return ret;
		}
	}
}