com.github.mygreen.supercsv.annotation.conversion

注釈型 CsvWordReplace

@Target(value={FIELD,ANNOTATION_TYPE})
 @Retention(value=RUNTIME)
 @Documented
 @Repeatable(value=CsvWordReplace.List.class)
 @CsvConversion(value={})
public @interface CsvWordReplace

語彙に一致した一部の文字列を置換するためのアノテーションです。

基本的な使い方

• 属性words()で置換前の対象となる語彙を指定します。
  置換後の値をreplacements()で指定します。
• 置換前と置換後の値は配列で複数指定で、指定のインデックスが同じものが対応する値となります。
  属性words()とreplacements()の配列のサイズが異なる場合は、エラーとなります。
• 一度置換された値は、再度置換対象となりません。
  循環参照のような定義をしていても、置換対象となりません。
• 置換対象の文字は、文字長が長いものが優先されます。
  文字長が同じ場合は、辞書順となります。

 @CsvBean
 public class SampleCsv {
     
     // 下さい -> ください
     // 御願い -> お願い
     @CsvColumn(number=1)
     @CsvWordReplace(words={"下さい", "御願い"}, replacements={"ください", "お願い"})
     private String comment;
     
     // getter/setterは省略
 }
 

DBやファイルなどのリソースから取得する場合

語彙をDBやファイルなどの別リソースから取得する場合は、属性provider()にて、 プロバイダReplacedWordProviderの実装クラスを指定します。

Spring Frameworkと連携している場合は、プロバイダクラスをSpringBeanとして登録しておくことでインジェクションできます。

 @CsvBean
 public class SampleCsv {
     
     @CsvColumn(number=1)
     @CsvWordReplace(provider=FileReplacedWordProvider.class)
     private String comment;
     
     // setter/getterは省略
 }
 
 // プロバイダクラスの実装（ファイルから語彙を取得する）
 public class FileReplacedWordProvider implements ReplacedWordProvider {
     
     @Override
     public Collection<Word> getReplacedWords(final FieldAccessor field) {
         
         // ファイルから語彙の定義を読み込む
         List<String> lines;
         try {
              
              lines = Files.readAllLines(
                      new File("replaced_word.txt").toPath(), Charset.forName("UTF-8"));
              
         } catch (IOException e) {
             throw new RuntimeException("fail reading the replaced words file.", e);
         }
         
         // 読み込んだ各行の値を分割して、ReplacedWordProvider.Word クラスに変換する。
         return lines.stream()
             .map(l -> l.split(","))
             .map(s -> new Word(s[0], s[1]))
             .collect(Collectors.toLit());
         
     }
 }
 

導入されたバージョン:

2.0

作成者:

T.TSUCHIE

任意要素のサマリー

任意要素

修飾子とタイプ	任意要素と説明
BuildCase[]	cases 適用するケースを指定します。
Class<?>[]	groups グループのクラスを指定します。
int	order アノテーションの処理順序の定義。
Class<? extends ReplacedWordProvider>[]	provider 語彙を取得するプロバイダクラスを指定します。
String[]	replacements 置換後の値の一覧
String[]	words 置換対象の語彙の一覧

要素の詳細

words

public abstract String[] words

置換対象の語彙の一覧

戻り値:

複数指定する場合、replacements()と同じ個数を設定します。

デフォルト:

{}

replacements

public abstract String[] replacements

置換後の値の一覧

戻り値:

複数指定する場合、words()と同じ個数を設定します。

デフォルト:

{}

provider

public abstract Class<? extends ReplacedWordProvider>[] provider

語彙を取得するプロバイダクラスを指定します。

戻り値:

ReplacedWordProviderの実装クラスを設定します。

デフォルト:

{}

cases

public abstract BuildCase[] cases

適用するケースを指定します。

戻り値:

何も指定しない場合は全てのケースに適用されます。

デフォルト:

{}

groups

public abstract Class<?>[] groups

グループのクラスを指定します。

処理ごとに適用するアノテーションを切り替えたい場合に指定します。

戻り値:

指定しない場合は、DefaultGroupが適用され全ての処理に適用されます。

デフォルト:

{}

order

public abstract int order

アノテーションの処理順序の定義。

戻り値:

値が大きいほど後に実行されます。 値が同じ場合は、アノテーションのクラス名の昇順になります。

デフォルト:

0