com.github.mygreen.supercsv.annotation.constraint

注釈型 CsvWordForbid

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

禁止語彙を含まないかどうか検証するためのアノテーションです。

文字列型に指定可能です。

基本的な使い方

属性value()で語彙を指定します。

 @CsvBean
 public class SampleCsv {
     
     @CsvColumn(number=1)
     @CsvWordForbid({"馬鹿", "あほ"})
     private String comment;
     
     // getter/setterは省略
 }
 

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

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

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

 @CsvBean
 public class SampleCsv {
     
     @CsvColumn(number=1)
     @CsvWordForbid(provider=FileForbiddenWordProvider.class)
     private String comment;
     
     // setter/getterは省略
 }
 
 // プロバイダクラスの実装（ファイルから語彙を取得する）
 public class FileForbiddenWordProvider implements ForbiddenWordProvider {
     
     @Override
     public Collection<String> getForbiddenWords(final FieldAccessor field) {
         
         try {
              return Files.readAllLines(
                      new File("forbidden_word.txt").toPath(), Charset.forName("UTF-8"));
              
         } catch (IOException e) {
             throw new RuntimeException("fail reading the forbidden words file.", e);
         }
         
     }
 }
 

導入されたバージョン:

2.0

作成者:

T.TSUCHIE

任意要素のサマリー

任意要素

修飾子とタイプ	任意要素と説明
BuildCase[]	cases 適用するケースを指定します。
Class<?>[]	groups グループのクラスを指定します。
String	message エラー時のメッセージを指定します。
int	order アノテーションの処理順序の定義。
Class<? extends ForbiddenWordProvider>[]	provider 禁止語彙を取得するプロバイダクラスを指定します。
String[]	value 禁止語彙を指定します。

要素の詳細

value

public abstract String[] value

禁止語彙を指定します。

DBやファイルなどから語彙を取得する場合は、provider()を指定します。

戻り値:

複数指定可能です。

デフォルト:

{}

provider

public abstract Class<? extends ForbiddenWordProvider>[] provider

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

戻り値:

ForbiddenWordProviderの実装クラスを指定します。

デフォルト:

{}

message

public abstract String message

エラー時のメッセージを指定します。

{key}の書式の場合、プロパティファイルから取得した値を指定できます。

使用可能なメッセージ中の変数は下記の通りです。

• lineNumber : カラムの値に改行が含まれている場合を考慮した実際の行番号です。1から始まります。
• rowNumber : CSVの行番号です。1から始まります。
• columnNumber : CSVの列番号です。1から始まります。
• label : カラムの見出し名です。
• validatedValue : 実際のカラムの値です。
• words : カラムの値の中に含まれている禁止語彙です。Collectionです。

戻り値:

省略した場合は、適用されたCellProcessorに基づいたメッセージが出力されます。

デフォルト:

"{com.github.mygreen.supercsv.annotation.constraint.CsvWordForbid.message}"

cases

public abstract BuildCase[] cases

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

戻り値:

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

デフォルト:

{}

groups

public abstract Class<?>[] groups

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

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

戻り値:

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

デフォルト:

{}

order

public abstract int order

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

戻り値:

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

デフォルト:

0