1 /*
2 * Copyright 2012-2025 CodeLibs Project and the Others.
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,
13 * either express or implied. See the License for the specific language
14 * governing permissions and limitations under the License.
15 */
16 package org.codelibs.fess.dict.stemmeroverride;
17
18 import java.util.Date;
19
20 import org.apache.logging.log4j.LogManager;
21 import org.apache.logging.log4j.Logger;
22 import org.codelibs.fess.dict.DictionaryCreator;
23 import org.codelibs.fess.dict.DictionaryFile;
24 import org.codelibs.fess.dict.DictionaryItem;
25
26 import jakarta.annotation.PostConstruct;
27
28 /**
29 * A dictionary creator for stemmer override files.
30 * This class is responsible for creating {@link StemmerOverrideFile} instances
31 * from files that match the pattern "stemmer_override.*\\.txt".
32 */
33 public class StemmerOverrideCreator extends DictionaryCreator {
34 private static final Logger logger = LogManager.getLogger(StemmerOverrideCreator.class);
35
36 /**
37 * Constructs a new creator for stemmer override dictionaries.
38 * It sets the file pattern to match files starting with "stemmer_override"
39 * and ending with ".txt".
40 */
41 public StemmerOverrideCreator() {
42 super("stemmer_override.*\\.txt");
43 }
44
45 /**
46 * Registers this creator with the dictionary manager upon initialization.
47 * This method is annotated with {@link PostConstruct} to be executed after
48 * dependency injection is complete.
49 */
50 @PostConstruct
51 public void register() {
52 if (logger.isInfoEnabled()) {
53 logger.info("Loaded {}", this.getClass().getSimpleName());
54 }
55 dictionaryManager.addCreator(this);
56 }
57
58 /**
59 * Creates a new {@link StemmerOverrideFile} instance.
60 *
61 * @param id The unique identifier for the dictionary file.
62 * @param path The file path of the dictionary.
63 * @param timestamp The last modified timestamp of the file.
64 * @return A new {@link StemmerOverrideFile} associated with the dictionary manager.
65 */
66 @Override
67 protected DictionaryFile<? extends DictionaryItem> newDictionaryFile(final String id, final String path, final Date timestamp) {
68 return new StemmerOverrideFile(id, path, timestamp).manager(dictionaryManager);
69 }
70
71 }