summaryrefslogtreecommitdiff
path: root/src/main/java/bjc/inflexion/nouns/CategoricalNounInflection.java
blob: 8f1fde9f9bb4f705c1ae7d23a7f0e0d79f533b0b (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
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
/*
 * (C) Copyright 2017 Benjamin Culkin.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package bjc.inflexion.nouns;

/**
 * Implementation of {@link NounInflection} for nouns matched by a regular
 * expression.
 *
 * @author EVE
 *
 */
public class CategoricalNounInflection implements NounInflection {
	/* The toString format. */
	private static final String TOSTRING_FMT
			= "CategoricalNounInflection [singular=%s, modernPlural=%s, classicalPlural=%s]";

	/* The affix for a singular noun. */
	private final InflectionAffix singular;

	/* The affix for a modern plural. */
	private final InflectionAffix modernPlural;
	/* The affix for a classical plural. */
	private final InflectionAffix classicalPlural;

	/**
	 * Create a new categorical inflection.
	 *
	 * @param singlar
	 *                       The affix for the singular form.
	 *
	 * @param modrnPlural
	 *                       The affix for the modern plural.
	 *
	 * @param classiclPlural
	 *                       The affix for the classical plural.
	 */
	public CategoricalNounInflection(final InflectionAffix singlar,
			final InflectionAffix modrnPlural, final InflectionAffix classiclPlural) {
		if (singlar == null) {
			throw new NullPointerException("Singular form must not be null");
		} else if (modrnPlural == null && classiclPlural == null) {
			throw new NullPointerException(
					"One of modern/classical plural forms must not be null");
		}

		singular = singlar;
		modernPlural = modrnPlural;
		classicalPlural = classiclPlural;
	}

	@Override
	public boolean matches(final String noun) {
		if (singular.hasAffix(noun))
			return true;
		else if (modernPlural != null && modernPlural.hasAffix(noun))
			return true;
		else if (classicalPlural != null && classicalPlural.hasAffix(noun))
			return true;
		else
			return false;
	}

	@Override
	public boolean isSingular(final String noun) {
		if (singular.hasAffix(noun)) {
			return true;
		} else if (matchesPlural(noun)) {
			return false;
		} else {
			final String msg
					= String.format("Noun '%s' doesn't belong to this inflection", noun);

			throw new InflectionException(msg);
		}
	}

	@Override
	public boolean isPlural(final String noun) {
		if (singular.hasAffix(noun)) {
			return false;
		} else if (matchesPlural(noun)) {
			return true;
		} else {
			final String msg
					= String.format("Noun '%s' doesn't belong to this inflection", noun);

			throw new InflectionException(msg);
		}
	}

	@Override
	public String singularize(final String plural) {
		if (singular.hasAffix(plural)) {
			return plural;
		} else if (modernPlural != null && modernPlural.hasAffix(plural)) {
			return singular.affix(modernPlural.deaffix(plural));
		} else if (classicalPlural != null && classicalPlural.hasAffix(plural)) {
			return singular.affix(classicalPlural.deaffix(plural));
		} else {
			final String msg = String
					.format("Noun '%s' doesn't belong to this (%s) inflection", plural, this);

			throw new InflectionException(msg);
		}
	}

	@Override
	public String pluralize(final String singlar) {
		if (singular.hasAffix(singlar)) {
			if (modernPlural == null)
				return classicalPlural.affix(singular.deaffix(singlar));

			return modernPlural.affix(singular.deaffix(singlar));
		} else if (matchesPlural(singlar)) {
			return singlar;
		} else {
			final String msg = String
					.format("Noun '%s' doesn't belong to this (%s) inflection", singlar, this);

			throw new InflectionException(msg);
		}
	}

	/* Check if a string matches a plural form. */
	private boolean matchesPlural(final String noun) {
		final boolean hasModernPlural
				= modernPlural != null && modernPlural.hasAffix(noun);

		return hasModernPlural
				|| classicalPlural != null && classicalPlural.hasAffix(noun);
	}

	@Override
	public String toString() {
		return String.format(TOSTRING_FMT, singular, modernPlural, classicalPlural);
	}

	@Override
	public int hashCode() {
		final int prime = 31;
		int result = 1;

		result = prime * result
				+ (classicalPlural == null ? 0 : classicalPlural.hashCode());
		result = prime * result + (modernPlural == null ? 0 : modernPlural.hashCode());

		return result;
	}

	@Override
	public boolean equals(final Object obj) {
		if (this == obj)
			return true;

		if (obj == null)
			return false;

		if (!(obj instanceof CategoricalNounInflection))
			return false;

		final CategoricalNounInflection other = (CategoricalNounInflection) obj;

		if (classicalPlural == null) {
			if (other.classicalPlural != null)
				return false;
		} else if (!classicalPlural.equals(other.classicalPlural))
			return false;

		if (modernPlural == null) {
			if (other.modernPlural != null)
				return false;
		} else if (!modernPlural.equals(other.modernPlural))
			return false;

		return true;
	}

	@Override
	public String pluralizeModern(final String singlar) {
		if (modernPlural == null)
			return pluralizeClassical(singlar);

		String actSinglar = singlar;

		if (isPlural(singlar)) {
			actSinglar = singularize(singlar);
		}

		return modernPlural.affix(singular.deaffix(actSinglar));
	}

	@Override
	public String pluralizeClassical(final String singlar) {
		if (classicalPlural == null)
			return pluralizeModern(singlar);

		String actSinglar = singlar;

		if (isPlural(singlar)) {
			actSinglar = singularize(singlar);
		}

		return classicalPlural.affix(singular.deaffix(actSinglar));
	}
}