com.github.mygreen.supercsv.annotation.constraint

注釈型 CsvEquals

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

セルの値が指定した値と等しいかどうか検証するためのアノテーションです。

全てのクラスタイプに指定可能です。

基本的な使い方

属性value()で比較対象の値を指定します。

• 値は複数指定可能で、その場合、何れかの値に一致すれば問題ありません。
• 数値や日時など書式を持つ場合は、その書式に沿った値を指定する必要があります。

 @CsvBean
 public class SampleCsv {
     
     @CsvColumn(number=1)
     @CsvEquals({"admin", "normal"})
     private String type;
     
     // 書式を指定している場合
     @CsvColumn(number=2)
     @CsvNumberForamt(pattern="#,##0")
     @CsvEquals({"-1,000", "1,000"})
     private Integer number;
     
     // getter/setterは省略
 }
 

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

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

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

 @CsvBean
 public class SampleCsv {
     
     @CsvColumn(number=1)
     @CsvEquals(provider=FileEqualedValueProvider.class)
     private Integer number;
     
     // setter/getterは省略
 }
 
 // プロバイダクラスの実装（ファイルから値を取得する）
 public class FileEqualedValueProvider implements EqualedValueProvider<Integer> {
     
     @Override
     public Collection<Integer> getEqualedValues(final FieldAccessor field) {
         
         String lines;
         try {
              lines = Files.readAllLines(
                      new File("equaled_value.txt").toPath(), Charset.forName("UTF-8"));
              
         } catch (IOException e) {
             throw new RuntimeException("fail reading the equaled value file.", e);
         }
         
         // 読み取った値をInteger型に変換します。
         return lines.stream()
             .map(l -> Integer.valueOf(l))
             .collect(Collectors.toList());
         
     }
 }
 

導入されたバージョン:

2.0

作成者:

T.TSUCHIE

任意要素のサマリー

任意要素

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

要素の詳細

value

public abstract String[] value

比較する値を指定します。

複数指定した場合は、何れかに一致すれば問題ありません。

ブール型、数値や日時型の場合は、アノテーションで指定した書式に沿った値を指定する必要があります。

戻り値:

比較対象の値。

デフォルト:

{}

provider

public abstract Class<? extends EqualedValueProvider>[] provider

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

戻り値:

EqualedValueProviderの実装クラス。

デフォルト:

{}

message

public abstract String message

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

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

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

• lineNumber : カラムの値に改行が含まれている場合を考慮した実際の行番号です。1から始まります。
• rowNumber : CSVの行番号です。1から始まります。
• columnNumber : CSVの列番号です。1から始まります。
• label : カラムの見出し名です。
• validatedValue : 実際のカラムの値です。
• equalsValues : アノテーションの属性value()をフィールドの型に変換した値です。Collectionの形式です。
• formatter : カラムの値に対数するフォーマッタです。TextPrinter.print(Object)でvalidatedValue, equalsValuesの値を文字列に変換します。

戻り値:

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

デフォルト:

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

cases

public abstract BuildCase[] cases

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

戻り値:

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

デフォルト:

{}

groups

public abstract Class<?>[] groups

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

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

戻り値:

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

デフォルト:

{}

order

public abstract int order

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

戻り値:

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

デフォルト:

0